MetricDefaultFilterinterface
Metric filters that can be specified as default.
Metric filters allow controlling specific metric data points, e.g. whether a particular value of a specific metric will be published.
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: Can be specified for a single metric ( |
| 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 |
| enabled⚓︎ | boolean | x | x | Whether or not the value for the matching metric will be published. |
| name⚓︎ | string | x | x | Matches the name of the metric |
| overrideDefaultFilters⚓︎ | boolean | false | x | If |
| sample⚓︎ | number | boolean | true | x | Defines sampling probability for the metric. |
| type⚓︎ | MetricType | x | x | Matches the type of the metric. |