Supported telemetry types
The HAProxy CXDOT Collector integration supports these telemetry types:Prerequisites
The HAProxy CXDOT Collector integration has the following prerequisites:- An HAProxy stats page that exposes the CSV export.
- Network access from the CXDOT Collector to the HAProxy stats page.
Configure
The HAProxy integration is enabled by default. You can configure targets either by annotating pods in your Kubernetes cluster or by listing static endpoints in your Helm values. To configure the HAProxy CXDOT Collector integration, follow these steps:-
Configure HAProxy to expose statistics at
/statson port8404. For example, add the following frontend to the HAProxy configuration: -
To collect from HAProxy pods in Kubernetes, add a CXDOT integration annotation to the
pod template. The annotation key must end with the container name. For example, add
the following annotation to your HAProxy workload:
The Collector replaces
${target.host}with the pod IP address and${target.port.stats}with the container port namedstats. The Collector also discovers HAProxy pods that carry theapp.kubernetes.io/name: haproxylabel and expose the stats page on port8404. A CXDOT integration annotation takes precedence over the label for its container. To stop collecting from a container, sethaproxy: {enabled: false}in the annotation. For more information, see autodiscovery. -
Optional: To collect from HAProxy servers outside your Kubernetes cluster, configure
static targets. For example, add the following to the
values.yamlfor your Helm chart:When you configure static targets, this integration instance collects from exactly those targets instead of discovered targets. -
Optional: Configure a second integration instance to collect from both annotated
pods and static targets. For example, add the following to the
values.yamlfor your Helm chart:Thehaproxy/edgekey defines a named instance for the static targets. The barehaproxykey continues to discover pods.
Validate
To validate the HAProxy CXDOT Collector integration, follow these steps:-
In Metrics Explorer, run the following query:
Confirm that the query returns one time series for each stats URL you configured, with the URL in the
cxdot.integration.targetattribute, and that each reachable URL reports1. -
In Metrics Explorer, run the following query:
Confirm that the query returns the expected time series for each target.
Configuration reference
Configure one HAProxy integration instance with the following settings. In Helm values, place these settings undercollection.cxdot.integrations.haproxy. In a Collector configuration file,
place them under cxdot.integrations.haproxy.
Optional settings
-
enabledType:boolean. Optional. Default:true. Whether to enable this HAProxy integration instance. If true, the Collector collects metrics from HAProxy targets. If false, it doesn’t run this integration instance. -
endpointsType:array of object. Optional. Default:[]. HAProxy stats listeners. For ahost:portvalue, the Collector requestshttp://<host>:<port>/stats; for a full HTTP or HTTPS URL, it requests the URL as written. Either way it reads the CSV output. -
endpoints[].endpointType:string. Required. HAProxy statistics listener ashost:port. The Collector requests/statsover HTTP and reads its CSV output. -
collection_intervalType:duration. Optional. Default:10s. How often the Collector requests statistics from each HAProxy target. -
timeoutType:duration. Optional. Default:10s. Maximum time the Collector waits for an HAProxy statistics request to complete. -
disable_keep_alivesType:boolean. Optional. Default:true. Whether to close the connection after each statistics request. If true, the Collector closes the connection so that an idle connection doesn’t increasehaproxy.sessions.count. If false, the Collector keeps the connection open for reuse. Annotation-discovered endpoints instead take connection persistence from the annotation’spersist_connections,tls_use_host_header,headers, andextra_headersfields. -
tlsType:object. Optional. Transport layer security (TLS) settings for HTTPS targets. Certificate verification is enabled unlessinsecure_skip_verifyis true. These settings don’t apply to HTTP targets. Discovery annotations can provide target-specific TLS settings. -
tls.ca_fileType:string. Optional. Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. (optional) -
tls.ca_pemType:string. Optional. In memory PEM encoded cert. (optional) -
tls.cert_fileType:string. Optional. Path to the TLS cert to use for TLS required connections. (optional) -
tls.cert_pemType:string. Optional. In memory PEM encoded TLS cert to use for TLS required connections. (optional) -
tls.cipher_suitesType:array of string. Optional. CipherSuites is a list of TLS cipher suites that the TLS transport can use. If left blank, a safe default list is used. See https://go.dev/src/crypto/tls/cipher_suites.go for a list of supported cipher suites. -
tls.curve_preferencesType:array of string. Optional. contains the elliptic curves that will be used in an ECDHE handshake, in preference order Defaults to empty list and “crypto/tls” defaults are used, internally. -
tls.include_system_ca_certs_poolType:boolean. Optional. If true, load system CA certificates pool in addition to the certificates configured in this struct. -
tls.insecureType:boolean. Optional. In gRPC and HTTP when set to true, this is used to disable the client transport security. See https://godoc.org/google.golang.org/grpc#WithInsecure for gRPC. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional, default false) -
tls.insecure_skip_verifyType:boolean. Optional. InsecureSkipVerify will enable TLS but not verify the certificate. -
tls.key_fileType:string. Optional. Path to the TLS key to use for TLS required connections. (optional) -
tls.key_pemType:string. Optional. In memory PEM encoded TLS key to use for TLS required connections. (optional) -
tls.max_versionType:string. Optional. MaxVersion sets the maximum TLS version that is acceptable. If not set, refer to crypto/tls for defaults. (optional) -
tls.min_versionType:string. Optional. MinVersion sets the minimum TLS version that is acceptable. If not set, TLS 1.2 will be used. (optional) -
tls.reload_intervalType:duration. Optional. ReloadInterval specifies the duration after which the certificate will be reloaded If not set, it will never be reloaded (optional) -
tls.server_name_overrideType:string. Optional. ServerName requested by client for virtual hosting. This sets the ServerName in the TLSConfig. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional) -
tls.tpmType:object. Optional. Trusted platform module configuration -
tls.tpm.authType:string. Optional. Authorization value for the trusted platform module key. -
tls.tpm.enabledType:boolean. Optional. Whether to use a trusted platform module for the TLS private key. If true, the Collector loads the key from the configured device or socket. If false, the Collector uses the configured key file or in-memory key. -
tls.tpm.owner_authType:string. Optional. Owner authorization value for the trusted platform module. -
tls.tpm.pathType:string. Optional. The path to the TPM device or Unix domain socket. For instance /dev/tpm0 or /dev/tpmrm0.