Networking UFM Telemetry Documentation

Events

The following sections describe the supported configurations for enabling section collection.

Enable PPCC

To enable PPCC, set the following parameter:

plugin_env_CLX_EXPORT_API_DISABLE_PPCCINFO=0

The following events are created:

  • ppcc_algo_config

  • ppcc_algo_config_params

  • ppcc_algo_config_support

  • ppcc_algo_counters

  • ppcc_general_settings

  • ppcc_rp_params

  • ppcc_np_params

  • ppcc_stats_query

Switch Temperature Data

To enable switch temperature data, make sure the following line is present and not commented out:

arg_x= --get_phy_info --enabled_regs mtmp #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Switch Fan Data

To enable switch fan data, make sure the following line is present and not commented out:

arg_x= --get_phy_info --enabled_regs mfsm #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Switch General Data

To enable switch general data, make sure the following line is present and not commented out:

arg_x= --get_phy_info --enabled_regs msgi #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Switch Network Data

To enable switch network data, make sure the following line is present and not commented out:

arg_x= --get_sw_net_info #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Switch Power Sensors Data

To enable switch power sensors data, make sure the following line is present and not commented out:

arg_x= --get_phy_info --enabled_regs mvcr #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Switch Power Supplies Data

To enable switch power supplies data, make sure the following line is present and not commented out:

arg_x= --get_phy_info --enabled_regs msps #  x should be replaced with the next available index!

Verify that the following line either doesn't exist or is set to 0:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0

Managed Switch Data Collection

Prerequisite: You need access to a UFM that runs the sysinfo plugin. The following parameters are required to enable the collection.

To enable the feature, set the following parameters:

plugin_env_CLX_EXPORT_API_DISABLE_SWITCHINFO=0
plugin_env_CLX_EXPORT_API_DISABLE_MANAGED_SWITCHINFO=0 

Set the UFM endpoint:

plugin_env_MANAGED_SWITCH_DATA_EP=https://localhost/ufmRest/plugin/sysinfo/query 

Set the UFM token:

plugin_env_CLX_UFM_TOKEN=YWRtaW46MTIzNDU2 

The UFM Telemetry server endpoint must be the same as the PROMETHEUS_ENDPOINT

plugin_env_CLX_EXPORT_API_MANAGED_SWITCH_CB_EP=http://localhost:1234/management/key_value 

The following parameters are optional:

  • The list of managed switches to sample. By default, UFM Telemetry samples all managed switches on the fabric, as defined by the sysinfo plugin:

    plugin_env_CLX_EXPORT_API_MANAGED_SWITCH_LIST=11.222.33.44,11.333.444.55 
    
  • sample_rate of managed_switches(seconds) should not be set faster than the switch collection sample rate. The default is 10 minutes.

    plugin_env_CLX_EXPORT_API_MANAGED_SWITCH_INTERVAL=600 
    

Cable Info

To enable cable information collection, add the following configuration:

plugin_env_CLX_EXPORT_API_DISABLE_CABLEINFO=0

PCI Info

To enable PCI information collection, add the following configuration:

The arg key name might differ.

plugin_env_CLX_EXPORT_API_DISABLE_PCIINFO=0
arg_pci_info=--get_phy_info --enabled_regs mpein,ptas,ppll,mtmp,mvcr,msgi,mpcnt_pci_cnt,mpcnt_pci_timers,mpcnt_pci_lcnt

You must also collect the following sections: General Info and PHY Counters.

To enable NVLink information collection, add the following configuration:

The arg key name might differ.

arg_nvlink_info=--nvlink --qos --get_phy_info --enabled_regs ppcnt_ptc
plugin_env_CLX_EXPORT_API_DISABLE_NVLINKINFO=0

Last updated: