summaryrefslogtreecommitdiffstats
path: root/collectors/timex.plugin
diff options
context:
space:
mode:
authorDanTheMediocre <djo@live.nl>2022-03-23 19:54:45 +0100
committerGitHub <noreply@github.com>2022-03-23 20:54:45 +0200
commit83e13596cb458eff1591abfa1c67f497153295db (patch)
treec4bdef398a2f998f113dd25bec3116975972f2bf /collectors/timex.plugin
parent1023c3e196fafcc21c10bf3c3c95b88339b82f1a (diff)
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>
Diffstat (limited to 'collectors/timex.plugin')
-rw-r--r--collectors/timex.plugin/README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/collectors/timex.plugin/README.md b/collectors/timex.plugin/README.md
index e5c6a1dede..2956512f1d 100644
--- a/collectors/timex.plugin/README.md
+++ b/collectors/timex.plugin/README.md
@@ -6,13 +6,16 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/timex
# timex.plugin
-This plugin monitors the system clock synchronization state on Linux nodes.
+This plugin monitors the system kernel clock synchronization state.
This plugin creates two charts:
-- System clock synchronization state
+- System clock synchronization state according to the system kernel
- Computed time offset between local system and reference clock
+This is obtained from the information provided by the [ntp_adjtime()](https://man7.org/linux/man-pages/man2/adjtimex.2.html) system call.
+An unsynchronized clock may indicate a hardware clock error, or an issue with UTC synchronization.
+
## Configuration
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`.