Plugin: go.d.plugin Module: portcheck
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.
This integration doesn’t support auto-detection.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
No action required.
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
The following options can be defined globally: update_every, autodetection_retry.
Name | Description | Default | Required |
---|---|---|---|
update_every | Data collection frequency. | 5 | no |
autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
host | Remote host address in IPv4, IPv6 format, or DNS name. | yes | |
ports | Remote host ports. Must be specified in numeric format. | yes | |
timeout | HTTP request timeout. | 2 | no |
An example configuration.
jobs:
- name: server1
host: 127.0.0.1
ports:
- 22
- 23
An example configuration.
jobs:
- name: server2
host: "[2001:DB8::1]"
ports:
- 80
- 8080
Note: When you define multiple jobs, their names must be unique.
Multiple instances.
jobs:
- name: server1
host: 127.0.0.1
ports:
- 22
- 23
- name: server2
host: 203.0.113.10
ports:
- 22
- 23
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the TCP endpoint.
Labels:
Label | Description |
---|---|
host | host |
port | port |
Metrics:
Metric | Dimensions | Unit |
---|---|---|
portcheck.status | success, failed, timeout | boolean |
portcheck.state_duration | time | seconds |
portcheck.latency | time | ms |
The following alerts are available:
Alert name | On metric | Description |
---|---|---|
portcheck_service_reachable | portcheck.status | TCP host ${label:host} port ${label:port} liveness status |
portcheck_connection_timeouts | portcheck.status | percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
portcheck_connection_fails | portcheck.status | percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
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
If you’re encountering problems with the portcheck
collector, follow these steps to retrieve logs and identify potential issues:
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep portcheck
Locate the collector log file, typically at /var/log/netdata/collector.log
, and use grep
to filter for collector’s name:
grep portcheck /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep portcheck