How do I install telemetry artifacts?

Purpose

Use this procedure to install the custom resource (CR) and yang files required for telemetry collection.

Telemetry artifacts include vendor agnostic (va) CR bundles, telemetry yang files, and cut-through (ct) CR bundles. There is no dependency between the two types of CRs, and no requirement to install both. If the telemetry counters you need to collect are vendor agnostic, you can install only the va bundle.

Cut-through custom resources may have dependency on cut-through telemetry yang files. Before you install a cut-through CR bundle, verify the files in the telemetry yang collection to see if the counters you need are present in any yang file. If you are installing cut-through telemetry yang files and a cut-through CR bundle, the yang files must be installed first.

Nokia recommends that you only install the cut-through telemetry yang files required for your use cases.

Note: Cut-through telemetry types are for gNMI-capable devices only.

Steps
 
1 

Obtain any required vendor agnostic (va) CR bundles from the Nokia NSP software download site:

  1. Choose the release, Adaptors, and the adaptor type.

  2. The list of available downloads is displayed. Choose the zip file with va and cr in the filename, for example, nsp-telemetry-cr-va-sros-1.0.0-rel.10.zip

2 

Install the artifact bundle from the Artifacts, Artifact Bundles view; see “How do I install an artifact bundle?” in the NSP Network Automation Guide.

The telemetry types in the va bundle are now available in the Telemetry Statistic Search Tool.

3 

Use the Telemetry Statistic Search Tool to see if you have the telemetry types you need:

  1. Open the NSP Help Center. From the Help Center home screen, navigate to REFERENCE, Statistic Search, Telemetry Statistic Search.

  2. Enter search terms in the Counter Name field to filter on the counters you need.

    Enter additional filters as needed to narrow the search.

  3. Click on each row to see the Info panel. Verify whether the selected statistic is the one you need.

  4. If the telemetry types you need are found, this procedure is complete.

  5. If the telemetry type is not found, proceed to the next step.

4 

Perform the sequence in Step 1 to obtain any required telemetry yang files.

5 

Extract the files from the zip and look for the telemetry types:

  1. View the list of telemetry files. The filenames provide information about the telemetry types included in the file.

  2. Open the file and search for terms relevant to the counters you need. A counter, where present, will be found in a leaf element. A list of telemetry types is provided in the leaf.

  3. If you find a telemetry type you need, install the yang file using yang-file.bash; see “How do I manage MDM model definitions?” in the NSP System Administrator Guide.

6 

Obtain any required SR OS cut-through (ct) CR bundles from the Nokia Support Portal and install them from the Artifacts, Artifact Bundles view; see “How do I install an artifact bundle?” in the NSP Network Automation Guide.

Note: Cut-through telemetry types are for gNMI capable devices only.

7 

Open the Telemetry Statistic Search Tool and search for your desired telemetry types.

If you do not find the definition or mapping you require, or you need to augment an existing telemetry type, contact your Nokia service representative.

End of steps