Statistics data retrieval with registerLogToFile and find/findToFile

Overview

It is recommended to use the registerLogToFile method for ongoing statistics retrieval, especially in an environment where a large number of statistics are to be collected; the find and findToFile methods are not recommended in networks with high statistics collection rates. See Chapter 14, Accounting, performance, and flow monitoring and the NSP Planning Guide for information about statistics collection using the XML API. See Statistics retrieval using registerLogToFile for specific information about using the registerLogToFile method.

An accounting or performance statistics file is specific to a statistics class, and is stored in a specified directory on an NFM-P server. When a file is created and ready for retrieval, the NFM-P sends a LogFileAvailableEvent. A file generated using the method is deleted after 20 minutes by default. You must ensure that adequate file space is available for the generated files, which may be deleted earlier if space is not available.

By default, JMS client inactivity checking is enabled, and a registration is removed after 15 minutes if the associated JMS client is disconnected. If a prolonged OSS outage is expected, you can modify the client timeout accordingly. For example, before an OSS upgrade, it is recommended to increase the timeout so that statistics files continue to be generated during the outage associated with the upgrade. See Statistics retrieval using registerLogToFile for configuration information.

A JMS subscription is optional when using the registerLogToFile method. To avoid registerLogToFile client deregistration because of JMS client inactivity, you can disable the JMS client inactivity check. In such a scenario, the registering application is responsible for ensuring that JMS clients are deregistered as required in order to allow the NFM-P to reclaim resources. See To configure the registerLogToFile or registerSasLogToFile client inactivity check for configuration information.

Note: The find and findToFile methods are not recommended as a means to recover from prolonged outages.

The find and findToFile methods can be used to retrieve specific statistics on demand, for example, during troubleshooting when statistics matching a set of criteria from a certain time are required. It is recommended that OSS clients avoid invoking find/findToFile frequently without filters or result filters.

The find and findToFile methods are subject to performance limitations in NFM-P deployments that include an auxiliary database. Specifically, if the results contain data from children classes, responses can take up to 20 times longer than in a similarly sized NFM-P environment that does not include an auxiliary database.

Delays may be minimized in the following ways:

Use the <children/> resultFilter expression to explicitly exclude child class data, which is often not the target of interest.
Create request filters that reduce the overall number of objects returned. For Statistics and OAM test results, use timeCaptured to limit the amount of logRecords for retrieval. Multiple timestamps are provided by statistic log records. The NFM-P optimizes the filtering based on timeCaptured, so timeCaptured should be used for find and findToFile queries filtering on time.
Create requests that target the child class directly, where data may be retrieved without explicit association to the parent object.

See Statistics filtering for result filter and request filter information.

Use subject to agreed restrictions on disclosure and use.