Annotation
Written by
Updated at October 29, 2025
Annotations enable you to save additional information during alert calculation. The annotation name and value are transmitted when sending alert notifications to the Email and Telegram channels.
Annotations support mustache templates: you can use them to add alert parameters to your annotations.
Annotation examples:
Alert `{{alert.name}}` is in {{status.code}} state
Used disk space is {{pointValue}} Gbs, expected less than {{alert.warnThreshold}} Gbs
Complete list of alert parameters available in annotations:
| Field | Description |
|---|---|
| alert.projectIdalert.folderIdalert.idalert.namealert.statealert.createdAtalert.updatedAtalert.createdByalert.updatedByalert.version | Shared alert parameters |
| alert.queriesalert.queryToCheckalert.thresholdTypealert.comparisonalert.alarmThresholdalert.warnThreshold | Threshold alert queries and comparison parameters |
| fromTime | Beginning of the time interval in which the alert is calculated. This is a string in ISO8601 format, such as 2017-09-07T11:30:00Z. |
| toTime | End of the time interval in which the alert is calculated. This is a string in ISO8601 format, such as 2017-09-07T12:00:00Z. |
| pointValue | Metric value as of alert calculation. |
| status.code | Alert status: OK, ALARM, WARN, NO_DATA, or ERROR. |
| isOkisWarnisAlarmisNoDataisError | Boolean variables that can be used to find out the alert status. Here is an example:{{#isAlarm}}Disk usage is too high!{{/isAlarm}}{{^isAlarm}}Disk usage is ok.{{/isAlarm}} |