{
"monitor": {
"name": "<string>",
"annotations": {},
"bucket_slug": "<string>",
"collection": {
"slug": "<string>",
"type": "SIMPLE"
},
"collection_slug": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"graphite_query": "sumSeries(stats.timers.*.mean_90)",
"interval_secs": 123,
"labels": {},
"logging_query": "<string>",
"notification_policy_slug": "<string>",
"prometheus_query": "up{job=\"prometheus\"} == 0",
"schedule": {
"timezone": "<string>",
"weekly_schedule": {
"friday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"monday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"saturday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"sunday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"thursday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"tuesday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"wednesday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
}
}
},
"series_conditions": {
"defaults": {
"critical": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
},
"warn": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
}
},
"overrides": [
{
"label_matchers": [
{
"name": "<string>",
"type": "EXACT",
"value": "<string>"
}
],
"severity_conditions": {
"critical": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
},
"warn": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
}
}
}
]
},
"signal_grouping": {
"label_names": [
"<string>"
],
"signal_per_series": true
},
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"monitor": {
"name": "<string>",
"annotations": {},
"bucket_slug": "<string>",
"collection": {
"slug": "<string>",
"type": "SIMPLE"
},
"collection_slug": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"graphite_query": "sumSeries(stats.timers.*.mean_90)",
"interval_secs": 123,
"labels": {},
"logging_query": "<string>",
"notification_policy_slug": "<string>",
"prometheus_query": "up{job=\"prometheus\"} == 0",
"schedule": {
"timezone": "<string>",
"weekly_schedule": {
"friday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"monday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"saturday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"sunday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"thursday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"tuesday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
},
"wednesday": {
"active": "ALL_DAY",
"ranges": [
{
"end_hh_mm": "<string>",
"start_hh_mm": "<string>"
}
]
}
}
},
"series_conditions": {
"defaults": {
"critical": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
},
"warn": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
}
},
"overrides": [
{
"label_matchers": [
{
"name": "<string>",
"type": "EXACT",
"value": "<string>"
}
],
"severity_conditions": {
"critical": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
},
"warn": {
"conditions": [
{
"op": "GEQ",
"resolve_sustain_secs": 123,
"sustain_secs": 123,
"value": 123
}
]
}
}
}
]
},
"signal_grouping": {
"label_names": [
"<string>"
],
"signal_per_series": true
},
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Path Parameters
Body
If true, the Monitor will be created if it does not already exist, identified by slug. If false, an error will be returned if the Monitor does not already exist.
If true, validates the specified configuration without creating or updating the Monitor. If the specified configuration is valid, the endpoint returns a partial response without the Monitor. If the specified configuration is invalid, the endpoint returns an error.
The Monitor to update.
Show child attributes
Show child attributes
The name of the Monitor. You can modify this value after the Monitor is created.
Slug of the bucket the monitor belongs to. Required if collection_slug isn't
set.
Slug of the collection the monitor belongs to. Required if bucket_slug isn't
set.
Graphite query to evaluate for the alert. If set, no other queries can be set.
"sumSeries(stats.timers.*.mean_90)"
Specifies how often alerts are evaluated. Default: 60s.
Logging query to evaluate for the alert. If set, no other queries can be set.
Specifies the notification policy used to route alerts generated by the monitor. If omitted, the notification policy is inherited from the monitor.
PromQL query to evaluate for the alert. If set, no other queries can be set.
"up{job=\"prometheus\"} == 0"
Defines the schedule for when the monitor should be evaluated. If not set, the monitor defaults to always being active.
Show child attributes
Show child attributes
The timezone of the time ranges.
Specifies the monitor schedule for each day of the week. You must include
every day of the week. Specify active: NEVER for days when you don't want
the monitor to be active.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Required. Conditions to determine the severity of each series. The highest severity series of a signal determines that signal's severity.
Show child attributes
Show child attributes
Mapping of alert severity to its conditions. All conditions are evaluated for every series. If multiple conditions match, the highest severity is chosen.
Show child attributes
Show child attributes
Defines the criteria that must be met to trigger a critical condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Defines the criteria that must be met to trigger a warning condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Optional. Specifies a list of overrides to use for series having matching labels. Each override defines labels that potentially match a series' labels. If one or more overrides match a series, the severity conditions of the first matching override are used instead of the defaults.
Cannot be used if graphite_query is set.
Show child attributes
Show child attributes
Set of matchers on a series' labels. If all labels match, then the conditions defined in this override are used.
Show child attributes
Show child attributes
The name of the label to match against. This always matches against an
exact label name, regardless of the value of type.
Determines how the label value is matched. This parameter doesn't
affect how the label name is matched.
EXACT, REGEX The value of the label to match against. If type is set to EXACT, this
matches against an exact label value. If type is set to REGEX, this
parameter is treated as a regular expression for parsing label values.
Mapping of alert severity to its conditions for series that match this override. These conditions supersede the default conditions, and are not merged with the default conditions.
Show child attributes
Show child attributes
Defines the criteria that must be met to trigger a critical condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Defines the criteria that must be met to trigger a warning condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Specifies the grouping of series into signals. If omitted, all series are grouped into a single signal.
Show child attributes
Show child attributes
Set of label names used to split series into signals. Each unique combination
of labels result in its own signal. For example, if label_names is
["service", "code"], then all series including labels
{service="foo",code="404"} will be grouped together in the same signal.
Cannot be used if graphite_query is set.
If set to true, each series will have its own signal. Cannot be used with
label_names.
The unique identifier of the Monitor. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Monitor is created.
Response
A successful response containing the updated Monitor.
Show child attributes
Show child attributes
The name of the Monitor. You can modify this value after the Monitor is created.
Slug of the bucket the monitor belongs to. Required if collection_slug isn't
set.
Slug of the collection the monitor belongs to. Required if bucket_slug isn't
set.
Timestamp of when the Monitor was created. Cannot be set by clients.
Graphite query to evaluate for the alert. If set, no other queries can be set.
"sumSeries(stats.timers.*.mean_90)"
Specifies how often alerts are evaluated. Default: 60s.
Logging query to evaluate for the alert. If set, no other queries can be set.
Specifies the notification policy used to route alerts generated by the monitor. If omitted, the notification policy is inherited from the monitor.
PromQL query to evaluate for the alert. If set, no other queries can be set.
"up{job=\"prometheus\"} == 0"
Defines the schedule for when the monitor should be evaluated. If not set, the monitor defaults to always being active.
Show child attributes
Show child attributes
The timezone of the time ranges.
Specifies the monitor schedule for each day of the week. You must include
every day of the week. Specify active: NEVER for days when you don't want
the monitor to be active.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Show child attributes
Show child attributes
Determines when the monitor is active for the specified day. Accepts these values:
ALL_DAY: The monitor is active all day.ONLY_DURING_RANGES: The monitor is only active during the given ranges.NEVER: The monitor is never active during the selected day.
ALL_DAY, ONLY_DURING_RANGES, NEVER The time ranges that the monitor is active on this day. Required if active
is set to ONLY_DURING_RANGES. Otherwise, this field must be empty.
Required. Conditions to determine the severity of each series. The highest severity series of a signal determines that signal's severity.
Show child attributes
Show child attributes
Mapping of alert severity to its conditions. All conditions are evaluated for every series. If multiple conditions match, the highest severity is chosen.
Show child attributes
Show child attributes
Defines the criteria that must be met to trigger a critical condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Defines the criteria that must be met to trigger a warning condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Optional. Specifies a list of overrides to use for series having matching labels. Each override defines labels that potentially match a series' labels. If one or more overrides match a series, the severity conditions of the first matching override are used instead of the defaults.
Cannot be used if graphite_query is set.
Show child attributes
Show child attributes
Set of matchers on a series' labels. If all labels match, then the conditions defined in this override are used.
Show child attributes
Show child attributes
The name of the label to match against. This always matches against an
exact label name, regardless of the value of type.
Determines how the label value is matched. This parameter doesn't
affect how the label name is matched.
EXACT, REGEX The value of the label to match against. If type is set to EXACT, this
matches against an exact label value. If type is set to REGEX, this
parameter is treated as a regular expression for parsing label values.
Mapping of alert severity to its conditions for series that match this override. These conditions supersede the default conditions, and are not merged with the default conditions.
Show child attributes
Show child attributes
Defines the criteria that must be met to trigger a critical condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Defines the criteria that must be met to trigger a warning condition.
Show child attributes
Show child attributes
List of conditions to evaluate against a series. Only one condition must match to assign a severity to a signal.
Show child attributes
Show child attributes
Required. Specifies the comparison operator for the metric value and the configured value:
GEQ: Greater than or equal toGT: Greater thanLEQ: Less than or equal toLT: Less thanEQ: Equal toNEQ: Not equal toEXISTS: Specified value existsNOT_EXISTS: Specified value doesn't exist
GEQ, GT, LEQ, LT, EQ, NEQ, EXISTS, NOT_EXISTS Amount of time the query needs to no longer fire before resolving. Must be an
integer. Accepts one of s (seconds), m (minutes), or h (hours) as units.
Amount of time the query needs to fail the condition check before an alert is
triggered. Must be an integer. Accepts one of s (seconds), m (minutes), or
h (hours) as units.
Required. The value to compare to the metric value using the op operation.
Specifies the grouping of series into signals. If omitted, all series are grouped into a single signal.
Show child attributes
Show child attributes
Set of label names used to split series into signals. Each unique combination
of labels result in its own signal. For example, if label_names is
["service", "code"], then all series including labels
{service="foo",code="404"} will be grouped together in the same signal.
Cannot be used if graphite_query is set.
If set to true, each series will have its own signal. Cannot be used with
label_names.
The unique identifier of the Monitor. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the Monitor is created.
Timestamp of when the Monitor was last updated. Cannot be set by clients.