WMI tutorial - metric metadata
With just the data source present in the extension, metric collection is rather raw: all metrics are referenced by key and everything appears without any measurement unit, which can make it confusing.
metrics section of the extension is there to define additional metadata for metrics. We can define the following:
displayName- Human-readable name of metric
description- A description of what this metric actually represents
unit- Measurement unit of the metric
tags- How we can easily find this metric in the Metrics catalog
minValue- Tthe minimum possible value for the metric
maxValue- The maximum possible value for the metric
impactRelevant- Whether this metric depends on other metric anomalies to form the root cause of a Problem
rootCauseRelevant- Whether this metric on its own can be the root cause of a Problem
valueType- Whether high values are good (
score) or bad (
- Add the
metricssection to your
extension.yamlusing the template below.
- Define metadata for every metric collected.
- At minimum, define
- Package and upload a new version of your extension
- Validate metadata.
metrics: - key: custom.demo.host-observability.network.bytes.persec metadata: displayName: Traffic bytes/s description: Network traffic bytes per second unit: BytePerSecond # # add content here, for all other metrics #
For more information on the WMI data source syntax, see WMI data source reference.
You should now see the metadata reflected in the Metrics browser:
Next step: Custom topology