Statistics collection methods: Scheduled and on-demand statistics

Overview

You can collect statistics data using the following methods:

scheduled polls
non-scheduled (on-demand) collection

To schedule collection of statistics, certain policies are required to be configured. You can configure the following policy types for statistics collection:

accounting policy—specifies the accounting record type and collection interval
file policy—specifies the storage criteria for accounting statistics files on NEs
statistics policy—specifies the storage criteria for statistics in the NFM-P
MIB statistics policy—specifies the collection of MIB-based statistics counters from managed NEs, and is one of the following:
- NE MIB statistics policy—applies to all NE objects of the specified type
- specific MIB statistics policy—applies to a specific NE object
server performance statistics policy—specifies the collection criteria for statistics related to NFM-P server performance

The following table lists the policies required for each statistics type.

Table 14-1: Statistics policies

Statistics type	Policy
Statistics type	Accounting	File	Statistics	MIB statistics	Server performance statistics
Accounting service network subscriber AA	✓	✓	✓	—	—
Performance	—	—	✓	✓	—
Server performance	—	—	✓	—	✓

See the NSP NFM-P Statistics Management Guide for information about statistics collection.

See Chapter 15, Configuration management overview for information about configuration management. See Chapter 18, Policy configuration management for information about configuration of accounting and file policies.

Statistics log policy

The statistics log policy is used for specifying the retention period and alarm thresholds that are associated with a statistics log record.

To compose a modification command for the Statistics Policy, the key input parameters include:

method—generic.GenericObject.configureInstanceWithResult
class—package.ObjectStatsLogPolicy (for the example below, the package is bgp and the statistics log policy class is PeerStatsLogPolicy)
<distinguishedName>—logger:package.ObjectStats

The following figure shows a sample request to modify the administrative state, retention time, and threshold reporting state of the BGP peer statistics log policy.

Figure 14-1: Statistics log policy modification request example

<generic.GenericObject.configureInstanceWithResult xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <distinguishedName>logger:bgp.PeerStats</distinguishedName>

   <includeChildren>false</includeChildren>

   <configInfo>

      <bgp.PeerStatsLogPolicy>

         <actionMask>

            <bit>modify</bit>

         </actionMask>

         <administrativeState>down</administrativeState>

         <retentionTime>30</retentionTime>

         <thresholdReportingState>down</thresholdReportingState>

      </bgp.PeerStatsLogPolicy>

   </configInfo>

</generic.GenericObject.configureInstanceWithResult>

NE MIB statistics policy

The MIB statistics policy is used for specifying the administrative state, polling synchronization start time, and collection interval of performance statistics. A NE MIB entry policy applies to all objects on the NE that use the MIB entry.

To compose a modification command for the MIB statistics policy, the key input parameters include:

method—generic.GenericObject.configureInstanceWithResult
class—snmp.PollerPolicy
<distinguishedName>—pollerManager:statspolicy-${*id}:product-${productId}:version-${versionId}:oid-${mibEntityOid}

The following figure shows a sample request to modify the administrative state and polling interval of the BGP peer statistics.

Figure 14-2: ME MIB statistics policy modification request example

<generic.GenericObject.configureInstanceWithResult xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <distinguishedName>pollerManager:statspolicy-1:product-1:version-41:oid-.1.3.6.1.2.1.15.3.1</distinguishedName>

   <includeChildren>false</includeChildren>

   <configInfo>

      <snmp.PollerPolicy>

         <actionMask>

            <bit>modify</bit>

         </actionMask>

         <administrativeState>up</administrativeState>

         <pollingInterval>30minutes</pollingInterval>

      </snmp.PollerPolicy>

   </configInfo>

</generic.GenericObject.configureInstanceWithResult>

Specific MIB statistics policy

The specific MIB statistics policy is a MIB entry policy that applies only to the specified objects on the NE.

To compose a creation command for the specific MIB statistics policy, the key input parameters include:

method—generic.GenericObject.configureInstanceWithResult
class—snmp.SpecificStatsPollerPolicy
<distinguishedName>—pollerManager
<id> (optional)—if not specified, then it is automatically assigned
<monitoredClassName>—specify the class (in package.class format) for which to collect performance statistics
<monitoredObjects>—specify the object for which to collect performance statistics

The following figure shows a sample request to create a specific MIB statistics policy for a specific port.

Figure 14-3: Specific MIB statistics policy request creation example

<generic.GenericObject.configureInstanceWithResult xmlns="xmlapi_1.0">

   <deployer>immediate</deployer>

   <synchronousDeploy>true</synchronousDeploy>

   <distinguishedName>pollerManager</distinguishedName>

   <includeChildren>false</includeChildren>

   <configInfo>

      <snmp.SpecificStatsPollerPolicy>

         <actionMask>

            <bit>create</bit>

         </actionMask>

         <id>115</id>

         <monitoredClassName>equipment.PhysicalPort</monitoredClassName>

         <monitoredObjects>

            <pointer>network:198.51.100.47:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-1</pointer>

         </monitoredObjects>

      </snmp.SpecificStatsPollerPolicy>

   </configInfo>

</generic.GenericObject.configureInstanceWithResult>

To compose a modification command for the specific MIB statistics policy to enable the collection of specific MIB, see NE MIB statistics policy in this section. The following figure shows a distinguishedName example for modifying a MIB entry.

Figure 14-4: distinguishedName example, MIB entry modification request

<distinguishedName>pollerManager:statspolicy-115:product-1:version-41:oid-.1.3.6.1.2.1.15.3.1</distinguishedName>

On-demand statistics collection

Statistics can be collected on-demand. The MIB associated with the selected statistics type is polled and a new real-time current data object is brought into the system. The record type is on-demand, which indicates that the object is not collected using a collection policy. To compose the method for triggering an on-demand statistics collection, the key input parameters include:

method—generic.GenericObject.triggerCollect
<instanceNames>—the object instances (FDNs) on which to collect statistics. The example below is collecting statistics for a port.
<currentDataClasses>—the statistics current data classes for which to collect. The example below is collecting for the interface and interface additional statistics on a port.

You can list several instance names, but you must specify the current data class for each of the instances that contain the statistics to be collected. The following figure shows a sample on-demand statistics collection.

Figure 14-5: On-demand statistics collection request example

<generic.GenericObject.triggerCollect xmlns="xmlapi_1.0">

   <instanceNames>

      <string>network:IP_address:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-4</string>

   </instanceNames>

   <currentDataClasses>

      <string>equipment.InterfaceStats</string>

      <string>equipment.InterfaceAdditionalStats</string>

   </currentDataClasses>

</generic.GenericObject.triggerCollect>

For the equivalent behavior of the Collect button on the NFM-P GUI, you can specify one instance in the list with the corresponding data class in the second list. For the equivalent behavior of the Collect All button on the NFM-P GUI, you can specify all relevant instances in the list with all corresponding data classes in the second list. See “Workflow for viewing statistics” in the NSP NFM-P Statistics Management Guide for more information about how to use the Collect and Collect All buttons.

Note: If you initiate a non-scheduled collection using the generic.GenericObject.triggerCollect method, a new on-demand current data object might be created, or an on-demand current data object might be updated. When a statistic is first collected, there is an ObjectCreationEvent sent for the new current data record. When subsequent records are collected, the current data record is updated so an AttributeValueChangeEvent is sent. The XML API does not modify the scheduled current data object or create a new historical log record. On-demand statistics are propagated to the history as non-scheduled statistics and do not affect any scheduled statistics retrievals.

Use subject to agreed restrictions on disclosure and use.