Docs » Configure application receivers » Configure application receivers for networks » NTP receiver

NTP receiver 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the ntp monitor type by using the SignalFx Smart Agent Receiver.

Use the NTP receiver to retrieve clock offset from an NTP server. The receiver enforces a minimum interval of 30 minutes.

This receiver is available on Linux and Windows.

Benefits 🔗

After you’ve configured the integration, you can:

  • View metrics using the built-in dashboard. For information about dashboards, see View dashboards in Observability Cloud.

  • View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.

  • Access Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy the integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the next section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver lets you use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your configuration file:

receivers:
  smartagent/ntp:
    type: ntp
    ... # Additional config

To complete the receiver activation, you must also include the receiver in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/ntp]

Configuration settings 🔗

The following table shows the configuration options for the ntp receiver:

Option Required Type Description
host yes string The host or IP address of the NTP server. For example, pool.ntp.org.
port no integer The port of the NTP server. Default is 123.
version no integer NTP protocol version. Default is 4.
timeout no int64 Timeout in seconds for the request. Default is 5s.

Metrics 🔗

The following metrics are available for this integration:

Non-default metrics (version 4.7.0+) 🔗

To emit metrics that are not default, you can add those metrics in the generic receiver-level extraMetrics config option. You don’t need to add to extraMetrics any metric derived from specific options that don’t appear in the list of metrics.

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

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud:

  • Ask questions and get answers through community support at Splunk Answers.

  • If you have a support contract, file a case using the Splunk Support Portal. See Support and Services.

  • To get professional help with optimizing your Splunk software investment, see Splunk Services.