A TCP check connects to an endpoint on a given hostname or IP address and a port. This ensures a server accepts the connection and measures response latency and uptime.
Options
The list of common options to all check types:
Option
Description
Enabled
Whether the check is enabled or not.
Job name
Refer to the check name. Check metrics include a job label with the value of this option.
Target
Target of the check request. Check metrics include an instance label with the value of this option.
Probe locations
The locations where the check should run from. Check metrics include a probe label with the value of the probe location running the check.
Frequency
The frequency the check should run in seconds. The value can range from 60 to 3600 seconds. Only the sm_check_info metric includes the frequency label.
Timeout
Maximum execution time for the check. The value can range from 1 to 60 seconds.
Custom labels
(Optional) Custom labels applied to check metrics. Refer to Custom labels for querying instructions.
Additionally, TCP checks have the following options:
Option
Description
Use TLS
Whether or not TLS is used when the connection is initiated.
Query and response
The response to expect and the data to send.
Disable target certificate validation
Whether to validate the certificate that is presented.
Server name
The server name used during certificate validation.
CA certificate
The certificate for the certificate authority.
Client certificate
The client certificate to present during authentication.
Client key
The corresponding key for the client certificate.
IP version
The internet protocol version to use (V4, V6, or any).
Publish full set of metrics
Whether to publish additional metrics to create histograms (used for Apdex scores or heatmaps). Default is false to reduce the number of active series.