How do I view historical LSP information?

Enabling historical data collection

NSP users can use REST APIs to view historical information for LSPs, including path history and statistics. To enable this functionality, the following APIs must be executed:

PATCH /sdn/api/v4/nsp/configuration/nrcp-historical

GET /sdn/api/v4/nsp/configuration/nrcp-historical

Once executed, historical LSP data is sent to the NSP and stored in a database. Additional APIs are then used to retrieve and display this data, as described below. Users can also configure data retention policies. For more information, see the Network Developer Portal.

Historical LSP path records

When historical data collection is enabled, NSP users can use REST APIs to view historical PCEP LSP (RSVP or SR-TE) path records. Changes to an LSPs path are published to the “nrcp.historicalrecord” Kafka topic, and are then consumed by the NSP and stored in the PostgreSQL database (by default). If an auxiliary database configuration is present in the nsp-config.yml file, installation scripts will detect this and instead store the historical data in the auxiliary database. This can be overruled by setting the app.auxdb_enabled parameter in the auxdb.conf file to false and restarting the NSP server. The auxdb.conf file is located at /opt/nsp/configure/config/ where the NSP historical application is deployed.

Note: For large networks, Nokia recommends that historical LSP data be sent to the auxiliary database.

To list all historical LSP path records, the following API must be executed:

GET /nrcp-historical/api/v1/lsp/paths

The maximum number of records that can be listed in single response is 5000. Paging and filtering parameters can be used to further refine your search.

Historical LSP statistics

When historical data collection is enabled, NSP users can use REST APIs to view historical PCE LSP (RSVP or SR-TE) statistics. In order for this to work, the LSPs must have Bandwidth Strategy Telemetry enabled via the path profile. Changes to an LSP's telemetry-based bandwidth or latency updates are published to the “nrcp.historicalrecord” Kafka topic, and are then consumed by the NSP and stored in the auxiliary database.

Note: Unlike historical LSP path records, historical LSP statistics must be stored in the auxiliary database - not the PostgreSQL database.

To retrieve aggregate historical LSP statistics, the following API must be executed:

GET /nrcp-historical/api/v1/lsp/stats/hourly

You can also retrieve aggregate daily, weekly, or monthly historical LSP path records. To change the aggregation flags in aggregation_rule_meta table, the following API must be executed:

PATCH /nrcp-historical/api/v1/aggregation-admin/rules/flags

Use subject to agreed restrictions on disclosure and use.