Update Alert
Update a specific alert
id
A flag indicates whether to use the new multi-query alert structures when the feature is enabled.
When the flag is true, the $.alertSources is the source of truth and will update $.condition and $.displayExpression with the corresponding expanded queries.
When the flag is false, it goes through the old way and the $.condition and$.displayExpression is the source of truth and will auto-update $.alertSources
Example Classic Body:
{
"id": "1459375928549",
"name": "Alert Name",
"target": "target:alert-target-id",
"condition": "ts(~sample.cpu.loadavg.1m) > 1",
"conditionQueryType": "WQL",
"displayExpression": "ts(~sample.cpu.loadavg.1m)",
"displayExpressionQueryType": "WQL",
"minutes": 5,
"resolveAfterMinutes": 2,
"severity": "INFO",
"additionalInformation": "Additional Info",
"tags": {
"customerTags": [
"alertTag1"
]
}
}
Example Classic Body with multi queries:
{
"id": "1459375928549",
"name": "Alert Name",
"alertType": "CLASSIC",
"alertSources": [ {
"name": "A",
"query": "${B} > 2",
"queryType": "PROMQL",
"alertSourceType": ["CONDITION"]
},
{
"name": "B",
"query": "sum_over_time(~sample.network.bytes.recv[1m])",
"queryType": "PROMQL",
"alertSourceType": ["AUDIT"]
}
],
"severity": "WARN",
"minutes": 5
}
Example Threshold Body:
{
"id": "1459375928550",
"name": "Alert Name",
"alertType": "THRESHOLD",
"conditions": {
"info": "ts(~sample.cpu.loadavg.1m) > 0",
"warn": "ts(~sample.cpu.loadavg.1m) > 5"
},
"displayExpression": "ts(~sample.cpu.loadavg.1m)",
"minutes": 5,
"resolveAfterMinutes": 2,
"additionalInformation": "conditions value entry needs to be of the form: displayExpression operator threshold"
}
Example Threshold Body with multi queries:
{
"id": "1459375928549",
"name": "Alert Name",
"alertType": "THRESHOLD",
"alertSources": [
{
"name": "A",
"query": "${B}",
"queryType": "PROMQL",
"alertSourceType": ["CONDITION"]
},
{
"name": "B",
"query": "sum_over_time(~sample.network.bytes.recv[1m])",
"queryType": "PROMQL",
"alertSourceType": ["AUDIT"]
}
],
"conditions": {
"info": "${B} > bool 0",
"warn": "${B} > bool 2"
},
"minutes": 5
}
Supported Characters of Tags:
Tag names can contain alphanumeric (a-z, A-Z, 0-9), dash (-), underscore (_), and colon (:) characters. The space character is not supported.
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": false,
"lastEventTime": 0,
"hidden": false,
"severity": "string",
"minutes": 0,
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"orphan": false,
"deleted": false,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": 0,
"processRateMinutes": 0,
"createUserId": "string",
"updated": 0,
"updateUserId": "string",
"queryFailing": false,
"lastFailedTime": 0,
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": false,
"lastProcessedMillis": 0,
"pointsScannedAtLastQuery": 0,
"includeObsoleteMetrics": false,
"lastQueryTime": 0,
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": false,
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": false,
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": false,
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": false,
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": 0,
"snoozed": 0,
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"querySyntaxError": false,
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"notificants": [
"string"
],
"lastNotificationMillis": 0,
"notificationResendFrequencyMinutes": 0,
"alertsLastDay": 0,
"alertsLastWeek": 0,
"alertsLastMonth": 0,
"numPointsInFailureFrame": 0,
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"systemAlertVersion": 0,
"alertType": "string",
"evaluateRealtimeData": false,
"secureMetricDetails": false,
"enablePDIncidentBySeries": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": 0,
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": 0,
"alertChartDescription": "string"
}tagpaths
targetEndpoints
Whether the user has modify ACL access to the alert.
Start time (in epoch millis) of the last event associated with this alert.
hidden
Severity of the alert
The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires
name
id
The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert target ID}). You cannot update this value.
Lists the applications from the failingHostLabelPair of the alert.
Lists the services from the failingHostLabelPair of the alert.
createdEpochMillis
updatedEpochMillis
List of alert targets display information that includes name, id and type.
Whether this alert is system-owned and not writeable
Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA
orphan
deleted
When this alert was created, in epoch millis
The interval between checks for this alert, in minutes. Defaults to 1 minute
createUserId
When the alert was last updated, in epoch millis
The user that last updated this alert
Whether there was an exception when the alert condition last ran
The time of the last error encountered when running this alert's condition query, in epoch millis
The last error encountered when running this alert's condition query
User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc
Number of metrics checked by the alert condition
Number of hosts checked by the alert condition
inTrash
The time when this alert was last checked, in epoch millis
A derived field recording the number of data points scanned when the system last computed this alert's condition
Whether to include obsolete metrics in alert query
Last query time of the alert, averaged on hourly basis
A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes
conditionQueryType
Whether the condition query was created using the Query Builder. Default false
The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true
A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted
Multi - alert conditions.
displayExpressionQueryType
Whether the display expression query was created using the Query Builder. Default false
creatorId
updaterId
The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true
A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION.
The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as "minutes"
Targets for severity.
The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely
Whether there was an query syntax exception when the alert condition last ran
User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered
User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported
Lists the sources that will not be checked for this alert, due to matching a maintenance window
The names of the active maintenance windows that are affecting this alert
Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the "minutes" parameter
A derived field listing the webhook ids used by this alert
When this alert last caused a notification, in epoch millis
How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs
alertsLastDay
alertsLastWeek
alertsLastMonth
Number of points scanned in alert query time frame.
If this is a system alert, the version of it
Alert type.
Whether to alert on the real-time ingestion stream (may be noisy due to late data)
Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security.
enablePDIncidentBySeries
Get the ingestion policy Id associated with ingestion policy alert.
List of links to tracing applications that caused a failing series
Attribute used for default alert sort that is derived from state and severity
Alert severity list for multi-threshold type.
The y-axis unit of Alert chart.
The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1.
The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart.
successful operation
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": false,
"lastEventTime": 0,
"hidden": false,
"severity": "string",
"minutes": 0,
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"orphan": false,
"deleted": false,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": 0,
"processRateMinutes": 0,
"createUserId": "string",
"updated": 0,
"updateUserId": "string",
"queryFailing": false,
"lastFailedTime": 0,
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": false,
"lastProcessedMillis": 0,
"pointsScannedAtLastQuery": 0,
"includeObsoleteMetrics": false,
"lastQueryTime": 0,
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": false,
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": false,
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": false,
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": false,
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": 0,
"snoozed": 0,
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"querySyntaxError": false,
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"notificants": [
"string"
],
"lastNotificationMillis": 0,
"notificationResendFrequencyMinutes": 0,
"alertsLastDay": 0,
"alertsLastWeek": 0,
"alertsLastMonth": 0,
"numPointsInFailureFrame": 0,
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"systemAlertVersion": 0,
"alertType": "string",
"evaluateRealtimeData": false,
"secureMetricDetails": false,
"enablePDIncidentBySeries": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": 0,
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": 0,
"alertChartDescription": "string"
}
}