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
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "CUSTOM_DEVICE_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
ENTITY_ID
The EntityIdAlertingScope
object
Element | Type | Description |
---|---|---|
entityId | string | The monitored entities id to match on. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "ENTITY_ID",
"entityId": "HOST-B7A6F9EE9F366CB5"
}
HOST_NAME
The HostNameAlertingScope
object
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "HOST_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
HOST_GROUP_NAME
The HostGroupNameAlertingScope
object
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "HOST_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
MANAGEMENT_ZONE
The ManagementZoneAlertingScope
object
Element | Type | Description |
---|---|---|
mzId | string | The management zone id to match on. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "MANAGEMENT_ZONE",
"mzId": "6958644387494623526"
}
NAME
The NameAlertingScope
object
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
PROCESS_GROUP_ID
The ProcessGroupIdAlertingScope
object
Element | Type | Description |
---|---|---|
processGroupId | string | The process groups id to match on. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "PROCESS_GROUP_ID",
"processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"
}
PROCESS_GROUP_NAME
The ProcessGroupNameAlertingScope
object
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"filterType": "PROCESS_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
TAG
The TagFilterAlertingScope
object
Element | Type | Description |
---|---|---|
tagFilter | Tag | A tag-based filter of monitored entities. Can be |
The MetricEventAlertingScope
object
A single filter for the alerting scope.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"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
Element | Type | Description |
---|---|---|
nameFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventDimensions
object
A single filter for the metrics dimensions.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
key | string | The dimensions key on the metric. Can be |
json{
"filterType": "ENTITY",
"name": "dimension",
"index": 1,
"nameFilter": {
"value": "entity name",
"operator": "EQUALS"
}
}
STRING
The MetricEventStringDimensions
object
Element | Type | Description |
---|---|---|
textFilter | Metric | A filter for a string value based on the given operator. Can be |
The MetricEventDimensions
object
A single filter for the metrics dimensions.
The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.
Element | Type | Description |
---|---|---|
filterType | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
key | string | The dimensions key on the metric. Can be |
json{
"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
Element | Type | Description |
---|---|---|
samples | integer | The number of one-minute samples that form the sliding evaluation window. Can be |
violatingSamples | integer | The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event. Can be |
dealertingSamples | integer | The number of one-minute samples within the evaluation window that must go back to normal to close the event. Can be |
alertCondition | string | The condition for the threshold value check: above or below. The element can hold these values
Can be |
alertingOnMissingData | boolean | If true, also one-minute samples without data are counted as violating samples. Can be |
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. Can be |
The MetricEventMonitoringStrategy
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 |
---|---|---|
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"type": "AUTO_ADAPTIVE_BASELINE",
"samples": 5,
"violatingSamples": 3,
"dealertingSamples": 5,
"alertCondition": "ABOVE",
"alertingOnMissingData": false,
"numberOfSignalFluctuations": 1.0
}
STATIC_THRESHOLD
The MetricEventStaticThresholdMonitoringStrategy
object
Element | Type | Description |
---|---|---|
samples | integer | The number of one-minute samples that form the sliding evaluation window. Can be |
violatingSamples | integer | The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event. Can be |
dealertingSamples | integer | The number of one-minute samples within the evaluation window that must go back to normal to close the event. Can be |
alertCondition | string | The condition for the threshold value check: above or below. The element can hold these values
Can be |
alertingOnMissingData | boolean | If true, also one-minute samples without data are counted as violating samples. Can be |
threshold | number | The value of the static threshold based on the specified unit. Can be |
unit | string | The unit of the threshold, matching the metric definition. The element can hold these values
Can be |
The MetricEventMonitoringStrategy
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 |
---|---|---|
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
json{
"type": "STATIC_THRESHOLD",
"samples": 3,
"violatingSamples": 1,
"dealertingSamples": 3,
"alertCondition": "BELOW",
"alertingOnMissingData": false,
"threshold": 99,
"unit": "COUNT"
}