The Service Map for APM is here!

TCP Check

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Network Graph

Overview

Monitor TCP connectivity and response time for any host and port.

Setup

Installation

The TCP check is included in the Datadog Agent package, so you don’t need to install anything else on any host from which you will probe TCP ports. Though many metrics-oriented checks are best run on the same host(s) as the monitored service, you’ll probably want to run this check from hosts that do not run the monitored TCP services, i.e. to test remote connectivity.

Configuration

Edit the tcp_check.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample tcp_check.d/conf.yaml for all available configuration options:

init_config:

instances:
  - name: SSH check
    host: jumphost.example.com # or an IPv4/IPv6 address
    port: 22
    collect_response_time: true # to collect network.tcp.response_time. Default is false.

Configuration Options

  • name (Required) - Name of the service. This will be included as a tag: instance:<name>. Note: This tag will have any spaces and dashes converted to underscores.
  • host (Required) - Host to be checked. This will be included as a tag: url:<host>:<port>.
  • port (Required) - Port to be checked. This will be included as a tag: url:<host>:<port>.
  • timeout (Optional) - Timeout for the check. Defaults to 10 seconds.
  • collect_response_time (Optional) - Defaults to false. If this is not set to true, no response time metric will be collected. If it is set to true, the metric returned is network.tcp.response_time.
  • tags (Optional) - Tags to be assigned to the metric.

Restart the Agent to start sending TCP service checks and response times to Datadog.

Validation

Run the Agent’s status subcommand and look for tcp_check under the Checks section.

Data Collected

Metrics

network.tcp.response_time
(gauge)
The response time of a given host and TCP port, tagged with url, e.g. 'url:192.168.1.100:22'.
shown as second
network.tcp.can_connect
(gauge)
Value of 1 if the agent can successfully establish a connection to the URL, 0 otherwise

Events

The TCP check does not include any events at this time.

Service Checks

tcp.can_connect:

Returns DOWN if the Agent cannot connect to the configured host and port, otherwise UP.

To create alert conditions on this service check in Datadog, click Network on the Create Monitor page, not Integration.

Troubleshooting

Need help? Contact Datadog Support.


Mistake in the docs? Feel free to contribute!