Supported telemetry types
The following table lists the telemetry types the TCP Check CXDOT Collector integration supports:Prerequisites
The TCP Check CXDOT Collector integration has the following prerequisite:- Ensure that the CXDOT Collector can reach each host and port that you want to monitor.
Configure
The TCP 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 port that a pod listens on in Kubernetes, such as a message broker
listener, 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.mqtt}with the container port namedmqtt. -
Optional: To monitor hosts outside your Kubernetes cluster, such as a database,
configure static targets. For example, add the following to the
values.yamlfile for the CXDOT Collector Helm chart:The integration instance checks only the listed targets and disables autodiscovery. In cluster mode, the cluster-tier CXDOT Collector connects to static targets. For more information, see architecture. -
Optional: Name a static target. The CXDOT 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 the CXDOT Collector Helm chart:A target found from a Datadogtcp_checkannotation takes the name from the instance’snamesetting. -
Optional: Configure separate integration instances to monitor both
annotated and static targets. For example, add the following to the
values.yamlfile for the CXDOT Collector Helm chart:Thetcp_check/externalkey defines a named instance for the static targets. Configuring a named instance suppresses the implicit default instance, so the emptytcp_check: {}entry is required to keep autodiscovery running. -
Optional: Disable the integration to stop monitoring annotated targets. For
example, add the following to the
values.yamlfile for the CXDOT Collector Helm chart:
Validate
To validate the TCP Check CXDOT Collector integration, follow these steps:-
Confirm target health in
Live Telemetry Analyzer
or
Metrics Explorer:
-
In Live Telemetry Analyzer, add the following filters:
__name__=cxdot.integration.target.healthcxdot.integration.name=tcp_check
cxdot.integration.targetattribute. -
In Metrics Explorer, run the following query:
Confirm that each reachable target reports
1and each unreachable target reports0.
-
In Live Telemetry Analyzer, add the following filters:
-
In
Metrics Explorer,
run the following query:
Confirm that the query returns the connection time in milliseconds for each reachable target. For a hostname target, the time includes resolving the name.
Troubleshooting
-
A target reports
0forcxdot.integration.target.health: In Metrics Explorer, run the following query to group recent failed checks by target and cause:Theerror.codelabel identifies whether the connection was refused, timed out, or found the network unreachable.
Configuration reference
Configure one TCP Check integration instance with the following settings. In Helm values, place these settings undercollection.cxdot.integrations.tcp_check. In a Collector configuration
file, place them under cxdot.integrations.tcp_check.
Optional settings
-
enabledType:boolean. Optional. Default:true. Whether to enable this TCP Check integration instance. If true, the Collector performs connectivity tests. If false, the Collector doesn’t run this integration instance. -
instancesType:array of object. Optional. Default:[]. Connectivity targets. The integration opens a connection to each target during every interval and reports each target separately. -
instances[].endpointType:string. Required. Network address of the target inhost:portformat. -
instances[].nameType:string. Optional. Minimum length:1. Name for this target, added to every time series from it as thecxdot.integration.target.nameattribute. For example,db. A target found from a Datadogtcp_checkannotation takes the instance’sname, spelled as Datadog’sinstancetag spells it. -
collection_intervalType:duration. Optional. Default:15s. How often the integration opens a connection to each target. -
timeoutType:duration. Optional. Default:10s. Maximum time allowed for a connection attempt and the complete connectivity test during one interval. The value must be greater than0sand must not exceedcollection_interval. A target supplied through an annotation takes its timeout from the annotation’stimeout.