From 517a443636daa1e8085cb4e5325524a54e8a8fd7 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 17 Oct 2023 11:30:23 +0200 Subject: Merging upstream version 1.43.0. Signed-off-by: Daniel Baumann --- collectors/timex.plugin/README.md | 36 +------ collectors/timex.plugin/integrations/timex.md | 142 ++++++++++++++++++++++++++ 2 files changed, 143 insertions(+), 35 deletions(-) mode change 100644 => 120000 collectors/timex.plugin/README.md create mode 100644 collectors/timex.plugin/integrations/timex.md (limited to 'collectors/timex.plugin') diff --git a/collectors/timex.plugin/README.md b/collectors/timex.plugin/README.md deleted file mode 100644 index 6173503b8..000000000 --- a/collectors/timex.plugin/README.md +++ /dev/null @@ -1,35 +0,0 @@ - - -# 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 -``` diff --git a/collectors/timex.plugin/README.md b/collectors/timex.plugin/README.md new file mode 120000 index 000000000..89c1bd0d4 --- /dev/null +++ b/collectors/timex.plugin/README.md @@ -0,0 +1 @@ +integrations/timex.md \ No newline at end of file diff --git a/collectors/timex.plugin/integrations/timex.md b/collectors/timex.plugin/integrations/timex.md new file mode 100644 index 000000000..80d77bc8f --- /dev/null +++ b/collectors/timex.plugin/integrations/timex.md @@ -0,0 +1,142 @@ + + +# Timex + + + + + +Plugin: timex.plugin +Module: timex.plugin + + + +## Overview + +Examine Timex metrics to gain insights into system clock operations. Study time sync status, clock drift, and adjustments to ensure accurate system timekeeping. + +It uses system call adjtimex on Linux and ntp_adjtime on FreeBSD or Mac to monitor the system kernel clock synchronization state. + +This collector is supported on all platforms. + +This collector supports collecting metrics from multiple instances of this integration, including remote instances. + + +### Default Behavior + +#### Auto-Detection + +This integration doesn't support auto-detection. + +#### Limits + +The default configuration for this integration does not impose any limits on data collection. + +#### Performance Impact + +The default configuration for this integration is not expected to impose a significant performance impact on the system. + + +## Metrics + +Metrics grouped by *scope*. + +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. + + + +### Per Timex instance + +These metrics refer to the entire monitored application. + +This scope has no labels. + +Metrics: + +| Metric | Dimensions | Unit | +|:------|:----------|:----| +| system.clock_sync_state | state | state | +| system.clock_status | unsync, clockerr | status | +| system.clock_sync_offset | offset | milliseconds | + + + +## Alerts + + +The following alerts are available: + +| Alert name | On metric | Description | +|:------------|:----------|:------------| +| [ system_clock_sync_state ](https://github.com/netdata/netdata/blob/master/health/health.d/timex.conf) | system.clock_sync_state | when set to 0, the system kernel believes the system clock is not properly synchronized to a reliable server | + + +## Setup + +### Prerequisites + +No action required. + +### Configuration + +#### File + +The configuration file name for this integration is `netdata.conf`. +Configuration for this specific integration is located in the `[plugin:timex]` section within that file. + +The file format is a modified INI syntax. The general structure is: + +```ini +[section1] + option1 = some value + option2 = some other value + +[section2] + option3 = some third value +``` +You can edit the configuration file using the `edit-config` script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). + +```bash +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata +sudo ./edit-config netdata.conf +``` +#### Options + +At least one option ('clock synchronization state', 'time offset') needs to be enabled for this collector to run. + +
Config options + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| update every | Data collection frequency. | 1 | False | +| clock synchronization state | Make chart showing system clock synchronization state. | yes | True | +| time offset | Make chart showing computed time offset between local system and reference clock | yes | True | + +
+ +#### Examples + +##### Basic + +A basic configuration example. + +
Config + +```yaml +[plugin:timex] + update every = 1 + clock synchronization state = yes + time offset = yes + +``` +
+ + -- cgit v1.2.3