Metric structure

Typical structure of a metric that is used in a collection formula. A metric has these components. Metrics structure follows HOCON format, which is derived from JSON.

name

It is the normalized metric name for the same metric across all supported vendors. For example, the built-in metrics that are available in Technology Packs has the following structure:
<resource_group>-<metric_name>-<units>.metric
Note: All metrics must have an extension .metric.

description

Provide a simple description of what SNMP data that the metric returns. The data type for description is string.
Note: Description must be in double quotation marks.

units

Provide an applicable unit for the metric based on the information that it represents and its result. For example:
  • Number (count,type)
  • Percent
  • Bytes
  • Volt
  • Celsius
  • Milliseconds

aliases

An array of comma-separated vendor-specific formula names by which the metric can be identified. It must match the formula name that can be mapped to the metric name.

properties

This field can be left blank with open and closed braces.

Some examples of metrics are as follows:
  • Environment-Voltage-Level-Volts.metric
    
name=Environment.Voltage.Level.Volts
description="The voltage of entity"
units=volt
aliases=[CiscoDevice Voltage Level,Huawei Voltage Level]
properties={
}
  • CPU-Utilization-Percent.metric
    
name=CPU.Utilization.Percent
description="The percentage of CPU utilization"
units=Percent
aliases=[cpuBusy,JuniperERX CPU Utilization,JuniperChassis CPU Utilization avg last 5min,Huawei CPU Utilization,CiscoDevice System CPU Utilization CPM]
properties={
}
  • IP-Fragment-Failure-Count.metric
    
name=IP.Fragment.Failure.Count
description="The number of IP datagrams that is discarded because they needed to be fragmented at this entity but might not be."
units=Number
aliases=[RFCMIBII Fragmentation Failures]
properties={
}