Supported telemetry types
The HTTP Check CXDOT Collector integration supports these telemetry types:Prerequisites
The HTTP Check CXDOT Collector integration has the following prerequisites:- Make each URL you want to monitor reachable from the CXDOT Collector.
Configure
The HTTP Check 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 integration, follow these steps:-
To monitor a URL served by a pod in Kubernetes, such as its readiness endpoint, 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 workload:
The Collector replaces
${target.host}with the pod IP address and${target.port.http}with the container port namedhttp. -
Optional: To monitor URLs that pods in your cluster don’t serve, such as an API
outside your Kubernetes cluster, configure static targets. For example, add the
following to the
values.yamlfile for your CXDOT Collector Helm chart:The integration instance requests only the listed URLs and doesn’t discover annotated targets. In Kubernetes mode, the cluster Collector monitors static targets. For more information, see architecture. -
Optional: Name a static target. The Collector adds the name to every time series
from the target as the
cxdot.integration.target.nameattribute. For example, add the following to thevalues.yamlfile for your CXDOT Collector Helm chart:A target found from a Datadoghttp_checkannotation takes the name from the instance’snamesetting. -
Optional: Trust a private certificate authority for static HTTPS targets. Mount
the authority’s certificate with the chart’s
clusterCollector.extraVolumesandclusterCollector.extraVolumeMountsvalues, then settls.ca_fileto the mounted path. For example, add the following to thevalues.yamlfile for your CXDOT Collector Helm chart:Thetlssettings apply to every static target. -
Optional: Configure separate integration instances to monitor both annotated pods and
static targets. For example, add the following to the
values.yamlfile for your CXDOT Collector Helm chart:Thehttp_check/externalkey defines a named instance for the static targets. Configuring a named instance suppresses the implicit default instance, so the emptyhttp_check: {}entry is required to keep discovering annotated pods. -
Optional: Disable the integration to stop monitoring annotated targets. For
example, add the following to the
values.yamlfile for your CXDOT Collector Helm chart:
Validate
To validate the HTTP Check CXDOT Collector integration, follow these steps:-
In the Live Telemetry Analyzer, add the following filters:
__name__=cxdot.integration.target.healthcxdot.integration.name=http_check
cxdot.integration.targetattribute. -
In Metrics Explorer, run the following query:
Confirm that each reachable URL reports
1and each unreachable URL reports0. -
In Metrics Explorer, run the following query:
Confirm that the query returns the response time in milliseconds for each reachable URL.
Troubleshooting
-
A URL reports
0forcxdot.integration.target.health: In Metrics Explorer, run the following query to group recent failed checks by URL and failure class:Theerror.messageattribute identifies whether the request timed out, failed DNS lookup, was refused, failed TLS negotiation, or failed for another reason. -
A URL reports
0forcxdot.integration.target.healthbut has nohttpcheck.errorfailures: The response arrived but didn’t meet the endpoint’s conditions. Checkhttpcheck.statusfor a status code thatexpected_statusdoesn’t accept. Whenexpected_statusis unset, a status code of 400 or higher fails. To find failedvalidations, run the following query:
Configuration reference
Configure one HTTP Check integration instance with the following settings. In Helm values, place these settings undercollection.cxdot.integrations.http_check. In a Collector configuration
file, place them under cxdot.integrations.http_check.
Optional settings
-
enabledType:boolean. Optional. Default:true. Whether to enable this HTTP Check integration instance. If true, the Collector monitors the configured URLs. If false, it doesn’t run this integration instance. -
endpointsType:array of object. Optional. Default:[]. URLs to monitor. The Collector requests each entry on its own schedule and reports it as a separate target. -
endpoints[].nameType:string. Optional. Minimum length:1. Name for this URL, added to every time series from it as thecxdot.integration.target.nameattribute. For example,admin. A target found from a Datadoghttp_checkannotation takes the instance’sname, spelled as Datadog’sinstancetag spells it. -
endpoints[].endpointType:string. Required. URL to request, including thehttporhttpsscheme. For example,https://api.example.com/healthz. An HTTPS URL also reports the number of seconds until its server certificate expires. -
endpoints[].methodType:string. Optional. Default:GET. HTTP method for the request. -
endpoints[].headersType:object. Optional. Default:{}. Additional request headers as name-value pairs. Set theHostheader to request a virtual host by its network address. -
endpoints[].proxy_urlType:string. Optional. Proxy URL for this endpoint, for examplehttp://proxy.example.com:8080. When unset, the Collector uses theHTTP_PROXY,HTTPS_PROXY, andNO_PROXYenvironment variables. -
endpoints[].usernameType:string. Optional. Username for HTTP basic authentication to this endpoint. Whenusernameorpasswordis set, the credentials replace anyAuthorizationheader inheaders. -
endpoints[].passwordType:string. Optional. Password for HTTP basic authentication to this endpoint. The Collector masks this value in diagnostic output, logs, and errors. -
endpoints[].expected_statusType:regex or integer. Optional. Go regular expression for the response status codes that count as healthy, matched against the whole three-digit code. For example,403accepts only a 403, and[23]\d\daccepts any 2xx or 3xx response. When unset, a status code lower than 400 is healthy. -
endpoints[].validationsType:array of object. Optional. Default:[]. Conditions the response body must meet. The endpoint is healthy only when the response meets every condition, and a condition that looks for content fails on an empty body. An entry can set several conditions. -
endpoints[].validations[].containsType:string. Optional. Minimum length:1. Text the response body must contain. -
endpoints[].validations[].not_containsType:string. Optional. Minimum length:1. Text the response body must not contain. -
endpoints[].validations[].regexType:regex. Optional. Minimum length:1. Go regular expression the response body must match somewhere. For example,"status":\s*"ok". -
endpoints[].validations[].not_regexType:regex. Optional. Minimum length:1. Go regular expression the response body must not match anywhere. -
endpoints[].validations[].json_pathType:string. Optional. Minimum length:1. Path to a value that must exist in a JSON response body, in GJSON path syntax. For example,checks.database.status. -
endpoints[].validations[].equalsType:string. Optional. Minimum length:1. Text the value atjson_pathmust equal. -
endpoints[].validations[].min_sizeType:integer. Optional. Minimum:0. Smallest acceptable response body size, in bytes. -
endpoints[].validations[].max_sizeType:integer. Optional. Minimum:0. Largest acceptable response body size, in bytes. -
collection_intervalType:duration. Optional. Default:15s. How often the Collector requests each URL. Every collection performs an HTTP request against the target. -
timeoutType:duration. Optional. Default:10s. Maximum time the Collector waits for each HTTP request to complete. -
tlsType:object. Optional. TLS settings for all HTTPS endpoints inendpoints. Certificate verification is enabled unlessinsecure_skip_verifyistrue. Targets found from annotations use the annotation’s 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.