Project: Netdata (Observability and Analysis / Observability)
File: ntpd.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/ntpd/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/ntpd/metadata.yaml" sidebar_label: "NTPd" learn_status: "Published" learnrelpath: "Collecting Metrics/System Clock and NTP" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/ntp.png" width="150"/> Plugin: go.d.plugin Module: ntpd <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors the system variables of the local `ntpd` daemon (optional incl. variables of the polled peers) using the NTP Control Message Protocol via UDP socket, similar to `ntpq`, the . This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | ntpd.sys_offset | offset | milliseconds | | ntpd.sys_jitter | system, clock | milliseconds | | ntpd.sys_frequency | frequency | ppm | | ntpd.sys_wander | clock | ppm | | ntpd.sys_rootdelay | delay | milliseconds | | ntpd.sys_rootdisp | dispersion | milliseconds | | ntpd.sys_stratum | stratum | stratum | | ntpd.sys_tc | current, minimum | log2 | | ntpd.sys_precision | precision | log2 | These metrics refer to the NTPd peer. Labels: | Label | Description | |:--|:-| | peer_address | peer's source IP address | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | ntpd.peer_offset | offset | milliseconds | | ntpd.peer_delay | delay | milliseconds | | ntpd.peer_dispersion | dispersion | milliseconds | | ntpd.peer_jitter | jitter | milliseconds | | ntpd.peer_xleave | xleave | milliseconds | | ntpd.peer_rootdelay | rootdelay | milliseconds | |

| dispersion | milliseconds | | ntpd.peer_stratum | stratum | stratum | | ntpd.peer_hmode | hmode | hmode | | ntpd.peer_pmode | pmode | pmode | | ntpd.peer_hpoll | hpoll | log2 | | ntpd.peer_ppoll | ppoll | log2 | | ntpd.peer_precision | precision | log2 | There are no alerts configured by default for this integration. No action required. The configuration file name for this integration is `go.d/ntpd.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/ntpd.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | address | Server address in IP:PORT format. | 127.0.0.1:123 | yes | | timeout | Connection/read/write timeout. | 1 | no | | collect_peers | Determines whether peer metrics will be collected. | no | no | </details> A basic example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:123 ``` </details> Collect peers metrics. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:123 collect_peers: yes ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:123 name: remote address: 203.0.113.0:123 ``` </details> To troubleshoot issues with the `ntpd` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m ntpd ```