NTP Platform Service

Topics marked with * relate to features available only in vFabric Hyperic.

Monitor a Remote NTP Server

You can configure a platform service of type "NTP" to report the availability of a remote Network Time Protocol (NTP) server.

Resource Plugin, Functions, and Classes

The NTP platform service type is managed by HQ's netservices plugin and performs the following functions:

  • Metric collection using the org.hyperic.hq.plugin.netservices.NTPCollector. class.

  • Event tracking using the reportEvent method in the Collector class.

Configure the NTP Service in HQ

You manually configure a NTP service on operating system platform types.

  1. Navigate to the platform whose Agent will monitor the service.

  2. Select New Platform Service from the Tools menu.

  3. On New Service page, enter a name for the service and select "NTP" from the Service Type pull-down.

  4. Supply all required values on the Configuration Properties page. Configuration options are defined below in NTP Configuration Options.

Configuration Properties Page

The Configuration Properties page for the NTP platform service type type is shown below.

images/download/attachments/79038211/NTPConfigOptions.png

NTP Configuration Options

The tables below document the options in the configuration schema for the POP3 service type.

Note:

  • The default value of port is set to 123 by a property in the netservices plugin descriptor.

<option> name

description

default

optional

type

Notes

Parent Schema

hostname

Hostname

localhost

false

Hostname of system that hosts the service to monitor. For example: mysite.com

sockaddr

port

Port

A default value for port is usually set for each type of network service by properties in the netservices plugin descriptor.

false

Port where service listens.

sockaddr

sotimeout

Socket Timeout (in seconds)

10

true

int

The maximum amount of time the agent will wait for a response to a request to the remote service.

sockaddr

Metrics

  • Availability - A NTP service is considered available if the connection to the NTP server succeeds.

  • Local Clock Offset - The difference in time between the local clock and the reference clock.

  • Response Time - The time it took to determine service availability.

  • Round Trip Delay - The delay for a message launched to arrive at the configured reference clock at a specific time. Measured in seconds with a fraction point between bits 15 and 16. May take positive or negative value, depending on the relative time and frequency offsets. Normal values range from negative values of a few milliseconds to positive values of several hundred milliseconds.

  • Root Delay - The delay for a message launched to arrive at the primary reference source at the root of the NTP subnet. Measured in seconds with fraction point between bits 15 and 16. May take positive or negative value, depending on the relative time and frequency offsets. Normal values range from negative values of a few milliseconds to positive values of several hundred milliseconds.

  • Root Dispersion - Maximum error relative to the primary reference source at the root of the NTP subnet. Measures all the errors associated with the network hops and servers between client and the reference source, in seconds.

NTP Monitoring Defaults Page

You can enable and disable metrics, select indicator metrics, and change the collection interval for a resource type on its Monitoring Defaults page. To navigate to a resource type's Monitoring Defaults page:

  1. Click the Administration tab.

  2. Click Monitoring Defaults.

  3. Scroll down to the resource type and click Edit Metric Template.

The Monitoring Defaults page for the NTP platform service type type is shown below:

images/download/attachments/79038211/NTPMetric.png

Event Tracking

You can enable log tracking for a network service. If you do, the agent will log an event for responses that match the criteria you specify.

To enable log tracking, click the Enable Log Tracking box in the Monitoring section of the Configuration Properties page.

For information about HQ log tracking functionality and configuration options, and how to view log events, see Set Up Log Tracking for a Resource.