ntpq and Thanos Integration

Input and output integration overview

The ntpq plugin collects standard metrics related to the Network Time Protocol (NTP) by executing the ntpq command. It gathers essential information about the synchronization state of the local machine with remote NTP servers, providing valuable insights into timekeeping accuracy and network performance.

This plugin sends metrics from Telegraf to Thanos using the Prometheus remote write protocol over HTTP, allowing efficient and scalable ingestion into Thanos Receive components.

Integration details

ntpq

The ntpq Telegraf plugin provides a way to gather metrics from the Network Time Protocol (NTP) by querying the NTP server using the ntpq executable. This plugin collects a variety of metrics related to the synchronization status with remote NTP servers, including delay, jitter, offset, polling frequency, and reachability. These metrics are crucial for understanding the performance and reliability of time synchronization efforts in systems that rely on accurate timekeeping. NTP plays a vital role in networked environments, enabling synchronized clocks across devices which is essential for logging, coordination of activities, and security protocols. Through this plugin, users can monitor the effectiveness of their time synchronization processes, making it easier to identify issues related to network delays or misconfigurations, thus ensuring that systems remain in sync and operate efficiently.

Thanos

Telegraf’s HTTP plugin can send metrics directly to Thanos via its Remote Write-compatible Receive component. By setting the data format to prometheusremotewrite, Telegraf can serialize metrics into the same protobuf-based format used by native Prometheus clients. This setup enables high-throughput, low-latency metric ingestion into Thanos, facilitating centralized observability at scale. It is particularly useful in hybrid environments where Telegraf is collecting metrics from systems outside Prometheus’ native reach, such as SNMP devices, Windows hosts, or custom apps, and streams them directly to Thanos for long-term storage and global querying.

Configuration

ntpq

[[inputs.ntpq]]
  ## Servers to query with ntpq.
  ## If no server is given, the local machine is queried.
  # servers = []

  ## If false, set the -n ntpq flag. Can reduce metric gather time.
  ## DEPRECATED since 1.24.0: add '-n' to 'options' instead to skip DNS lookup
  # dns_lookup = true

  ## Options to pass to the ntpq command.
  # options = "-p"

  ## Output format for the 'reach' field.
  ## Available values are
  ##   octal   --  output as is in octal representation e.g. 377 (default)
  ##   decimal --  convert value to decimal representation e.g. 371 -> 249
  ##   count   --  count the number of bits in the value. This represents
  ##               the number of successful reaches, e.g. 37 -> 5
  ##   ratio   --  output the ratio of successful attempts e.g. 37 -> 5/8 = 0.625
  # reach_format = "octal"

Thanos

[[outputs.http]]
  ## Thanos Receive endpoint for remote write
  url = "http://thanos-receive.example.com/api/v1/receive"

  ## HTTP method
  method = "POST"

  ## Data format set to Prometheus remote write
  data_format = "prometheusremotewrite"

  ## Optional headers (authorization, etc.)
  # [outputs.http.headers]
  #   Authorization = "Bearer YOUR_TOKEN"

  ## Optional TLS configuration
  # tls_ca = "/path/to/ca.pem"
  # tls_cert = "/path/to/cert.pem"
  # tls_key = "/path/to/key.pem"
  # insecure_skip_verify = false

  ## Request timeout
  timeout = "10s"

Input and output integration examples

ntpq

1. Network Time Monitoring Dashboard: Utilize the ntpq plugin to create a centralized monitoring dashboard for tracking the reliability and performance of network time synchronization across multiple servers. By visualizing metrics such as delay and jitter, system administrators can quickly identify which servers are providing accurate time versus those with significant latency issues, ensuring that all systems remain synchronized effectively.

2. Automated Alert System for Time Drift: Implement an automated alert system that leverages ntpq metrics to notify operations teams when time drift exceeds acceptable thresholds. By analyzing the offset and jitter values, the system can trigger alerts if any remote NTP server is out of sync, allowing for swift remediation actions to maintain time accuracy across critical infrastructure.

3. Comparative Analysis of Time Sources: Use the ntpq plugin to perform a comparative analysis of different NTP servers over time. By querying multiple NTP sources and monitoring their metrics, organizations can evaluate the performance and reliability of their time sources, making informed decisions about which NTP servers to configure as primary or secondary in their environments.

4. Historical Performance Tracking for NTP: Gather historical performance data on various NTP servers using the ntpq plugin, enabling long-term trend analysis for timekeeping accuracy. This can help organizations identify patterns or recurring issues related to specific servers, informing future decisions about infrastructure changes or adjustments related to time synchronization strategies.

Thanos

1. Agentless Cloud Monitoring: Deploy Telegraf agents across cloud VMs to collect system and application metrics, then stream them directly into Thanos using Remote Write. This provides centralized observability without requiring Prometheus nodes at each location.

2. Scalable Windows Host Monitoring: Use Telegraf on Windows machines to collect OS-level metrics and send them via Remote Write to Thanos Receive. This enables observability across heterogeneous environments with native Prometheus support only on Linux.

3. Cross-Region Metrics Federation: Telegraf agents in multiple geographic regions can push data to region-local Thanos Receivers using this plugin. From there, Thanos can deduplicate and query metrics globally, reducing latency and network egress costs.

4. Integrating Third-Party Data into Thanos: Collect metrics from custom telemetry sources such as REST APIs or proprietary logs using Telegraf inputs and forward them to Thanos via Remote Write. This brings non-native data into a Prometheus-compatible, long-term analytics pipeline.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.