Update readme
Sven Mäder committed
Feb 13, 2018 at 21:49 UTC
b06901c4adb65a6ad625eb936cb32a31255f39be
1 file changed
+57
python.d/README.md
+57
@@ -1472,6 +1472,63 @@ Configuration is not needed.
1472
1473
---
1474
1475
+# ntp
1476
+
1477
+Module monitors the system variables of the local `ntpd` daemon, incl. variables of the polled peers using the NTP Control Message Protocol via UDP socket, similar to `ntpq`.
1478
+
1479
+**Requirements:**
1480
+ * Version of `ntpd` must be 2.0+
1481
+ * Local interrogation allowed in `/etc/ntp.conf` (default):
1482
+
1483
+```
1484
+# Local users may interrogate the ntp server more closely.
1485
+restrict 127.0.0.1
1486
+restrict ::1
1487
+```
1488
+
1489
+It produces:
1490
+
1491
+1. system
1492
+ * offset
1493
+ * jitter
1494
+ * frequency
1495
+ * delay
1496
+ * dispersion
1497
+ * stratum
1498
+ * tc
1499
+ * precision
1500
+
1501
+2. peers
1502
+ * offset
1503
+ * delay
1504
+ * dispersion
1505
+ * jitter
1506
+ * rootdelay
1507
+ * rootdispersion
1508
+ * stratum
1509
+ * hmode
1510
+ * pmode
1511
+ * hpoll
1512
+ * ppoll
1513
+ * precision
1514
+
1515
+**configuration**
1516
+
1517
+Sample:
1518
+
1519
+```yaml
1520
+update_every: 10
1521
+
1522
+host: 'localhost'
1523
+port: '123'
1524
+peer_names: yes
1525
+peer_filter: '(127\..*)|(.*\.example\.com)'
1526
+```
1527
+
1528
+If no configuration is given, module will attempt to connect to `ntpd` on `::1:123` or `127.0.0.1:123`. Peer names are resolved using reverse dns lookup of the source address. Local peers (127.*) are hidden by default, use `peer_filter: '.*'` to show all. To disable reverse lookup and show ip addresses instead, use `peer_names: no`. Any dots `.` are replaced with dashes `-`.
1529
+
1530
+---
1531
+
1532
# ovpn_status_log
1533
1534
Module monitor openvpn-status log file.