Settings API - Metric events schema table
Metric events (builtin:anomaly-detection.metric-events)
Metric event configurations are used to automatically detect anomalies in metric timeseries by using thresholds or baselines.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:anomaly-detection.metric-events |
| environment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | - | required |
| summary | Summary | text | The textual summary of the metric event entry | required |
| queryDefinition | Query definition | QueryDefinition | - | required |
| modelProperties | Monitoring strategy | ModelProperties | - | required |
| eventTemplate | Event template | EventTemplate | - | required |
| eventEntityDimensionKey | Dimension key of entity for events | text | Controls the preferred entity type used for triggered events. | optional |
| legacyId | Config id | text | - | optional |
Request body objects
The MetadataItem object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| metadataKey | Key | text | Type 'dt.' for key hints. | required |
| metadataValue | Value | text | Type '{' for placeholder hints. | required |
The EntityFilterCondition object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| type | Filter type | enum | - | required |
| operator | Operator | enum | - | required |
| value | Value | text | - | required |
The EntityFilter object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| dimensionKey | Dimension key of entity type | text | Dimension key of entity type to filter | optional |
| conditions | - | list | - | required |
The DimensionFilter object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| dimensionKey | Dimension key | text | - | required |
| operator | Operator | enum | - | optional |
| dimensionValue | Dimension value | text | - | required |
The QueryDefinition object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| type | Type | enum | - | required |
| metricSelector | Metric selector | text | To learn more, visit Metric Selector | required |
| metricKey | Metric key | text | - | required |
| aggregation | Aggregation | enum | - | required |
| managementZone | Management zone | text | - | optional |
| queryOffset | Query offset | integer | Minute offset of sliding evaluation window for metrics with latency | optional |
| entityFilter | Entities | EntityFilter | Use rule-based filters to define the scope this event monitors. | required |
| dimensionFilter | Dimension filter | list | - | required |
The ModelProperties object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| type | Model type | enum | Metric-key-based query definitions only support static thresholds. | required |
| threshold | Threshold | float | Raise an event if this value is violated | required |
| alertOnNoData | Alert on missing data | boolean | The ability to set an alert on missing data in a metric. When enabled, missing data samples will contribute as violating samples defined in advanced model properties. We recommend to not alert on missing data for sparse timeseries as this leads to alert spam. | required |
| signalFluctuation | Number of signal fluctuations | float | Controls how many times the signal fluctuation is added to the baseline to produce the actual threshold for alerting | required |
| tolerance | Tolerance | float | Controls the width of the confidence band and larger values lead to a less sensitive model | required |
| alertCondition | Alert condition | enum | - | required |
| violatingSamples | Violating samples | integer | The number of one-minute samples within the evaluation window that must violate to trigger an event. | required |
| samples | Sliding window | integer | The number of one-minute samples that form the sliding evaluation window. | required |
| dealertingSamples | Dealerting samples | integer | The number of one-minute samples within the evaluation window that must go back to normal to close the event. | required |
The EventTemplate object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| title | Title | text | The title of the event to trigger. Type '{' for placeholder hints. | required |
| description | Description | text | The description of the event to trigger. Type '{' for placeholder hints. | required |
| eventType | Event type | enum | The event type to trigger. | required |
| davisMerge | Allow merge | boolean | Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created. | required |
| metadata | Properties | set | Set of additional key-value properties to be attached to the triggered event. | required |