Documentation forAppOptics

NTPQ

Overview

This integration collects standard query metrics from NTPQ.

This integration is currently available for Linux platforms.

This integration was updated to V2 plugin framework. If you are still using depreciated way of configuring it, please refer to old documentation.

Setup

The ntpq monitoring is accomplished by bridge plugin which is included with the SolarWinds Snap Agent by default. Please follow the directions below to enable it for a agent instance. The bridge plugin utilize Telegraf NTPQ plugin.

Prerequisites

This plugin requires that the ntp daemon is installed and running. Verify you have the package installed, and that the service is queryable.

Copy
$ sudo apt-get install ntp

 

Copy
$ sudo ntpq -p

Configuration

The agent provides an example task file to help you get started quickly, but requires you to provide the correct settings for your NTPQ installation. To enable the task:

  1. Make a copy of the ntpq example task file /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-ntpq.yaml.example, renaming it to /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-ntpq.yaml:

    Copy
    $ sudo cp /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-ntpq.yaml.example /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-ntpq.yaml
  2. Edit the task file with settings specific to your NTPQ install:

    Copy
    ---
    version: 2

    schedule:
      type: cron
      interval: "0 * * * * *"
      
    plugins:
      - plugin_name: bridge
      
        config:
          ntpq:
            ## If false, set the -n ntpq flag. Can reduce metric gather time. (default=false)
            # dns_lookup: true
            
        publish:
          - plugin_name: publisher-appoptics
  3. Restart the agent:

    Copy
    $ sudo service swisnapd restart
  4. Enable the NTPQ integration in AppOptics

On the Integrations Page you will see NTPQ integration available if the previous steps were successful. It may take a couple minutes before the NTPQ integration is identified. Select the NTPQ integration to open the configuration menu in the UI, and enable it. If you do not see it, see Troubleshooting Linux..

Testing Integration

To check if and what metrics can be collected with given configuration, run bridge plugin in debug mode:

Copy
$ /opt/SolarWinds/Snap/bin/snap-plugin-collector-bridge --debug-mode --plugin-config "{\"ntpq\": {}}"

Metrics and Tags

The table below lists each of the metrics gathered from the status endpoint.

Metrics

Name Description
ntpq.delay Round trip communication delay to the remote peer or server (milliseconds)
ntpq.jitter Mean deviation (jitter) in the time reported for that remote peer or server (milliseconds);
ntpq.offset Mean offset (phase) in the times reported between this local host and the remote peer or server (milliseconds)
ntpq.poll Polling frequency (seconds)
ntpq.reach An 8-bit left-shift shift register value recording polls (bit set = successful, bit reset = fail)
ntpq.when When last polled (seconds)

Tags

Name Description
remote The remote peer or server being synced to. LOCAL is this local host (included in case there are no remote peers or servers available)
refid Where or what the remote peer or server is itself synchronised to
stratum The remote peer or server Stratum
type Type (u: unicast or manycast client, b: broadcast or multicast client, l: local reference clock, s: symmetric peer, A: manycast server, B: broadcast server, M: multicast server)

When the APM Integrated Experience is enabled, AppOptics shares a common navigation and settings with the other integrated experiences' products. How you navigate AppOptics and access its features may vary from these instructions. For more information, go to the APM Integrated Experience documentation.

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.