Skip to main content

Metric filters that can be specified as part of a specific metric.

Properties (9)

Property Type Default Required Description
allowAttributes⚓︎ string[] x x

Attribute allow list: if specified, only the attributes it names are published with the values of the metric - everything else is dropped. Every distinct combination of attribute values is a time series of its own, so this is the way to keep a metric to the dimensions that are actually needed.

An entry names an attribute by its flattened (dot-separated) name, or everything nested under it: "bounds" covers "bounds.left". An empty list publishes no attributes at all.

Can be specified for a single metric (publishingSettings), for all metrics (defaultPublishingSettings) and in a metric filter. The list of the most specific level that has one applies - a matching filter, then the metric, then the defaults; lists are not merged. Applies to the attributes of the metric values, not to the resource attributes.

attributes⚓︎ { complexLoad?: boolean; includesFrameCreation?: boolean; } & Record<string, any> x x

Matches the attributes attached to a metric value. Not all metrics have all attribute values.

attributeSettings⚓︎ { [x: string]: MetricAttributeSettings; } x x

Controls the publishing of specific attributes.

dropAttributes⚓︎ string[] x x

Attribute drop list: the attributes it names are never published with the values of the metric. Entries are matched like the ones of allowAttributes. The drop lists of all the levels add up (the defaults, the metric and a matching filter), and an attribute that is dropped stays dropped even if an allow list names it.

enabled⚓︎ boolean x x

Whether or not the value for the matching metric will be published.

name⚓︎ string x x

The name of the matched metric.

overrideDefaultFilters⚓︎ boolean false x

If true, this filter rule will be matched before any default filters provided by io.Connect. The default filters are usually meant filter out non-representative operations (e.g. partial workspace loads), but you can use this property to force them to be measured. If false, default filters will be matched before this filtering rule.

sample⚓︎ number | boolean true x

Defines sampling probability for the metric.

type⚓︎ MetricType x x

The type of the matched metric.