Product Analytics for Cisco Catalyst 9000 Series switches

This document provides information about the Product Analytics feature for Cisco Catalyst 9000 Series switches.

Product Analytics refers to the collection of product telemetry such as product performance and resource usage information directly from the IOS-XE-based switches platforms.

This functionality is available from Cisco IOS XE 17.18.1 release onwards and is enabled by default when you start your device.

By default, there is a grace period of 7 days where no data is collected. No reports are generated during this time. After this period, the collection of device data starts, and a report is generated based on the reporting policy. This report is sent to Cisco SSM through direct connection or through non-direct modes (SSM On-Prem, CSLU, and Offline). The product analytics report is then included in the Smart Licensing RUM report, where you can view the report data.

 Note

If you reload the device before the seven days grace period, the timer for grace period restarts from the time of boot. Seven days from this restart time, product analytics data is collected.

Benefits

This list outlines the benefits of using the Product Analytics functionality for your switches.

  • Collecting data through Product Analytics enables you to have a better vision of product performance and feature consumption.
  • The data insights offered through this feature allows you to proactively choose a dynamic licensing system best suited for your needs.

Key performance index

You can use the Product Analytics feature to collect and view a report of all the Key Performance Index (KPI)s listed here:

  • hardware_inventory
  • optics_modules
  • stack_members
  • ha_stackwise_virtual
  • persistent_poe
  • fast_poe
  • ospf
  • ospf_v3
  • bgp_ipv4
  • eigrp_ipv4
  • dhcpv4_support
  • dhcpv6_support
  • domain_name_server
  • qos_enabled
  • security_aaa
  • security_acl_ipv4
  • security_acl_ipv6
  • ntp_configured
  • tunnel_gre
  • prog_grpc
  • prog_netconf
  • prog_restconf
  • bonjour_mdns_discovery
  • bonjour_mdns_wide_area
  • lisp_config
  • lisp_extranet
  • lisp_intf
  • lisp_l2_intf
  • lisp_silent_host_detection

Platforms supported

The Product Analytics feature is supported in the platforms listed in this section.

  • Cisco Catalyst 9300, 9300X, and 9300L Switches
  • Cisco Catalyst 9400 and 9400X Switches
  • Cisco Catalyst 9500, 9500H, and 9500X Switches
  • Cisco Catalyst 9600 and 9600X Switches

How Product Analytics works

The Product Analytics architecture is driven by an policy with a product analytics engine that automates data capturing from various data sources.

Summary

The key components of this architecture include:

  • Data Sources: These are the data sources on which we can enable capture points for the purpose of tracking data for KPI computation.
  • Normalization: This component acts as an intermediate format to ensure neither the data nor the KPI computation know about the source of data. Normalization is applied to data coming from each data source to translate source specific data format and semantic to an intermediate representation, which is common to all data sources. JSON with a specific schema has been chosen as an intermediate representation.
  • Data Store: The component from which data is sourced for analysis. The data store provides efficient retrieval and combining of data to facilitate the KPI computation. The store tracks raw data from data sources during an observation period, for example, 1 day. The observation period data is kept in an off-memory store and reflects observed data at the time of the data source capture: periodically or on-change.
  • Dynamic KPI Generator: These are the run time components for the evaluation of KPIs based on the normalized data.
  • Report Generator: This component collects KPIs into a report at the end of each observation period, stores it in TDL format, and prepares it for transmission via various channels.
  • Channel Selector: This component chooses the communication channel to export the KPI report.
  • Policy: A Policy defines the telemetry attributes (KPIs) to be collected, the data source of the telemetry attributes, the data collection and pre-processing rules, and the data collection and reporting interval. This component manages the reporting policy for a device, as per the reporting policy you have chosen. This component notifies components about new policy items, and allows each component to define and evolve its relevant parameters.

Workflow

The Product Analytics architecture captures automated data from different types of data sources and normalizes this data. Relevant data is kept in a common store, which allows efficient retrieval. It also allows for combination of data to produce valuable business KPIs.

The KPI engines leverage the tracked data to compute relevant KPIs for the IOS-XE device at run time. The report generator then collects these KPIs to formulate this into a consumable report. Reports are available through the RUM reports and you can view the RUM reports and their status on your device using the appropriate show commands.

