summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/portcheck/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/portcheck/README.md')
-rw-r--r--collectors/python.d.plugin/portcheck/README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/collectors/python.d.plugin/portcheck/README.md b/collectors/python.d.plugin/portcheck/README.md
index 2bbea10c7..35521b2ad 100644
--- a/collectors/python.d.plugin/portcheck/README.md
+++ b/collectors/python.d.plugin/portcheck/README.md
@@ -1,6 +1,12 @@
-# portcheck
+<!--
+title: "TCP endpoint monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/portcheck/README.md
+sidebar_label: "TCP endpoints"
+-->
-Module monitors a remote TCP service.
+# TCP endpoint monitoring with Netdata
+
+Monitors TCP endpoint availability and response time.
Following charts are drawn per host:
@@ -16,7 +22,15 @@ Following charts are drawn per host:
- Connection refused: port not listening or blocked
- Connection timed out: host or port unreachable
-## configuration
+## Configuration
+
+Edit the `python.d/portcheck.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/portcheck.conf
+```
```yaml
server: