Merge pull request #3447 from ccremer/portcheck

Add port check plugin

1 files changed, 36 insertions, 0 deletions

diff --git a/python.d/README.md b/python.d/README.md
index 57b5732da9..5df1ec726f 100644
--- a/python.d/README.md
+++ b/python.d/README.md
@@ -1684,6 +1684,42 @@ Without configuration, module attempts to connect to `http://localhost/status`
 
 ---
 
+# portcheck
+
+Module monitors a remote TCP service.
+
+Following charts are drawn per host:
+
+1. **Latency** ms
+ * Time required to connect to a TCP port.
+   Displays latency in 0.1 ms resolution. If the connection failed, the value is missing.
+
+2. **Status** boolean
+ * Connection successful
+ * Could not create socket: possible DNS problems
+ * Connection refused: port not listening or blocked
+ * Connection timed out: host or port unreachable
+
+
+### configuration
+
+```yaml
+server:
+  host: 'dns or ip'     # required
+  port: 22              # required
+  timeout: 1            # optional
+  update_every: 1       # optional
+```
+
+### notes
+
+ * The error chart is intended for alarms, badges or for access via API.
+ * A system/service/firewall might block netdata's access if a portscan or
+   similar is detected.
+ * Currently, the accuracy of the latency is low and should be used as reference only.
+
+---
+
 # postfix
 
 Simple module executing `postfix -p` to grab postfix queue.