Depending on your deployment topology: connected or disconnected SSM On-Prem, CSLU utility, direct deployment, the RUM reports are generated, uploaded, and synchronized manually or automatically.

At the end of the observation period, the store discards the data and starts a new observation period.

Prerquisites

To use the Product Analytics functionality for your device, the criteria mentioned in this list should be fulfilled.

  • License boot level must be configured with at least network-essentials
  • Your device must run on Cisco IOS-XE release 17.18.1 release at a minimum.
  • The configurations mentioned in this list must be enabled:
    • license smart url smart <smart-license-URL>
    • license smart transport smart
    • license smart vrf <vrf-name> (If WAN intf is attached to vrf)
    • ip name-server [vrf <vrf-name>] <dns-server-ip>
    • ip domain lookup [vrf <vrf-name>] source-interface <WAN-intf>
    • ip domain name cisco.com
    • license smart trust idtoken <smart-acount-generated-token> local force

Limitations

This list specifies the limitations and restrictions for the Product Analytics feature:

  • The Product Analytics feature is not supported for custom SLP reporting policies and by devices that have SLR or PLR enabled.
  • The Product Analytics feature does not work if Cisco SSM is disabled.
  • If trust is not established between your device and Cisco SSM, you will not be able to receive or access the Product Analytics report.
  • This feature is only supported on routing platforms running in autonomous mode. This feature is not supported for SD-Routing. For devices running in controller mode, or in autonomous mode with SD-Routing enabled, Product Analytics is not supported.

Enable Product Analytics

If your device supports this functionality and runs on Cisco IOS XE 17.18.1 version or later, by default, this functionality is enabled after the grace period. No action is required from your side.

After you boot your device for the first time, a grace period of seven days is provided, where no data is collected. The system displays a syslog message that this functionality will be enabled after seven days.

Here’s a sample of syslog message:

*Mar 11 17:26:38.306: %IOSXE_RP_PAE_NOT-4-PAE_STARTUP_DELAY: Product Analytics will start in 7 days, configure "no product-analytics" to disable

After the grace period ends, the system automatically generates a configuration in the device to collect the data for the device. The system displays a syslog message to indicate that the functionality is enabled.

Here’s a sample syslog message indicating that the Product Analytics feature is enabled for your device:

**Jan 31 15:34:15.334: %IOSXE_RP_PAE_NOT-6-PAE_STARTUP: Product Analytics is Enabled

Sample RUM report

The Product Analytics telemetry report contains the summary of all the KPIs you have chosen in the interval configured as per the policy you’ve applied.

Device# show license rum id all                        
Smart Licensing Usage Report:
====================================
Report Id,          State,    Flag, Feature Name
1742394820          ACK       N     network-advantage
1742394821          ACK       N     dna-advantage
1742394822          ACK       N     network-advantage
1742394823          ACK       N     dna-advantage
1742394824          ACK       N     network-advantage
1742394825          ACK       N     dna-advantage
1742394826          OPEN      N     network-advantage
1742394827          OPEN      N     dna-advantage
1742394828          OPEN      N     TELEMETRY

Note that the status of the latest telemetry is OPEN. This indicates that the report is still stored in the local device and has not yet been sent out.

 Note

If the status of the latest telemetry is DELETED, this indicates that the report is not available in the device and has moved to Cisco SSM.

