mudhorn/node_exporter
1
0
Fork 0
mirror of https://github.com/prometheus/node_exporter.git synced 2025-08-20 18:33:52 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move timex docs to the top of the file

Browse source 
Move the docs for the supported `timex` exporter above the docs of the
deprecated `ntp` module. Many folks see the word "deprecated" and stop
reading without realizing there's a supported option buried at the
bottom of the file.

Signed-off-by: David M. Lee <leedm777@yahoo.com>
This commit is contained in:
David M. Lee 2025-06-25 09:17:22 -05:00 committed by Johannes 'fish' Ziemke
parent b57f5bab2d
commit 63399feeaf
1 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/TIME.md
View file

@ -1,5 +1,21 @@
# Monitoring time sync with node_exporter # Monitoring time sync with node_exporter
## `timex` collector
This collector exports state of kernel time synchronization flag that should be
maintained by time-keeping daemon and is eventually raised by Linux kernel if
time-keeping daemon does not update it regularly.
Unfortunately some daemons do not handle this flag properly, e.g. chrony-1.30
from Debian/jessie clears `STA_UNSYNC` flag during daemon initialisation and
does not indicate clock synchronization status using this flag. Modern chrony
versions should work better. All chrony versions require `rtcsync` option to
maintain this flag. OpenNTPD does not touch this flag at all till
OpenNTPD-5.9p1.
On the other hand combination of `sync_status` and `offset` exported by `timex`
module is the way to monitor if systemd-timesyncd does its job.
## `ntp` collector ## `ntp` collector
NOTE: This collector is deprecated and will be removed in the next major version release. NOTE: This collector is deprecated and will be removed in the next major version release.
@ -64,18 +80,3 @@ being less than `collector.ntp.local-offset-tolerance`.
Causality violation is lower bound estimate of clock error done using SNTP, Causality violation is lower bound estimate of clock error done using SNTP,
it's calculated as positive portion of `abs(node_ntp_offset) - node_ntp_rtt / 2`. it's calculated as positive portion of `abs(node_ntp_offset) - node_ntp_rtt / 2`.
## `timex` collector
This collector exports state of kernel time synchronization flag that should be
maintained by time-keeping daemon and is eventually raised by Linux kernel if
time-keeping daemon does not update it regularly.
Unfortunately some daemons do not handle this flag properly, e.g. chrony-1.30
from Debian/jessie clears `STA_UNSYNC` flag during daemon initialisation and
does not indicate clock synchronization status using this flag. Modern chrony
versions should work better. All chrony versions require `rtcsync` option to
maintain this flag. OpenNTPD does not touch this flag at all till
OpenNTPD-5.9p1.
On the other hand combination of `sync_status` and `offset` exported by `timex`
module is the way to monitor if systemd-timesyncd does its job.