Statistics objects

Overview

The XML API uses the following objects to track statistics:

current data record—for the most recent performance statistics
log records—for historical accounting and performance statistics

Statistics collection on an object results in creation of many log records but only one current data record per monitored object.

Note: The current data records do not apply to accounting statistics.

Log records are maintained for scheduled and non-scheduled (on-demand) statistics. The XML API organizes statistics objects by package. For example, the bgp package defines the BGP statistics. The BGP peer statistics are tracked by the PeerStats class, which contains the current data record, and the PeerStatsLogRecord class, which contains the log record in the bgp package.

You must use the corresponding log record object to retrieve statistics for an object. The log records contain the following information:

time captured
monitored object identifier
relevant statistics

Scheduled and on-demand performance statistics use current data records. History is available for the scheduled polls using the LogRecord type. The data from the last scheduled poll is also stored using the LogRecord type. For example, if bgp.PeerStats are collected in a 5-minute polling interval, the scheduled polling creates a current data record and a log record. Historical statistics are not available for on-demand statistics.

The <objectFullName> of the scheduled current data starts with: logger:scheduled. The on-demand current data <objectFullName> starts with: logger:real-time. A historical log record is also created for the scheduled current data. See objectFullName element in Schema Reference for more information about the unique identifier of the instance of the object.

A policy is associated with each type of log record. You can use the log policy to modify the retention period and alarm thresholds that are associated with a log record. For example, you can modify the PeerStatsLogPolicy class to customize the log records that are collected for the BGP Peer Stats. The default settings generally provide appropriate values for the retention period and thresholds. It also contains methods to remove specified log records from the NFM-P database. See the XML API Reference for information about this method.

Use subject to agreed restrictions on disclosure and use.