Telemetry Configuration Guide for Cisco 8000 Series Routers, IOS XR Releases

PDF

Telemetry Configuration Guide for Cisco 8000 Series Routers, IOS XR Releases

gNMI internal path sharing

Want to summarize with AI?

Log in

Explains how gNMI subscriptions map to Telemetry Agent terminology and how the device shares eligible telemetry collection work.


Internal Path sharing in gNMI Subscribe Remote Procedure Calls (RPCs) is a capability that

  • enables a router to optimize resource usage by fetching data for common Internal Paths only once per sample interval when multiple gNMI Subscribe RPCs request overlapping telemetry data, and

  • in steady state, ensures that each client (collector) receives an identical snapshot of the requested data, except for any encoding differences required by their specific subscriptions.

Table 1. Feature History Table

Feature Name

Release Information

Feature Description

gNMI Internal Path sharing

Release 26.3.1

Introduced in this release on: Fixed Systems (8200 [ASIC: Q200, P100], 8700 [ASIC: P100, K100], 8010 [ASIC: A100]); Centralized Systems (8600 [ASIC:Q200]) ; Modular Systems (8800 [ASIC: Q100, Q200, P100])

The router now automatically detects duplicate Internal Paths that appear across different gNMI subscription lists and shares collection for those paths. This optimization reduces redundant processing and provides consistent data snapshots to collectors. No user configuration is necessary for this functionality.

This feature introduces these changes:

CLI:

  • show telemetry subscriptions [id <id> ] [detail | internal]

  • show telemetry destination endpoints [id <id> ] [detail | internal]

  • show telemetry collections [id <id> ] [detail | internal]


Internal Path sharing eligibility

Internal Path sharing occurs when a device shares data collection from an Internal Path once for multiple gNMI Subscribe Remote Procedure Calls (RPCs), increasing resource efficiency.

For an Internal Path to be shared, the eligibility criteria are:

  • The SubscriptionList mode is STREAM.

  • The data producer for the Internal Path is EDM.

  • The SubscriptionMode is SAMPLE or the SAMPLE collection instance of TARGET_DEFINED.

  • For a given Internal Path across subscriptions, the SubscriptionMode must match across Subscribe calls.

  • The sample_interval must match.

  • The Encoding must match.

  • The key-value filters must match.

  • The Path Target must match.

  • The updates_only must match.


View telemetry subscription, destination, and collection state

Use these commands to ensure telemetry subscriptions, destinations, and collections are functioning correctly by inspecting their configuration and internal state.

By default, each command shows a concise configuration view. The detail and internal options provide additional information, with internal focused on implementation behavior.

Before you begin

Follow these steps to verify telemetry subscription, destination, and collection state.