To view the content of your Product Analytics report on your device, run the test license smart telemetry show command. Here is a sample report that you can generate by running this show command.
{"version":"2.0","asset_identification":{"report_id":1742394828,"asset":{"name":"regid.2017-05.com.cisco.C9400,v1_ad928212-d182-407e-ac85-29e213602efa"},"instance":{"sudi":{"udi_pid":"C9404R","udi_serial_number":"FXS2147Q07V"},"product_instance_identifier":"f0d8714d-3420-4795-b81c-a78646e33919"}},"meta":{"report_type":"telemetry","utility_enabled":false,"ha_udi":[{"role":"Active","sudi":{"udi_pid":"C9404R","udi_serial_number":"FXS2147Q07V"}}]},"measurements":[{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"Telemetry Meta Info","values":[{"type":"report_id","value":"1742397378"},{"type":"policy_version","value":"17.18.1"},{"type":"engine_version","value":"17.18.1"},{"type":"policy_file_version","value":"1"},{"type":"timezone","value":"0"},{"type":"software_version","value":"17.18.01.0.218207.1742173349..IOSXE"},{"type":"serial_num","value":"FXS2147Q07V"},{"type":"product_id","value":"C9404R"},{"type":"vendor_id","value":"V02"},{"type":"metadata","value":""}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"ospf","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"ospf_v3","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"bgp_ipv4","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"fast_poe","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"lisp_intf","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"prog_grpc","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"eigrp_ipv4","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"lisp_config","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"qos_enabled","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"lisp_l2_intf","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"prog_netconf","values":[{"type":"json_encode","value":"[{\"enabled\":\"true\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"security_aaa","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"lisp_extranet","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"prog_restconf","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"stack_members","values":[{"type":"json_encode","value":"[{\"member_cnt\":0}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"dhcpv4_support","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"dhcpv6_support","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"ntp_configured","values":[{"type":"json_encode","value":"[{\"enabled\":\"true\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"optics_modules","values":[{"type":"json_encode","value":"[{\"PID\":\"GLC-SX-MMD\",\"COUNT\":1}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"persistent_poe","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"security_acl_ipv4","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"security_acl_ipv6","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"domain_name_server","values":[{"type":"json_encode","value":"[{\"enabled\":\"true\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"hardware_inventory","values":[{"type":"json_encode","value":"[{\"CN\":\"Chassis\",\"SN\":\"FXS2147Q07V\",\"PID\":\"C9404R\"},{\"CN\":\"FanTray\",\"SN\":\"FXS2146Q25Q\",\"PID\":\"C9404-FAN\"},{\"CN\":\"Slot 1 Linecard\",\"SN\":\"JAE22030FDQ\",\"PID\":\"C9400-LC-48U\"},{\"CN\":\"Slot 4 Linecard\",\"SN\":\"JAE2139034N\",\"PID\":\"C9400-LC-48S\"},{\"CN\":\"Slot 2 Supervisor\",\"SN\":\"JAE22230AN2\",\"PID\":\"C9400-SUP-1XL\"},{\"CN\":\"Slot 3 Supervisor\",\"SN\":\"JAE222104G3\",\"PID\":\"C9400-SUP-1XL\"},{\"CN\":\"PowerSupplyModule1\",\"SN\":\"DTM214001S5\",\"PID\":\"C9400-PWR-3200AC\"},{\"CN\":\"PowerSupplyModule2\",\"SN\":\"DTM2152012Q\",\"PID\":\"C9400-PWR-2100AC\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"ha_stackwise_virtual","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"bonjour_mdns_discovery","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"bonjour_mdns_wide_area","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"lisp_silent_host_detection","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598},{"start_time":1742397136,"end_time":1742397378,"meta":[{"type":"report_id","value":"1742397378"}],"metric_name":"virtual_routing_forwarding","values":[{"type":"json_encode","value":"[{\"enabled\":\"false\"}]"}],"log_time":1742397598}]}

Verify Product Analytics enablement

To verify whether Product Analytics is enabled for your device, perform this task.

Step 1

Run the show license summary command to verify whether Product Analytics is available.

Step 2

Run the show product-analytics report summary command to view the details about the report.

Example:

9300L#show product-analytics report summary
Product Analytics Engine Reports
Report ID                   Policy Version   
--------------------------- ---------------- 
1742489306                   17.18.1

View Smart License usage interval

Perform these steps in the device CLI to learn how to change the RUM report interval for your device’s Smart License.

The Product Analytics report is generated every 30 days internally and this interval cannot be changed as it is defined in the built-in SQL profile. Smart license receives and stores the telemetry of the Product Analytics report and sends a RUM report including telemetry of the Product Analytics report every 30 days.

Step 1

Run the enable command.

Example:

Device > enable

Enters the privileged EXEC mode.

Step 2

Run the configure terminal command.

Example:

Device# configure terminal

Enters the configure terminal mode.

Step 3

Run the license smart usage interval command to view the interval in which the Product Analytics report is sent. By default, the usage interval is 30 days. You cannot modify this value and change the license usage interval.

Disable Product Analytics

Perform this task to disable the Product Analytics feature on your device.

Run the no product-analytics command.

Example:

Device# no product-analytics