Skip to main content

alert-variables

Variables are used as parameters in the JSON payload object of your alert notifications. These variables are used to dynamically populate specific values from the alert configuration in the notification payload. It includes things like the TriggerType that gives the current monitor status in the notification. When a notification is sent variables are replaced with values from the alert. For example, if you specified {{Name}} in your JSON payload, it would be replaced with the actual name of the alert in the delivered payload.

note

Variables must be enclosed by double curly brackets.

Common variables for alerts

You can use variables to customize your notification payload from Monitors and Scheduled Searches. The table below shows a list of variables along with information on which area of the product these are supported. We have also provided a brief description of each of the variables.

note

All variables are case-insensitive.

VariableDescriptionMonitorsScheduled Searches
{{Name}}The name of the alert. In the delivered payload, this variable is replaced with the Name you assigned to the alert when you created it.checkcheck
{{Description}}The description of the alert.checkcheck
{{MonitorType}}The type of alert, either Logs or Metrics.checkcheck
{{Query}}The query used to run the alert.checkcheck
{{QueryURL}}The URL to the logs or metrics query within Sumo Logic.checkcheck
{{ResultsJson}}JSON object containing the query results that triggered the alert. A maximum of 200 aggregate results or 10 raw messages for this field can be sent via webhook.checkcheck

Not available with Email notifications
{{ResultsJson.fieldName}}The value of the specified field name. For example, this payload specification:
{{ResultsJson.client_ip}} had {{ResultsJson.errors}} errors

Results in a subject line like this:
70.69.152.165 had 391 errors

A maximum of 200 aggregate results or 10 raw messages for this field can be sent via webhook.

A field name must match (case-insensitive) the field from your search and must be alphanumeric characters, underscores, and spaces. If you have a field name that has an unsupported character use the as operator to rename it.

You can return a specific result by providing an array index value in bracket notation. Such as, {{ResultsJson.fieldName}}[0] to return the first result.

Reserved Fields
The following are reserved field names. They are generated by Sumo Logic during collection or search operations.
  • _raw
  • Message
  • _messagetime
  • Time
  • _sourcehost
  • Host
  • _sourcecategory
  • Category
  • _sourcename
  • Name
  • _collector
  • Collector
  • _timeslice
  • _signature
checkcheck
{{NumQueryResults}}The number of results the query returned. Results can be raw messages, time-series, or aggregates.

An aggregate query returns the number of aggregate results; displayed in the Aggregates tab of the Search page.

A non-aggregate query returns the number of raw results; displayed in the Messages tab of the Search page.
checkcheck
{{Id}}The unique identifier of the monitor or search that triggered the alert. For example, 00000000000468D5.checkcheck
{{DetectionMethod}}This is the type of Detection Method used to detect alerts. Values are based on static or outlier triggers and data type, either logs or metrics. The value will be either LogsStaticCondition, MetricsStaticCondition, LogsOutlierCondition, MetricsOutlierCondition, LogsMissingDataCondition, MetricsMissingDataCondition, or StaticCondition (deprecated).checkcheck
{{TriggerType}}The status of the alert or recovery. Alert will have either Normal, Critical, Warning, or Missing Data.
Recovery will have either ResolvedCritical, ResolvedWarning, or ResolvedMissingData.checkcheck
{{TriggerTimeRange}}The time range of the query that triggered the alert. For example:
07/13/2021 03:21:32 PM UTC to 07/13/2021 03:36:32 PM UTC
checkcheck
{{TriggerTime}}The time the monitor was triggered. For example:
07/13/2021 03:38:30 PM UTC.
checkcheck
{{TriggerCondition}}The condition that triggered the alert. For example:
Greater than or equal to 1.0 in the last 15 minutes
checkcheck
{{TriggerValue}}The value that triggered the alert.checkcheck
{{TriggerTimeStart}}The start time of the time range that triggered the monitor in Unix format. For example, 1626189692042.checkcheck
{{TriggerTimeEnd}}The end time of the time range that triggered the monitor in Unix format. For example, 1626190592042.checkcheck
{{SourceURL}}The URL to the configuration or status page of the monitor in Sumo Logic.checkcheck
{{AlertResponseUrl}}When your Monitor is triggered it will generate a URL and provide it as the value of this variable where you can use it to open Alert Response.checkcheck

