alert annotation
Descriptive text attached to an alert, such as a summary of the symptom and a link to the dashboard or runbook.
In more detail
Annotations should state the symptom in plain language, name the affected service and route, and link to the evidence. Detailed causes belong in the runbook.
Related terms
- alerting rule — A Prometheus rule with a PromQL expression that describes an unhealthy condition, plus a for duration, labels and annotations.
- runbook — A written, step-by-step procedure for a routine operation or for responding to a known kind of incident.
Taught in
- Alerting Rules And The For Duration — Full-Stack Observability: Metrics, Tracing & Logging