Corrected portcheck documentation
Chris committed
Feb 24, 2018 at 22:22 UTC
1a13cc6839f28180f1419e2ff483d0811a1d53d9
3 files changed
+9
-14
conf.d/python.d/portcheck.conf
+1
-1
@@ -57,5 +57,5 @@
57
# port: 22 # [required] the port number to check. Specify an integer, not service name.
58
59
# You just have been warned about possible portscan blocking. The portcheck plugin is meant for simple use cases.
60
-# For monitoring large networks, consider a real service monitoring tool.
60
+# Currently, the accuracy of the latency is low and should be used as reference only.
61
python.d/README.md
+5
-10
@@ -1548,12 +1548,12 @@ Without configuration, module attempts to connect to `http://localhost/status`
1548
1549
# portcheck
1550
1551
-Module monitors one or more remote ports per host.
1551
+Module monitors a remote TCP service.
1552
1553
Following charts are drawn per host:
1554
1555
1. **Latency** ms
1556
- * TCP socket opening and closing time when connecting.
1556
+ * Time required to connect to a TCP port.
1557
Displays latency in 0.1 ms resolution. If the connection failed, the value is missing.
1558
1559
2. **Error** int
@@ -1568,22 +1568,17 @@ Following charts are drawn per host:
1568
```yaml
1569
server:
1570
host: 'dns or ip' # required
1571
- ports: # required
1572
- - 22
1571
+ port: 22 # required
1572
timeout: 1 # optional
1573
update_every: 1 # optional
1574
```
1575
1576
### notes
1577
1579
- * The error code chart is intended for health check or for access via API.
1578
+ * The error chart is intended for alarms or for access via API.
1579
* A system/service/firewall might block netdata's access if a portscan or
1580
similar is detected.
1582
- * Each port check is executed in sequence. E.g. if port 22 times out after 3s and
1583
- port 80 takes 200ms, the whole check requires 3.2 seconds. You may want
1584
- to decrease the `timeout` and/or increase `update_every` in order to get
1585
- regular results (e.g. `'update_every' = 'number-of-ports-to-check' * 'timeout'`
1586
- will result in regular, though longer intervals.
1581
+ * Currently, the accuracy of the latency is low and should be used as reference only.
1582
1583
---
1584
web/dashboard_info.js
+3
-3
@@ -1728,14 +1728,14 @@ netdataDashboard.context = {
1728
// Port check
1729
1730
'portcheck.latency': {
1731
- info: 'The <code>Latency</code> describes the time spent opening and closing a socket. No data is sent or received. ' +
1732
- 'A response time of <code>0.0 ms</code> indicates a connection error.'
1731
+ info: 'The <code>latency</code> describes the time spent connecting to a TCP port. No data is sent or received. ' +
1732
+ 'Currently, the accuracy of the latency is low and should be used as reference only.'
1733
},
1734
1735
'portcheck.error': {
1736
valueRange: "[0, 1]",
1737
info: 'The <code>error</code> codes are returned by the plugin when it could verify the availability of the service. ' +
1738
- 'Each error dimension will have a value of <code>1</code> if triggered. Dimension <code>success</code> is always <code>1</code> on successful connects.' +
1738
+ 'Each error dimension will have a value of <code>1</code> if triggered. Dimension <code>success</code> is always <code>1</code> if connection could be established.' +
1739
'The error code is most useful for alarms and third-party apps.'
1740
},
1741