Metric events anomaly detection API - JSON models
This API is deprecated. Use the Settings API instead. Look for the Metric events (builtin:anomaly-detection.metric-events) schema.
Some JSON models of the Metric events anomaly detection API vary, depending on the filterType of some objects. Here you can find JSON models for each variation.
Variations of the MetricEventAlertingScope object
The MetricEventAlertingScope object is the base for alerting scopes of metric events. The actual set of fields depends on the filterType of the scope.
CUSTOM_DEVICE_GROUP_NAME
The CustomDeviceGroupNameAlertingScope object
A scope filter for the related custom device group name.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
CONTAINS_CASE_INSENSITIVECONTAINS_CASE_SENSITIVEEQUALS
The value to match on.
{"filterType": "CUSTOM_DEVICE_GROUP_NAME","nameFilter": {"value": "entity name","operator": "CONTAINS_CASE_INSENSITIVE"}}
ENTITY_ID
The EntityIdAlertingScope object
A scope filter for a monitored entity identifier.
The monitored entities id to match on.
{"filterType": "ENTITY_ID","entityId": "HOST-B7A6F9EE9F366CB5"}
HOST_NAME
The HostNameAlertingScope object
A scope filter for the related host name.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
CONTAINS_CASE_INSENSITIVECONTAINS_CASE_SENSITIVEEQUALS
The value to match on.
{"filterType": "HOST_NAME","nameFilter": {"value": "entity name","operator": "CONTAINS_CASE_INSENSITIVE"}}
HOST_GROUP_NAME
The HostGroupNameAlertingScope object
A scope filter for the related host group name.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
CONTAINS_CASE_INSENSITIVECONTAINS_CASE_SENSITIVEEQUALS
The value to match on.
{"filterType": "HOST_GROUP_NAME","nameFilter": {"value": "entity name","operator": "CONTAINS_CASE_INSENSITIVE"}}
MANAGEMENT_ZONE
The ManagementZoneAlertingScope object
A scope filter for a management zone identifier.
The management zone id to match on.
{"filterType": "MANAGEMENT_ZONE","mzId": "6958644387494623526"}
NAME
The NameAlertingScope object
A scope filter for a monitored entity name.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
CONTAINS_CASE_INSENSITIVECONTAINS_CASE_SENSITIVEEQUALS
The value to match on.
{"filterType": "NAME","nameFilter": {"value": "entity name","operator": "CONTAINS_CASE_INSENSITIVE"}}
PROCESS_GROUP_ID
The ProcessGroupIdAlertingScope object
A scope filter for a process group identifier.
The process groups id to match on.
{"filterType": "PROCESS_GROUP_ID","processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"}
PROCESS_GROUP_NAME
The ProcessGroupNameAlertingScope object
A scope filter for the related process group name.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
CONTAINS_CASE_INSENSITIVECONTAINS_CASE_SENSITIVEEQUALS
The value to match on.
{"filterType": "PROCESS_GROUP_NAME","nameFilter": {"value": "entity name","operator": "CONTAINS_CASE_INSENSITIVE"}}
TAG
The TagFilterAlertingScope object
A scope filter for tags on entities.
The TagFilter object
A tag-based filter of monitored entities.
The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the CONTEXTLESS value.
AWSAWS_GENERICAZURECLOUD_FOUNDRYCONTEXTLESSENVIRONMENTGOOGLE_CLOUDKUBERNETES
The key of the tag.
Custom tags have the tag value here.
The value of the tag.
Not applicable to custom tags.
{"filterType": "TAG","tagFilter": {"context": "CONTEXTLESS","key": "Infrastructure","value": "Linux"}}
Variations of the MetricEventDimensions object
The MetricEventDimensions object is the base for metric dimensions. The actual set of fields depends on the filterType of the dimension.
ENTITY
The MetricEventEntityDimensions object
A filter for the metrics entity dimensions.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
EQUALS
The value to match on.
{"filterType": "ENTITY","name": "dimension","index": 1,"nameFilter": {"value": "entity name","operator": "EQUALS"}}
STRING
The MetricEventStringDimensions object
A filter for the metrics string dimensions.
A filter for a string value based on the given operator.
The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object
A filter for a string value based on the given operator.
The operator to match on.
EQUALS
The value to match on.
{"filterType": "STRING","name": "dimension","index": 1,"textFilter": {"value": "entity name","operator": "EQUALS"}}
Variations of the MetricEventMonitoringStrategy object
The MetricEventMonitoringStrategy object is the base for monitoring strategy of a metric event. The actual set of fields depends on the type of the strategy.
AUTO_ADAPTIVE_BASELINE
The MetricEventAutoAdaptiveBaselineMonitoringStrategy object
An auto-adaptive baseline strategy to detect anomalies within metrics that show a regular change over time, as the baseline is also updated automatically. An example is to detect an anomaly in the number of received network packets or within the number of user actions over time.
The condition for the threshold value check: above or below.
ABOVEBELOW
If true, also one-minute samples without data are counted as violating samples.
The number of one-minute samples within the evaluation window that must go back to normal to close the event.
Defines the factor of how many signal fluctuations are valid. Values above the baseline plus the signal fluctuation times the number of tolerated signal fluctuations are alerted.
The number of one-minute samples that form the sliding evaluation window.
The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.
{"type": "AUTO_ADAPTIVE_BASELINE","samples": 5,"violatingSamples": 3,"dealertingSamples": 5,"alertCondition": "ABOVE","alertingOnMissingData": false,"numberOfSignalFluctuations": 1.0}
STATIC_THRESHOLD
The MetricEventStaticThresholdMonitoringStrategy object
A static threshold monitoring strategy to alert on hard limits within a given metric. An example is the violation of a critical memory limit.
The condition for the threshold value check: above or below.
ABOVEBELOW
If true, also one-minute samples without data are counted as violating samples.
The number of one-minute samples within the evaluation window that must go back to normal to close the event.
The number of one-minute samples that form the sliding evaluation window.
The value of the static threshold based on the specified unit.
The unit of the threshold, matching the metric definition.
AMPEREBILLIONBITBIT_PER_HOURBIT_PER_MINUTEBIT_PER_SECONDBYTEBYTE_PER_HOURBYTE_PER_MINUTEBYTE_PER_SECONDCORESCOUNTDAYDECIBEL_MILLI_WATTGIBI_BYTEGIBI_BYTE_PER_HOURGIBI_BYTE_PER_MINUTEGIBI_BYTE_PER_SECONDGIGAGIGA_BYTEGIGA_BYTE_PER_HOURGIGA_BYTE_PER_MINUTEGIGA_BYTE_PER_SECONDHERTZHOURKIBI_BYTEKIBI_BYTE_PER_HOURKIBI_BYTE_PER_MINUTEKIBI_BYTE_PER_SECONDKILOKILO_BYTEKILO_BYTE_PER_HOURKILO_BYTE_PER_MINUTEKILO_BYTE_PER_SECONDKILO_METRE_PER_HOURMEBI_BYTEMEBI_BYTE_PER_HOURMEBI_BYTE_PER_MINUTEMEBI_BYTE_PER_SECONDMEGAMEGA_BYTEMEGA_BYTE_PER_HOURMEGA_BYTE_PER_MINUTEMEGA_BYTE_PER_SECONDMETRE_PER_HOURMETRE_PER_SECONDMICRO_SECONDMILLIONMILLI_CORESMILLI_SECONDMILLI_SECOND_PER_MINUTEMINUTEMONTHMSUNANO_SECONDNANO_SECOND_PER_MINUTENOT_APPLICABLEPERCENTPER_HOURPER_MINUTEPER_SECONDPIXELPROMILLERATIOSECONDSTATETRILLIONUNSPECIFIEDVOLTWATTWEEKYEAR
The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.
{"type": "STATIC_THRESHOLD","samples": 3,"violatingSamples": 1,"dealertingSamples": 3,"alertCondition": "BELOW","alertingOnMissingData": false,"threshold": 99,"unit": "COUNT"}