Settings API - Metric events schema table

  • Published Dec 05, 2023

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 IDSchema groupsScope
builtin:anomaly-detection.metric-events
  • group:anomaly-detection
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.metric-events
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.metric-events
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.metric-events

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Enabled
enabled		boolean-required
Summary
summary		text

The textual summary of the metric event entry

required
Query definition
queryDefinition		QueryDefinition-required
Monitoring strategy
modelProperties		ModelProperties-required
Event template
eventTemplate		EventTemplate-required
Dimension key of entity for events
eventEntityDimensionKey		text

Controls the preferred entity type used for triggered events.

optional
Config id
legacyId		text-optional
The QueryDefinition object
PropertyTypeDescriptionRequired
Type
type		enum
  • METRIC_KEY
  • METRIC_SELECTOR
required
Metric selector
metricSelector		text

To learn more, visit Metric Selector

required
Metric key
metricKey		text-required
Aggregation
aggregation		enum
  • MIN
  • MAX
  • SUM
  • COUNT
  • AVG
  • VALUE
  • MEDIAN
  • PERCENTILE90
required
Management zone
managementZone		text-optional
Query offset
queryOffset		integer

Minute offset of sliding evaluation window for metrics with latency

optional
Entities
entityFilter		EntityFilter

Use rule-based filters to define the scope this event monitors.

required
Dimension filter
dimensionFilter		DimensionFilter[]-required
The ModelProperties object
PropertyTypeDescriptionRequired
Model type
type		enum

Metric-key-based query definitions only support static thresholds.

  • STATIC_THRESHOLD
  • AUTO_ADAPTIVE_THRESHOLD
  • SEASONAL_BASELINE
required
Threshold
threshold		float

Raise an event if this value is violated

required
Alert on missing data
alertOnNoData		boolean

The ability to set an alert on missing data in a metric. When enabled, missing data samples will be treated as violating samples defined in the advanced model properties. When disabled, missing data is not treated as a violation but will still contribute to dealerting. We recommend disabling alerting on missing data for sparse timeseries to avoid false alerts. To learn more, visit anomaly detection configuration.

required
Number of signal fluctuations
signalFluctuation		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
Alert condition
alertCondition		enum
  • ABOVE
  • BELOW
  • OUTSIDE
required
Violating samples
violatingSamples		integer

The number of one-minute samples within the evaluation window that must violate to trigger an event.

required
Sliding window
samples		integer

The number of one-minute samples that form the sliding evaluation window.

required
Dealerting samples
dealertingSamples		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
PropertyTypeDescriptionRequired
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
Event type
eventType		enum

The event type to trigger.

  • INFO
  • ERROR
  • AVAILABILITY
  • SLOWDOWN
  • RESOURCE
  • CUSTOM_ALERT
  • CUSTOM_ANNOTATION
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • MARKED_FOR_TERMINATION
required
Allow merge
davisMerge		boolean

Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created.

required
Properties
metadata		Set<MetadataItem>

Set of additional key-value properties to be attached to the triggered event. You can retrieve the available property keys using the Events API v2.

required
The EntityFilter object
PropertyTypeDescriptionRequired
Dimension key of entity type
dimensionKey		text

Dimension key of entity type to filter

optional
conditionsEntityFilterCondition[]-required
The DimensionFilter object
PropertyTypeDescriptionRequired
Dimension key
dimensionKey		text-required
Operator
operator		enum
  • EQUALS
  • DOES_NOT_EQUAL
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • CONTAINS_CASE_SENSITIVE
  • DOES_NOT_CONTAIN_CASE_SENSITIVE
optional
Dimension value
dimensionValue		text-required
The MetadataItem object
PropertyTypeDescriptionRequired
Key
metadataKey		text

Type 'dt.' for key hints.

required
Value
metadataValue		text

Type '{' for placeholder hints.

required
The EntityFilterCondition object
PropertyTypeDescriptionRequired
Filter type
type		enum
  • NAME
  • ENTITY_ID
  • MANAGEMENT_ZONE
  • TAG
  • HOST_NAME
  • HOST_GROUP_NAME
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_ID
  • CUSTOM_DEVICE_GROUP_NAME
required
Operator
operator		enum
  • EQUALS
  • DOES_NOT_EQUAL
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • CONTAINS_CASE_SENSITIVE
  • DOES_NOT_CONTAIN_CASE_SENSITIVE
  • CONTAINS_CASE_INSENSITIVE
  • DOES_NOT_CONTAIN_CASE_INSENSITIVE
required
Value
value		text-required