Adjust timex.plugin information to be less cryptic (#12495)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com>
DanTheMediocre committed
Mar 23, 2022 at 19:54 UTC
83e13596cb458eff1591abfa1c67f497153295db
3 files changed
+8
-6
collectors/timex.plugin/README.md
+5
-2
@@ -6,13 +6,16 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/timex
6
7
# timex.plugin
8
9
-This plugin monitors the system clock synchronization state on Linux nodes.
9
+This plugin monitors the system kernel clock synchronization state.
10
11
This plugin creates two charts:
12
13
-- System clock synchronization state
13
+- System clock synchronization state according to the system kernel
14
- Computed time offset between local system and reference clock
15
16
+This is obtained from the information provided by the [ntp_adjtime()](https://man7.org/linux/man-pages/man2/adjtimex.2.html) system call.
17
+An unsynchronized clock may indicate a hardware clock error, or an issue with UTC synchronization.
18
+
19
## Configuration
20
21
Edit the `netdata.conf` configuration file using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
health/health.d/timex.conf
+1
-1
@@ -13,5 +13,5 @@ component: Clock
13
every: 10s
14
warn: $system.uptime.uptime > 17 * 60 AND $this == 0
15
delay: down 5m
16
- info: the system time is not synchronized to a reliable server
16
+ info: when set to 0, the system kernel believes the system clock is not properly synchronized to a reliable server
17
to: silent
web/gui/dashboard_info.js
+2
-3
@@ -1310,9 +1310,8 @@ netdataDashboard.context = {
1310
},
1311
1312
'system.clock_sync_state': {
1313
- info:'<p>The system clock synchronization state. '+
1314
- 'It is strongly recommended having the clock in sync with reliable NTP servers. Otherwise, '+
1315
- 'it leads to unpredictable problems. '+
1313
+ info:'<p>The system clock synchronization state as provided by the <a href="https://man7.org/linux/man-pages/man2/adjtimex.2.html" target="_blank">ntp_adjtime()</a> system call. '+
1314
+ 'An unsynchronized clock may be the result of synchronization issues by the NTP daemon or a hardware clock fault. '+
1315
'It can take several minutes (usually up to 17) before NTP daemon selects a server to synchronize with. '+
1316
'<p><b>State map</b>: 0 - not synchronized, 1 - synchronized.</p>'
1317
},