Skip to main content

Metric

A metric represents a single data value provided by a plugin, which will be monitored by the service.
Each metric must have a core or custom MetricType assigned. Additionally, every metric is always associated with a specific Category.

Properties

The following table outlines the properties of a metric:

PropertyTypeDescription
IdstringThe unique identifier of the metric.
LabelstringThe textual label representing the metric.
TypeIdstringThe type of this metric (corresponds to the ID of a registered MetricType).
CategoryIdstringThe category this metric belongs to (corresponds to the ID of a registered Category).
IsStaticboolIndicates whether the metric is static. A static metric has a fixed value that does not change.
Descriptionstring?An optional textual description providing additional details about the metric.
GroupIdstring?An optional group the metric is associated with (corresponds to the ID of a registered Group).