Skip to main content

TCP Endpoints

Plugin: go.d.plugin Module: portcheck

Overview

This collector monitors TCP services availability and response time.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per tcp endpoint

These metrics refer to the TCP endpoint.

Labels:

LabelDescription
hosthost
portport

Metrics:

MetricDimensionsUnit
portcheck.statussuccess, failed, timeoutboolean
portcheck.state_durationtimeseconds
portcheck.latencytimems

Alerts

The following alerts are available:

Alert nameOn metricDescription
portcheck_service_reachable portcheck.statusTCP host ${label:host} port ${label:port} liveness status
portcheck_connection_timeouts portcheck.statuspercentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes
portcheck_connection_fails portcheck.statuspercentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/portcheck.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/portcheck.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.5no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
hostRemote host address in IPv4, IPv6 format, or DNS name.yes
portsRemote host ports. Must be specified in numeric format.yes
timeoutHTTP request timeout.2no

Examples

Check SSH and telnet

An example configuration.

Config
jobs:
- name: server1
host: 127.0.0.1
ports:
- 22
- 23

Check webserver with IPv6 address

An example configuration.

Config
jobs:
- name: server2
host: "[2001:DB8::1]"
ports:
- 80
- 8080

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Multiple instances.

Config
jobs:
- name: server1
host: 127.0.0.1
ports:
- 22
- 23

- name: server2
host: 203.0.113.10
ports:
- 22
- 23

Troubleshooting

Debug Mode

To troubleshoot issues with the portcheck collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m portcheck

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.