collectors/timex.plugin/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

<!--
title: "timex.plugin"
description: "Monitor the system clock synchronization state."
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/timex.plugin/README.md"
sidebar_label: "timex.plugin"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "References/Collectors references/System metrics"
-->

# timex.plugin

This plugin monitors the system kernel clock synchronization state.

This plugin creates the following charts:

- System clock synchronization state according to the system kernel
- System clock status which gives the value of the `time_status` variable in the 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`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.

Scroll down to the `[plugin:timex]` section to find the available options:

```ini
[plugin:timex]
    # update every = 1
    # clock synchronization state = yes
    # time offset = yes
```