Docs » Integrations Guide » Use the Smart Agent » Monitors » ntp

ntp 🔗

Monitor Type: ntp (Source)

Accepts Endpoints: No

Multiple Instances Allowed: Yes

Overview 🔗

This monitor will retrieve clock offset from ntp server.

It enforces a minimum interval of 30m.

Configuration 🔗

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: ntp
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
host yes string The host/ip address of the NTP server (i.e. pool.ntp.org).
port no integer The port of the NTP server. (default: 123)
version no integer NTP protocol version to. (default: 4)
timeout no int64 Timeout in seconds for the request. (default: 5s)

Metrics 🔗

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • ntp.offset_seconds (gauge)
    Time difference between local and NTP server clocks in seconds.

Non-default metrics (version 4.7.0+) 🔗

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Dimensions 🔗

The following dimensions may occur on metrics emitted by this monitor. Some dimensions may be specific to certain metrics.

Name Description
ntp NTP server used. Corresponds to configured host.