Metric events anomaly detection API - JSON models
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 single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "CUSTOM_DEVICE_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
ENTITY_ID
The EntityIdAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| entityId | string |
The monitored entities id to match on. |
required |
{
"filterType": "ENTITY_ID",
"entityId": "HOST-B7A6F9EE9F366CB5"
}
HOST_NAME
The HostNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "HOST_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
HOST_GROUP_NAME
The HostGroupNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "HOST_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
MANAGEMENT_ZONE
The ManagementZoneAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| mzId | string |
The management zone id to match on. |
optional |
{
"filterType": "MANAGEMENT_ZONE",
"mzId": "6958644387494623526"
}
NAME
The NameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
PROCESS_GROUP_ID
The ProcessGroupIdAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| processGroupId | string |
The process groups id to match on. |
required |
{
"filterType": "PROCESS_GROUP_ID",
"processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"
}
PROCESS_GROUP_NAME
The ProcessGroupNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventTextFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "PROCESS_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
TAG
The TagFilterAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| tagFilter | TagFilter | required |
The TagFilter object
A tag-based filter of monitored entities.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the
|
required |
| key | string |
The key of the tag. Custom tags have the tag value here. |
required |
| value | string |
The value of the tag. Not applicable to custom tags. |
optional |
{
"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 single filter for the metrics dimensions.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| key | string |
The dimensions key on the metric. |
optional |
| nameFilter |
Metric |
required |
The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "ENTITY",
"name": "dimension",
"index": 1,
"nameFilter": {
"value": "entity name",
"operator": "EQUALS"
}
}
STRING
The MetricEventStringDimensions object
A single filter for the metrics dimensions.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| key | string |
The dimensions key on the metric. |
optional |
| textFilter |
Metric |
required |
The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object
A filter for a string value based on the given operator.
| Element | Type | Description | Required |
|---|---|---|---|
| value | string |
The value to match on. |
required |
| operator | string |
The operator to match on.
|
required |
{
"filterType": "STRING",
"name": "dimension",
"index": 1,
"nameFilter": {
"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
A monitoring strategy for a metric event config.
This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| samples | integer |
The number of one-minute samples that form the sliding evaluation window. |
required |
| violatingSamples | integer |
The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event. |
required |
| dealertingSamples | integer |
The number of one-minute samples within the evaluation window that must go back to normal to close the event. |
required |
| alertCondition | string |
The condition for the threshold value check: above or below.
|
required |
| alertingOnMissingData | boolean |
If true, also one-minute samples without data are counted as violating samples. |
optional |
| numberOfSignalFluctuations | number |
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. |
required |
{
"type": "AUTO_ADAPTIVE_BASELINE",
"samples": 5,
"violatingSamples": 3,
"dealertingSamples": 5,
"alertCondition": "ABOVE",
"alertingOnMissingData": false,
"numberOfSignalFluctuations": 1.0
}
STATIC_THRESHOLD
The MetricEventStaticThresholdMonitoringStrategy object
A monitoring strategy for a metric event config.
This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| samples | integer |
The number of one-minute samples that form the sliding evaluation window. |
required |
| violatingSamples | integer |
The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event. |
required |
| dealertingSamples | integer |
The number of one-minute samples within the evaluation window that must go back to normal to close the event. |
required |
| alertCondition | string |
The condition for the threshold value check: above or below.
|
required |
| alertingOnMissingData | boolean |
If true, also one-minute samples without data are counted as violating samples. |
optional |
| threshold | number |
The value of the static threshold based on the specified unit. |
required |
| unit | string |
The unit of the threshold, matching the metric definition.
|
optional |
{
"type": "STATIC_THRESHOLD",
"samples": 3,
"violatingSamples": 1,
"dealertingSamples": 3,
"alertCondition": "BELOW",
"alertingOnMissingData": false,
"threshold": 99,
"unit": "COUNT"
}