Configuring Metrics Collection

The labels of each SMF metrics are classified into the following three categories:

  • Production

  • Debug

  • Granular

All the SMF application metrics are controlled through the CLI command for performance optimization.

To collect the necessary SMF metrics and labels, use the following sample configuration:

config 
   infra metrics verbose { service | protocol | load-balancer | application } [ level { debug | off | production | trace } | metrics metrics_name [ granular-labels label_name| level { debug | off | production | trace } | pod pod_name | level { debug | off | production | trace }  ] ] 
   end 

NOTES:

  • If the metrics verbosity is not configured, then the default verbosity level for pod type is as follows.

    • LoadBalancer = Production

    • Protocol = Trace

    • Service = Trace

    • Application = Debug

  • The order of the level for verbose metrics is in the following priority order:

    • metrics [ [metrics_name] level [production|debug|trace|off]: [Priority 1]

    • pod [[pod_Name]] level [ production | debug | trace | off]] [Priority 2]

    • level [production | debug | trace | off] [Priority 3]

  • infra metrics verbose { service | protocol | load-balancer | application } : Enable the metric collection. This configuration helps to collect the required application metrics and labels. By default, this command captures the debug labels of metrics.

  • level { debug | off | production | trace } : Specify the application metrics category to capture the required application metrics and labels.

    • debug : Capture all the labels that are classified as production and debug categories. This option is the default configuration.

    • off : Disable the application level metrics collection.

      For example, configuring the infra metrics verbose application smf_service_stats level off command disables the smf_service_stats application metrics.

    • production : Capture the labels that are classified as production category.

    • trace : This option is not supported for SMF application metrics. If this option is configured, the SMF treats this option as debug .

  • If production and debug classification is empty for a metrics, then all the labels except granular-labels (if configured) are classified as debug.

  • metrics metrics_name : Specify the metrics name to capture only the labels that correspond to the given metrics. The metric-level configuration takes precedence over the application-level configuration. If the metrics level is not configured, the labels are captured at the application level.

  • granular-labels : Capture only the granular labels. By default, this option is disabled.

    If a granular label is required for KPI, then that label must be configured. For example, to capture dnn labels of smf_service_stats metrics, you must configure the following CLI command:

    infra metrics verbose application metrics smf_service_stats level debug granular-labels [ dnn ]