Examples

Slack payload

{
"attachments": [
{
"pretext": "Sumo Logic Alert for: *{{Name}}* by user USERNAME",
"fields": [
{
"title": "Description",
"value": "{{Description}} {{TriggerTimeStart}}"
},
{
"title": "Query",
"value": "<{{QueryURL}}|{{Query}}>"
},
{
"title": "Time Range",
"value": "{{TriggerTimeRange}}"
}
],
"mrkdwn_in": ["text", "pretext"],
"color": "#29A1E6"
}
]
}

PagerDuty payload

{
"service_key": "xxxxx",
"event_type": "trigger",
"description": "Monitor Alert on {{Name}}",
"client": "Sumo Logic",
"details": {
"name": "{{Name}}",
"query": "<{{QueryURL}} | {{Query}}>",
"time": "{{TriggerTimeRange}} -- {{TriggerTime}} --"
}
}

Email message

Monitor Alert: {{TriggerTimeRange}} on {{Name}}

Legacy Variables

This section provides the old variables available for alert notifications from Metrics Monitors and Scheduled Searches. The following table shows where the old variables are supported.

tip

We recommend you use the new common variables instead of these legacy variables. In the future, legacy variables will be deprecated.

VariableDescriptionMetrics MonitorsScheduled Searches
{{SearchName}}checkcheck
{{SearchDescription}}Description of the saved search or Monitor. In the delivered payload, this variable is replaced with the Name you assigned to the search or Monitor when you created it.checkcheck
{{SearchQuery}}The query used to run the saved search. In the delivered payload, this variable is replaced by your saved search query or metric query.checkcheck
{{SearchQueryUrl}}The URL to the search or metrics query. In the delivered payload, this is a URL that you can click to run the saved logs or metric query.checkcheck
{{TimeRange}}The time range that triggered the alert.checkcheck
{{FireTime}}The start time of the log search or metric query that triggered the notification.checkcheck
{{AggregateResultsJson}}JSON object containing search aggregation results. A maximum of 200 aggregate results can be sent via webhook.checkcheck
Not available with Email notifications
{{RawResultsJson}}JSON object containing raw messages. A maximum of 10 raw messages can be sent via webhook.checkcheck
Not available with Email notifications
{{NumRawResults}}Number of results returned by the search.checkcheck
{{Results.fieldname}}The value returned from the search result for the specified field. For example, this payload specification:
{{Results.client_ip}} had {{Results.errors}} errors

Results in a subject line like this:
70.69.152.165 had 391 errors

A maximum of 200 aggregate results or 10 raw messages for this field can be sent via webhook.
A field name must match (case-insensitive) the field from your search and must be alphanumeric characters, underscores, and spaces. If you have a field name that has an unsupported character use the as operator to rename it.
checkcheck
{{AlertThreshold}}The condition that triggered the alert (for example, above 90 at least once in the last 5 minutes)checkcheck
{{AlertSource}}The metric and sourceHost that triggered the alert, including associated tags for that metric.checkcheck
{{AlertSource.fieldname}}The value returned from the AlertSource object for the specified field name.checkcheck
{{AlertID}}The ID of the triggered alert.checkcheck
The ID of the triggered alert.Current status of the time series that triggered (for example, Critical or Warning).checkcheck
{{AlertCondition}}The condition that triggered the alert.checkcheck
Sumo Logic YouTubeSumo Logic Twitter
Legal
Privacy Statement
Terms of Use

Copyright © 2022 by Sumo Logic, Inc.