@interopio/desktop API Reference

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

Properties (7)

Property Type Default Required Description
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.
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.