Regenerate integrations.js (#18571)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Sep 17, 2024 at 17:12 UTC
eedc8c59b9aa375b1017673ec525ef5ce5432101
6 files changed
+338
-264
integrations/integrations.js
+5
-5
@@ -6001,7 +6001,7 @@ export const integrations = [
6001
"plugin_name": "go.d.plugin",
6002
"module_name": "portcheck",
6003
"monitored_instance": {
6004
- "name": "TCP Endpoints",
6004
+ "name": "TCP/UDP Endpoints",
6005
"link": "",
6006
"icon_filename": "globe.svg",
6007
"categories": [
@@ -6019,13 +6019,13 @@ export const integrations = [
6019
},
6020
"most_popular": false
6021
},
6022
- "overview": "# TCP Endpoints\n\nPlugin: go.d.plugin\nModule: portcheck\n\n## Overview\n\nThis collector monitors TCP services availability and response time.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
6023
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/portcheck.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/portcheck.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 5 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |\n| ports | Remote host ports. Must be specified in numeric format. | | yes |\n| timeout | HTTP request timeout. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Check SSH and telnet\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n```\n{% /details %}\n##### Check webserver with IPv6 address\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: server2\n host: \"[2001:DB8::1]\"\n ports:\n - 80\n - 8080\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nMultiple instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n - name: server2\n host: 203.0.113.10\n ports:\n - 22\n - 23\n\n```\n{% /details %}\n",
6022
+ "overview": "# TCP/UDP Endpoints\n\nPlugin: go.d.plugin\nModule: portcheck\n\n## Overview\n\nCollector for monitoring service availability and response time. It can be used to check if specific ports are open or reachable on a target system.\n\nIt supports both TCP and UDP protocols over IPv4 and IPv6 networks.\n\n| Protocol | Check Description |\n|----------|-----------------------------------------------------------------------------------------------------------------------------|\n| TCP | Attempts to establish a TCP connection to the specified ports on the target system. |\n| UDP | Sends a 0-byte UDP packet to the specified ports on the target system and analyzes ICMP responses to determine port status. |\n\nPossible TCP statuses:\n\n| TCP Status | Description |\n|------------|-------------------------------------------------------------|\n| success | Connection established successfully. |\n| timeout | Connection timed out after waiting for configured duration. |\n| failed | An error occurred during the connection attempt. |\n\nPossible UDP statuses:\n\n| TCP Status | Description |\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open/filtered | No response received within the configured timeout. This status indicates the port is either open or filtered, but the exact state cannot be determined definitively. |\n| closed | Received an ICMP Destination Unreachable message, indicating the port is closed. |\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
6023
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/portcheck.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/portcheck.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 5 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |\n| ports | Remote host TCP ports. Must be specified in numeric format. | | yes |\n| timeout | HTTP request timeout. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Check TCP ports (IPv4)\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n```\n{% /details %}\n##### Check TCP ports (IPv6)\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n host: \"[2001:DB8::1]\"\n ports:\n - 80\n - 8080\n\n```\n{% /details %}\n##### Check UDP ports (IPv4)\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n host: 127.0.0.1\n udp_ports:\n - 3120\n - 3121\n\n```\n{% /details %}\n##### Check UDP ports (IPv6)\n\nAn example configuration.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: local\n host: [::1]\n udp_ports:\n - 3120\n - 3121\n\n```\n{% /details %}\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nMultiple instances.\n\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n - name: server2\n host: 203.0.113.10\n ports:\n - 22\n - 23\n\n```\n{% /details %}\n",
6024
"troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `portcheck` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m portcheck\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `portcheck` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep portcheck\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep portcheck /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep portcheck\n```\n\n",
6025
"alerts": "## Alerts\n\n\nThe following alerts are available:\n\n| Alert name | On metric | Description |\n|:------------|:----------|:------------|\n| [ portcheck_service_reachable ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | TCP host ${label:host} port ${label:port} liveness status |\n| [ portcheck_connection_timeouts ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |\n| [ portcheck_connection_fails ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |\n",
6026
- "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per tcp endpoint\n\nThese metrics refer to the TCP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.status | success, failed, timeout | boolean |\n| portcheck.state_duration | time | seconds |\n| portcheck.latency | time | ms |\n\n",
6026
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per TCP endpoint\n\nThese metrics refer to the TCP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.status | success, failed, timeout | boolean |\n| portcheck.state_duration | time | seconds |\n| portcheck.latency | time | ms |\n\n### Per UDP endpoint\n\nThese metrics refer to the UDP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.udp_port_status | open/filtered, closed | status |\n| portcheck.udp_port_status_duration | time | seconds |\n\n",
6027
"integration_type": "collector",
6028
- "id": "go.d.plugin-portcheck-TCP_Endpoints",
6028
+ "id": "go.d.plugin-portcheck-TCP/UDP_Endpoints",
6029
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/portcheck/metadata.yaml",
6030
"related_resources": ""
6031
},
integrations/integrations.json
+5
-5
@@ -5999,7 +5999,7 @@
5999
"plugin_name": "go.d.plugin",
6000
"module_name": "portcheck",
6001
"monitored_instance": {
6002
- "name": "TCP Endpoints",
6002
+ "name": "TCP/UDP Endpoints",
6003
"link": "",
6004
"icon_filename": "globe.svg",
6005
"categories": [
@@ -6017,13 +6017,13 @@
6017
},
6018
"most_popular": false
6019
},
6020
- "overview": "# TCP Endpoints\n\nPlugin: go.d.plugin\nModule: portcheck\n\n## Overview\n\nThis collector monitors TCP services availability and response time.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
6021
- "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/portcheck.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/portcheck.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 5 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |\n| ports | Remote host ports. Must be specified in numeric format. | | yes |\n| timeout | HTTP request timeout. | 2 | no |\n\n#### Examples\n\n##### Check SSH and telnet\n\nAn example configuration.\n\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n```\n##### Check webserver with IPv6 address\n\nAn example configuration.\n\n```yaml\njobs:\n - name: server2\n host: \"[2001:DB8::1]\"\n ports:\n - 80\n - 8080\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nMultiple instances.\n\n\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n - name: server2\n host: 203.0.113.10\n ports:\n - 22\n - 23\n\n```\n",
6020
+ "overview": "# TCP/UDP Endpoints\n\nPlugin: go.d.plugin\nModule: portcheck\n\n## Overview\n\nCollector for monitoring service availability and response time. It can be used to check if specific ports are open or reachable on a target system.\n\nIt supports both TCP and UDP protocols over IPv4 and IPv6 networks.\n\n| Protocol | Check Description |\n|----------|-----------------------------------------------------------------------------------------------------------------------------|\n| TCP | Attempts to establish a TCP connection to the specified ports on the target system. |\n| UDP | Sends a 0-byte UDP packet to the specified ports on the target system and analyzes ICMP responses to determine port status. |\n\nPossible TCP statuses:\n\n| TCP Status | Description |\n|------------|-------------------------------------------------------------|\n| success | Connection established successfully. |\n| timeout | Connection timed out after waiting for configured duration. |\n| failed | An error occurred during the connection attempt. |\n\nPossible UDP statuses:\n\n| TCP Status | Description |\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open/filtered | No response received within the configured timeout. This status indicates the port is either open or filtered, but the exact state cannot be determined definitively. |\n| closed | Received an ICMP Destination Unreachable message, indicating the port is closed. |\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector supports collecting metrics from multiple instances of this integration, including remote instances.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
6021
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/portcheck.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/portcheck.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every, autodetection_retry.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 5 | no |\n| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |\n| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |\n| ports | Remote host TCP ports. Must be specified in numeric format. | | yes |\n| timeout | HTTP request timeout. | 2 | no |\n\n#### Examples\n\n##### Check TCP ports (IPv4)\n\nAn example configuration.\n\n```yaml\njobs:\n - name: local\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n```\n##### Check TCP ports (IPv6)\n\nAn example configuration.\n\n```yaml\njobs:\n - name: local\n host: \"[2001:DB8::1]\"\n ports:\n - 80\n - 8080\n\n```\n##### Check UDP ports (IPv4)\n\nAn example configuration.\n\n```yaml\njobs:\n - name: local\n host: 127.0.0.1\n udp_ports:\n - 3120\n - 3121\n\n```\n##### Check UDP ports (IPv6)\n\nAn example configuration.\n\n```yaml\njobs:\n - name: local\n host: [::1]\n udp_ports:\n - 3120\n - 3121\n\n```\n##### Multi-instance\n\n> **Note**: When you define multiple jobs, their names must be unique.\n\nMultiple instances.\n\n\n```yaml\njobs:\n - name: server1\n host: 127.0.0.1\n ports:\n - 22\n - 23\n\n - name: server2\n host: 203.0.113.10\n ports:\n - 22\n - 23\n\n```\n",
6022
"troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\n**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.\n\nTo troubleshoot issues with the `portcheck` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m portcheck\n ```\n\n### Getting Logs\n\nIf you're encountering problems with the `portcheck` collector, follow these steps to retrieve logs and identify potential issues:\n\n- **Run the command** specific to your system (systemd, non-systemd, or Docker container).\n- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.\n\n#### System with systemd\n\nUse the following command to view logs generated since the last Netdata service restart:\n\n```bash\njournalctl _SYSTEMD_INVOCATION_ID=\"$(systemctl show --value --property=InvocationID netdata)\" --namespace=netdata --grep portcheck\n```\n\n#### System without systemd\n\nLocate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:\n\n```bash\ngrep portcheck /var/log/netdata/collector.log\n```\n\n**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.\n\n#### Docker Container\n\nIf your Netdata runs in a Docker container named \"netdata\" (replace if different), use this command:\n\n```bash\ndocker logs netdata 2>&1 | grep portcheck\n```\n\n",
6023
"alerts": "## Alerts\n\n\nThe following alerts are available:\n\n| Alert name | On metric | Description |\n|:------------|:----------|:------------|\n| [ portcheck_service_reachable ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | TCP host ${label:host} port ${label:port} liveness status |\n| [ portcheck_connection_timeouts ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |\n| [ portcheck_connection_fails ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |\n",
6024
- "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per tcp endpoint\n\nThese metrics refer to the TCP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.status | success, failed, timeout | boolean |\n| portcheck.state_duration | time | seconds |\n| portcheck.latency | time | ms |\n\n",
6024
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per TCP endpoint\n\nThese metrics refer to the TCP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.status | success, failed, timeout | boolean |\n| portcheck.state_duration | time | seconds |\n| portcheck.latency | time | ms |\n\n### Per UDP endpoint\n\nThese metrics refer to the UDP endpoint.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| host | host |\n| port | port |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| portcheck.udp_port_status | open/filtered, closed | status |\n| portcheck.udp_port_status_duration | time | seconds |\n\n",
6025
"integration_type": "collector",
6026
- "id": "go.d.plugin-portcheck-TCP_Endpoints",
6026
+ "id": "go.d.plugin-portcheck-TCP/UDP_Endpoints",
6027
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/portcheck/metadata.yaml",
6028
"related_resources": ""
6029
},
src/collectors/COLLECTORS.md
+1
-1
@@ -1041,7 +1041,7 @@ If you don't see the app/service you'd like to monitor in this list:
1041
1042
- [Site 24x7](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/site_24x7.md)
1043
1044
-- [TCP Endpoints](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/portcheck/integrations/tcp_endpoints.md)
1044
+- [TCP/UDP Endpoints](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/portcheck/integrations/tcp-udp_endpoints.md)
1045
1046
- [Uptimerobot](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/modules/prometheus/integrations/uptimerobot.md)
1047
src/go/plugin/go.d/modules/portcheck/README.md
+1
-1
@@ -1 +1 @@
1
-integrations/tcp_endpoints.md
\ No newline at end of file
1
+integrations/tcp-udp_endpoints.md
\ No newline at end of file
src/go/plugin/go.d/modules/portcheck/integrations/tcp-udp_endpoints.md
new
+326
@@ -0,0 +1,326 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/portcheck/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/portcheck/metadata.yaml"
4
+sidebar_label: "TCP/UDP Endpoints"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Synthetic Checks"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# TCP/UDP Endpoints
12
+
13
+
14
+<img src="https://netdata.cloud/img/globe.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: portcheck
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+Collector for monitoring service availability and response time. It can be used to check if specific ports are open or reachable on a target system.
25
+
26
+It supports both TCP and UDP protocols over IPv4 and IPv6 networks.
27
+
28
+| Protocol | Check Description |
29
+|----------|-----------------------------------------------------------------------------------------------------------------------------|
30
+| TCP | Attempts to establish a TCP connection to the specified ports on the target system. |
31
+| UDP | Sends a 0-byte UDP packet to the specified ports on the target system and analyzes ICMP responses to determine port status. |
32
+
33
+Possible TCP statuses:
34
+
35
+| TCP Status | Description |
36
+|------------|-------------------------------------------------------------|
37
+| success | Connection established successfully. |
38
+| timeout | Connection timed out after waiting for configured duration. |
39
+| failed | An error occurred during the connection attempt. |
40
+
41
+Possible UDP statuses:
42
+
43
+| TCP Status | Description |
44
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
45
+| open/filtered | No response received within the configured timeout. This status indicates the port is either open or filtered, but the exact state cannot be determined definitively. |
46
+| closed | Received an ICMP Destination Unreachable message, indicating the port is closed. |
47
+
48
+
49
+
50
+
51
+This collector is supported on all platforms.
52
+
53
+This collector supports collecting metrics from multiple instances of this integration, including remote instances.
54
+
55
+
56
+### Default Behavior
57
+
58
+#### Auto-Detection
59
+
60
+This integration doesn't support auto-detection.
61
+
62
+#### Limits
63
+
64
+The default configuration for this integration does not impose any limits on data collection.
65
+
66
+#### Performance Impact
67
+
68
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
69
+
70
+
71
+## Metrics
72
+
73
+Metrics grouped by *scope*.
74
+
75
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
76
+
77
+
78
+
79
+### Per TCP endpoint
80
+
81
+These metrics refer to the TCP endpoint.
82
+
83
+Labels:
84
+
85
+| Label | Description |
86
+|:-----------|:----------------|
87
+| host | host |
88
+| port | port |
89
+
90
+Metrics:
91
+
92
+| Metric | Dimensions | Unit |
93
+|:------|:----------|:----|
94
+| portcheck.status | success, failed, timeout | boolean |
95
+| portcheck.state_duration | time | seconds |
96
+| portcheck.latency | time | ms |
97
+
98
+### Per UDP endpoint
99
+
100
+These metrics refer to the UDP endpoint.
101
+
102
+Labels:
103
+
104
+| Label | Description |
105
+|:-----------|:----------------|
106
+| host | host |
107
+| port | port |
108
+
109
+Metrics:
110
+
111
+| Metric | Dimensions | Unit |
112
+|:------|:----------|:----|
113
+| portcheck.udp_port_status | open/filtered, closed | status |
114
+| portcheck.udp_port_status_duration | time | seconds |
115
+
116
+
117
+
118
+## Alerts
119
+
120
+
121
+The following alerts are available:
122
+
123
+| Alert name | On metric | Description |
124
+|:------------|:----------|:------------|
125
+| [ portcheck_service_reachable ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | TCP host ${label:host} port ${label:port} liveness status |
126
+| [ portcheck_connection_timeouts ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
127
+| [ portcheck_connection_fails ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
128
+
129
+
130
+## Setup
131
+
132
+### Prerequisites
133
+
134
+No action required.
135
+
136
+### Configuration
137
+
138
+#### File
139
+
140
+The configuration file name for this integration is `go.d/portcheck.conf`.
141
+
142
+
143
+You can edit the configuration file using the `edit-config` script from the
144
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
145
+
146
+```bash
147
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
148
+sudo ./edit-config go.d/portcheck.conf
149
+```
150
+#### Options
151
+
152
+The following options can be defined globally: update_every, autodetection_retry.
153
+
154
+
155
+<details open><summary>Config options</summary>
156
+
157
+| Name | Description | Default | Required |
158
+|:----|:-----------|:-------|:--------:|
159
+| update_every | Data collection frequency. | 5 | no |
160
+| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
161
+| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |
162
+| ports | Remote host TCP ports. Must be specified in numeric format. | | yes |
163
+| timeout | HTTP request timeout. | 2 | no |
164
+
165
+</details>
166
+
167
+#### Examples
168
+
169
+##### Check TCP ports (IPv4)
170
+
171
+An example configuration.
172
+
173
+<details open><summary>Config</summary>
174
+
175
+```yaml
176
+jobs:
177
+ - name: local
178
+ host: 127.0.0.1
179
+ ports:
180
+ - 22
181
+ - 23
182
+
183
+```
184
+</details>
185
+
186
+##### Check TCP ports (IPv6)
187
+
188
+An example configuration.
189
+
190
+<details open><summary>Config</summary>
191
+
192
+```yaml
193
+jobs:
194
+ - name: local
195
+ host: "[2001:DB8::1]"
196
+ ports:
197
+ - 80
198
+ - 8080
199
+
200
+```
201
+</details>
202
+
203
+##### Check UDP ports (IPv4)
204
+
205
+An example configuration.
206
+
207
+<details open><summary>Config</summary>
208
+
209
+```yaml
210
+jobs:
211
+ - name: local
212
+ host: 127.0.0.1
213
+ udp_ports:
214
+ - 3120
215
+ - 3121
216
+
217
+```
218
+</details>
219
+
220
+##### Check UDP ports (IPv6)
221
+
222
+An example configuration.
223
+
224
+<details open><summary>Config</summary>
225
+
226
+```yaml
227
+jobs:
228
+ - name: local
229
+ host: [::1]
230
+ udp_ports:
231
+ - 3120
232
+ - 3121
233
+
234
+```
235
+</details>
236
+
237
+##### Multi-instance
238
+
239
+> **Note**: When you define multiple jobs, their names must be unique.
240
+
241
+Multiple instances.
242
+
243
+
244
+<details open><summary>Config</summary>
245
+
246
+```yaml
247
+jobs:
248
+ - name: server1
249
+ host: 127.0.0.1
250
+ ports:
251
+ - 22
252
+ - 23
253
+
254
+ - name: server2
255
+ host: 203.0.113.10
256
+ ports:
257
+ - 22
258
+ - 23
259
+
260
+```
261
+</details>
262
+
263
+
264
+
265
+## Troubleshooting
266
+
267
+### Debug Mode
268
+
269
+**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
270
+
271
+To troubleshoot issues with the `portcheck` collector, run the `go.d.plugin` with the debug option enabled. The output
272
+should give you clues as to why the collector isn't working.
273
+
274
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
275
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
276
+
277
+ ```bash
278
+ cd /usr/libexec/netdata/plugins.d/
279
+ ```
280
+
281
+- Switch to the `netdata` user.
282
+
283
+ ```bash
284
+ sudo -u netdata -s
285
+ ```
286
+
287
+- Run the `go.d.plugin` to debug the collector:
288
+
289
+ ```bash
290
+ ./go.d.plugin -d -m portcheck
291
+ ```
292
+
293
+### Getting Logs
294
+
295
+If you're encountering problems with the `portcheck` collector, follow these steps to retrieve logs and identify potential issues:
296
+
297
+- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
298
+- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
299
+
300
+#### System with systemd
301
+
302
+Use the following command to view logs generated since the last Netdata service restart:
303
+
304
+```bash
305
+journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep portcheck
306
+```
307
+
308
+#### System without systemd
309
+
310
+Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
311
+
312
+```bash
313
+grep portcheck /var/log/netdata/collector.log
314
+```
315
+
316
+**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
317
+
318
+#### Docker Container
319
+
320
+If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
321
+
322
+```bash
323
+docker logs netdata 2>&1 | grep portcheck
324
+```
325
+
326
+
src/go/plugin/go.d/modules/portcheck/integrations/tcp_endpoints.md
-252
@@ -1,252 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/portcheck/README.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/modules/portcheck/metadata.yaml"
4
-sidebar_label: "TCP Endpoints"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Synthetic Checks"
7
-most_popular: False
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# TCP Endpoints
12
-
13
-
14
-<img src="https://netdata.cloud/img/globe.svg" width="150"/>
15
-
16
-
17
-Plugin: go.d.plugin
18
-Module: portcheck
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
-
22
-## Overview
23
-
24
-This collector monitors TCP services availability and response time.
25
-
26
-
27
-
28
-
29
-This collector is supported on all platforms.
30
-
31
-This collector supports collecting metrics from multiple instances of this integration, including remote instances.
32
-
33
-
34
-### Default Behavior
35
-
36
-#### Auto-Detection
37
-
38
-This integration doesn't support auto-detection.
39
-
40
-#### Limits
41
-
42
-The default configuration for this integration does not impose any limits on data collection.
43
-
44
-#### Performance Impact
45
-
46
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
47
-
48
-
49
-## Metrics
50
-
51
-Metrics grouped by *scope*.
52
-
53
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
54
-
55
-
56
-
57
-### Per tcp endpoint
58
-
59
-These metrics refer to the TCP endpoint.
60
-
61
-Labels:
62
-
63
-| Label | Description |
64
-|:-----------|:----------------|
65
-| host | host |
66
-| port | port |
67
-
68
-Metrics:
69
-
70
-| Metric | Dimensions | Unit |
71
-|:------|:----------|:----|
72
-| portcheck.status | success, failed, timeout | boolean |
73
-| portcheck.state_duration | time | seconds |
74
-| portcheck.latency | time | ms |
75
-
76
-
77
-
78
-## Alerts
79
-
80
-
81
-The following alerts are available:
82
-
83
-| Alert name | On metric | Description |
84
-|:------------|:----------|:------------|
85
-| [ portcheck_service_reachable ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | TCP host ${label:host} port ${label:port} liveness status |
86
-| [ portcheck_connection_timeouts ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
87
-| [ portcheck_connection_fails ](https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf) | portcheck.status | percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes |
88
-
89
-
90
-## Setup
91
-
92
-### Prerequisites
93
-
94
-No action required.
95
-
96
-### Configuration
97
-
98
-#### File
99
-
100
-The configuration file name for this integration is `go.d/portcheck.conf`.
101
-
102
-
103
-You can edit the configuration file using the `edit-config` script from the
104
-Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
105
-
106
-```bash
107
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
108
-sudo ./edit-config go.d/portcheck.conf
109
-```
110
-#### Options
111
-
112
-The following options can be defined globally: update_every, autodetection_retry.
113
-
114
-
115
-<details open><summary>Config options</summary>
116
-
117
-| Name | Description | Default | Required |
118
-|:----|:-----------|:-------|:--------:|
119
-| update_every | Data collection frequency. | 5 | no |
120
-| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
121
-| host | Remote host address in IPv4, IPv6 format, or DNS name. | | yes |
122
-| ports | Remote host ports. Must be specified in numeric format. | | yes |
123
-| timeout | HTTP request timeout. | 2 | no |
124
-
125
-</details>
126
-
127
-#### Examples
128
-
129
-##### Check SSH and telnet
130
-
131
-An example configuration.
132
-
133
-<details open><summary>Config</summary>
134
-
135
-```yaml
136
-jobs:
137
- - name: server1
138
- host: 127.0.0.1
139
- ports:
140
- - 22
141
- - 23
142
-
143
-```
144
-</details>
145
-
146
-##### Check webserver with IPv6 address
147
-
148
-An example configuration.
149
-
150
-<details open><summary>Config</summary>
151
-
152
-```yaml
153
-jobs:
154
- - name: server2
155
- host: "[2001:DB8::1]"
156
- ports:
157
- - 80
158
- - 8080
159
-
160
-```
161
-</details>
162
-
163
-##### Multi-instance
164
-
165
-> **Note**: When you define multiple jobs, their names must be unique.
166
-
167
-Multiple instances.
168
-
169
-
170
-<details open><summary>Config</summary>
171
-
172
-```yaml
173
-jobs:
174
- - name: server1
175
- host: 127.0.0.1
176
- ports:
177
- - 22
178
- - 23
179
-
180
- - name: server2
181
- host: 203.0.113.10
182
- ports:
183
- - 22
184
- - 23
185
-
186
-```
187
-</details>
188
-
189
-
190
-
191
-## Troubleshooting
192
-
193
-### Debug Mode
194
-
195
-**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
196
-
197
-To troubleshoot issues with the `portcheck` collector, run the `go.d.plugin` with the debug option enabled. The output
198
-should give you clues as to why the collector isn't working.
199
-
200
-- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
201
- your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
202
-
203
- ```bash
204
- cd /usr/libexec/netdata/plugins.d/
205
- ```
206
-
207
-- Switch to the `netdata` user.
208
-
209
- ```bash
210
- sudo -u netdata -s
211
- ```
212
-
213
-- Run the `go.d.plugin` to debug the collector:
214
-
215
- ```bash
216
- ./go.d.plugin -d -m portcheck
217
- ```
218
-
219
-### Getting Logs
220
-
221
-If you're encountering problems with the `portcheck` collector, follow these steps to retrieve logs and identify potential issues:
222
-
223
-- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
224
-- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
225
-
226
-#### System with systemd
227
-
228
-Use the following command to view logs generated since the last Netdata service restart:
229
-
230
-```bash
231
-journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep portcheck
232
-```
233
-
234
-#### System without systemd
235
-
236
-Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:
237
-
238
-```bash
239
-grep portcheck /var/log/netdata/collector.log
240
-```
241
-
242
-**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.
243
-
244
-#### Docker Container
245
-
246
-If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
247
-
248
-```bash
249
-docker logs netdata 2>&1 | grep portcheck
250
-```
251
-
252
-