Procedure

  1. Use the show telemetry subscriptions detail command to verify subscription state, sensor groups, destinations, and associated collections.

    Router#show telemetry subscriptions detail
    Mon Sep  7 03:59:33.821 UTC
    Subscription: GNMI__13787445275569793446
    Subscription ID: 6
    -------------
      State: Active
      Collection Instances: 1
      Updates Only: False
    
      Sensor Groups:
      --------------
      ID: GNMI__13787445275569793446_0
        Submode:              SAMPLE
        Heartbeat Interval:   0 ms
        Sample Interval:      15000 ms
        Sensor Path:          Cisco-IOS-XR-shellutil-oper:system-time/uptime
        Sensor Path State:    Resolved
        Error:                
        Filter Keys:          
    
      Destinations:
      -------------
      99.99.1.2:53402                                                           
        Endpoint ID:                  2007
        Subscription:                 GNMI__13787445275569793446
        VRF:                          
        VRF ID:                       
        DSCP:                         Default
        Transport:                    gRPC
        Encoding:                     gNMI JSON IETF
        Compression:                  Gzip
        UDP MTU:                      0 (bytes)
        TLS:                          Enabled
        TLS Hostname:                 
        Initial Updates:              1/1
        State:                        Active
        Total Messages Sent:          8
        Total Bytes Sent:             770
        Pending Queue Memory:         0 (bytes)
        Pending Queue Messages:       0
        Pending On-change Messages:   0
        Processed On-change Messages: 0
        Last Message Send Time:       2026-09-07 03:59:22.434883 +0000
        Last gNMI Sync-response Time: 2026-09-07 03:57:52.434883 +0000
    
      99.99.1.2:53418                                                           
        Endpoint ID:                  2008
        Subscription:                 GNMI__13787445275569793446
        VRF:                          
        VRF ID:                       
        DSCP:                         Default
        Transport:                    gRPC
        Encoding:                     gNMI JSON IETF
        Compression:                  Gzip
        UDP MTU:                      0 (bytes)
        TLS:                          Enabled
        TLS Hostname:                 
        Initial Updates:              1/1
        State:                        Active
        Total Messages Sent:          8
        Total Bytes Sent:             770
        Pending Queue Memory:         0 (bytes)
        Pending Queue Messages:       0
        Pending On-change Messages:   0
        Processed On-change Messages: 0
        Last Message Send Time:       2026-09-07 03:59:22.435337 +0000
        Last gNMI Sync-response Time: 2026-09-07 03:57:53.822337 +0000
    
      Collection Instances:
      ---------------------
      ID: 9 
        Sensor Path:                  Cisco-IOS-XR-shellutil-oper:system-time/uptime
        Submode:                      SAMPLE
        Sample Interval:              15000 ms
        Completed Collections:        8
        Collection Elapsed Time:      Min: 3 ms Avg: 4 ms Max: 7 ms 
        Data Source Elapsed Time:     Min: 3 ms Avg: 3 ms Max: 7 ms
        Cadence Drift Elapsed Time:   Min: 0 ms Avg: 0 ms Max: 0 ms
        Scheduler Elapsed Time:       Min: 0 ms Avg: 0 ms Max: 0 ms
        Last Max Collection Time:     2026-09-07 03:57:53.822883 +0000
        Last Max Data Source Time:    2026-09-07 03:57:53.822883 +0000
        Last Collection Start Time:   2026-09-07 03:59:22.429883 +0000
        Last Collection End Time:     2026-09-07 03:59:22.435883 +0000
        Missed Collections:           0
        Last Missed Collection Time:
        Collection Splits:            0
        Last Collection Split Time:
        Subscription IDs:             6
        Creation Time:                2026-09-07 03:57:52.432883 +0000
    
        Destinations:
        -------------
        Endpoint ID: 2007
          Matching Leaves:                          
          Path Target:                              
          Encoding:                                 gNMI JSON IETF
          Join Time:                                2026-09-07 03:57:52.433175 +0000
          Initial Update Completion Time:           2026-09-07 03:57:52.436175 +0000
          Completed Collections:                    7
          Collection Elapsed Time:                  Min: 3 ms Avg: 4 ms Max: 6 ms 
          Last Collection Start Time:               2026-09-07 03:59:22.430175 +0000
          Last Collection End Time:                 2026-09-07 03:59:22.436175 +0000
          Data Source Items:                        7
          Data Source Filtered Items:               0
          Encoded Items:                            7
          Last Message Send Time:                   2026-09-07 03:59:22.436175 +0000
          Sent Messages:                            7
          Sent Bytes:                               770
          Dropped Messages:                         0
          Dropped Bytes:                            0
          Slow Endpoint:                            N
          Last Slow Endpoint Time:                  
          Last Slow Endpoint Clear Time:            
          Slow Endpoint Clears:                     0
          Scheduler Retries:                        0
          Consecutive In-time Collections:          7
          Slow Endpoint Collections:                0
          Endpoint Slowness Occurrences:            0
    
        Endpoint ID: 2008
          Matching Leaves:                          
          Path Target:                              
          Encoding:                                 gNMI JSON IETF
          Join Time:                                2026-09-07 03:57:52.433199 +0000
          Initial Update Completion Time:           2026-09-07 03:57:53.823199 +0000
          Completed Collections:                    7
          Collection Elapsed Time:                  Min: 3 ms Avg: 4 ms Max: 7 ms 
          Last Collection Start Time:               2026-09-07 03:59:22.430199 +0000
          Last Collection End Time:                 2026-09-07 03:59:22.436199 +0000
          Data Source Items:                        7
          Data Source Filtered Items:               0
          Encoded Items:                            7
          Last Message Send Time:                   2026-09-07 03:59:22.436199 +0000
          Sent Messages:                            7
          Sent Bytes:                               770
          Dropped Messages:                         0
          Dropped Bytes:                            0
          Slow Endpoint:                            N
          Last Slow Endpoint Time:                  
          Last Slow Endpoint Clear Time:            
          Slow Endpoint Clears:                     0
          Scheduler Retries:                        0
          Consecutive In-time Collections:          7
          Slow Endpoint Collections:                0
          Endpoint Slowness Occurrences:            0
    • If subscriptions display the same Collection Instance ID for an Internal Path, the device is sharing that Internal Path across the corresponding Subscribe RPCs.

    • If the Collection Instance IDs differ, the output does not indicate shared collection for that Internal Path.

  2. Use the show telemetry destination endpoints detail command to view the destination configuration and destination-specific behavior.

    Router#show telemetry destination endpoints detail 
    Fri Jul 10 08:38:17.857 UTC
    Destinations:
    -------------
    192.168.122.1:33284                                                       
      Endpoint ID:                  2002
      Subscription:                 GNMI__2005423308499225058
      VRF:                          
      VRF ID:                       
      DSCP:                         Default
      Transport:                    gRPC
      Encoding:                     gNMI JSON IETF
      Compression:                  Gzip
      UDP MTU:                      0 (bytes)
      TLS:                          Enabled
      TLS Hostname:                 
      Initial Updates:              6
      State:                        Active
      Total Messages Sent:          103
      Total Bytes Sent:             37580
      Pending Queue Memory:         0 (bytes)
      Pending Queue Messages:       0
      Pending On-change Messages:   0
      Processed On-change Messages: 0
      Last Message Send Time:       2026-07-10 08:38:12.672323 +0000
      Last gNMI Sync-response Time: 2026-07-10 08:38:12.672323 +0000
    
    192.168.122.1:33298                                                       
      Endpoint ID:                  2003
      Subscription:                 GNMI__2005423308499225058_0
      VRF:                          
      VRF ID:                       
      DSCP:                         Default
      Transport:                    gRPC
      Encoding:                     gNMI JSON IETF
      Compression:                  Gzip
      UDP MTU:                      0 (bytes)
      TLS:                          Enabled
      TLS Hostname:                 
      Initial Updates:              6
      State:                        Active
      Total Messages Sent:          103
      Total Bytes Sent:             37580
      Pending Queue Memory:         0 (bytes)
      Pending Queue Messages:       0
      Pending On-change Messages:   0
      Processed On-change Messages: 0
      Last Message Send Time:       2026-07-10 08:38:14.189349 +0000
      Last gNMI Sync-response Time: 2026-07-10 08:38:14.189349 +0000
  3. Use the show telemetry collections detail command to collect processing details, associated destinations, collection times, and sent packets or bytes.

    Router#show telemetry collections detail 
    Fri Jul 10 08:38:17.778 UTC
    Collection Instances:
    ---------------------
    ID: 7
      Sensor Path:                  openconfig-interfaces:interfaces/interface/state
      Submode:                      SAMPLE
      Sample Interval:              30000 ms
      Heartbeat Interval:           0 ms
      Completed Collections:        2
      Collection Elapsed Time:      Min: 3 ms Avg: 5 ms Max: 7 ms 
      Data Source Elapsed Time:     Min: 3 ms Avg: 3 ms Max: 3 ms
      Last Max Collection Time:     2026-07-10 08:38:13.177993 +0000
      Last Collection Start Time:   2026-07-10 08:38:13.174993 +0000
      Last Collection End Time:     2026-07-10 08:38:13.177993 +0000
      Missed Collections:           0
      Last Missed Collection Time:  
      Collection Splits:            0
      Last Collection Split Time:   
      Subscription IDs:             2, 3
      Creation Time:                2026-07-10 08:38:11.657993 +0000
    
      Destinations:
      -------------
      Endpoint ID: 2002
        Matching Leaves:                          
        Path Target:                              
        Encoding:                                 gNMI JSON IETF
        Join Time:                                2026-07-10 08:38:11.658646 +0000
        Initial Update Completion Time:           2026-07-10 08:38:11.665646 +0000
        Last Message Send Time:                   2026-07-10 08:38:11.665646 +0000
        Sent Messages:                            34
        Sent Bytes:                               18293
        Dropped Messages:                         0
        Dropped Bytes:                            0
        Slow Endpoint:                            N
        Last Slow Endpoint Time:                  
        Last Slow Endpoint Clear Time:            
        Slow Endpoint Clears:                     0
        Scheduler Retries:                        0
        Consecutive In-time Collections:          1
        Slow Endpoint Collections:                0
        Endpoint Slowness Occurrences:            0
    
      Endpoint ID: 2003
        Matching Leaves:                          
        Path Target:                              
        Encoding:                                 gNMI JSON IETF
        Join Time:                                2026-07-10 08:38:11.658666 +0000
        Initial Update Completion Time:           2026-07-10 08:38:13.178666 +0000
        Last Message Send Time:                   2026-07-10 08:38:13.178666 +0000
        Sent Messages:                            34
        Sent Bytes:                               18293
        Dropped Messages:                         0
        Dropped Bytes:                            0
        Slow Endpoint:                            N
        Last Slow Endpoint Time:                  
        Last Slow Endpoint Clear Time:            
        Slow Endpoint Clears:                     0
        Scheduler Retries:                        0
        Consecutive In-time Collections:          1
        Slow Endpoint Collections:                0
        Endpoint Slowness Occurrences:            0
    

    You can review whether the optimized sharing design is behaving as expected for subscriptions, destinations, and collections.

The relevant telemetry objects are visible in brief, detail, or internal form for troubleshooting and validation.