When you want to specify which metrics you want to display on a visualization dashboard, there are specific naming conventions which must be followed to generate the output you require. The naming convention in place is designed to enable the use of regexp syntax to filter metrics. A metrics name is made up of categories and tags to determine the data which you want to output.

All metrics names are adjusted to lower case. Spaces in names are replaced with an underscore, for example "UDR Count" becomes "udr_count".

The name of a metric begins with the category, of which there are five: host, pico, service, custom and mim. Each category can be further defined with a subcategory, which is then followed by the name: <category>.<subcategory.subcategory>.metric_name

pico

The pico category, has one possible subcategory, which is jvm.  For example, pico.jvm.metaspace_usage, pico.jvm.thread_count

host

The host category has three possible subcategories:

host.compute, e g host.compute.cpu_usage, host.compute.load_average

host.network, e g host.network.rx_packets, host.network.tx_total_bytes

host.storage e g host.storage.disk_usage, host.storage.page_faults

service

The service category must be further defined by which service you want a metric to be shown: service.<service name>, e g  service.kafka

custom

Custom metrics are defined with a user specified name combined with the custom prefix: custom.<user_defined>  e g  custom.pcrf.policy_requests, custom.airline.fuel_consumption

This naming convention is used for metrics produced using the System Insight forwarding agent.

mim

The mim category must have a specific structure as shown below:

Examples of how to name a mim metric:

For a metric on the Outbound UDRs MIM value for an Analysis agent (a processing agent) in a real-time workflow, the metric name is: mim.realtime.processing.analysis.outbound_udrs

For a metric on the Inbound UDRs MIM value for an ECS collection agent in a batch workflow, the metric name is mim.batch.collection.ecs.inbound_udrs

The minimum specification for a mim metric is mim.batch.workflow or mim.realtime.workflow. These metrics names would provide output on all the MIM values generated in all the batch workflows or real-time workflows respectively.