Skip to content

Commit f651f6b

Browse files
committed
(fleet/prometheus-alerts) change readme text
1 parent 5a07010 commit f651f6b

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

fleet/lib/prometheus-alerts/README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,10 @@ file with the `rules.namespace` key.
1313

1414
## Prometheus rule AURA standards
1515

16-
* `summary` annotation: The `summary` annotation is used to be able to describe a
17-
group of alerts incomming. This annotation DOES NOT contain any templated
18-
variables and provides a simple single sentence summary of what the alert is
19-
about. For example "Disk space full in 24h". When a cluster triggers several
20-
alerts, it can be hany to group these alerts into a single notification, this
21-
is when the `summary` can be used.
22-
* `discription` annotation: This provides a detailed overview of the alert
23-
specifically to this instance of the alert. It MAY contain templated variables
24-
to enrich the message.
25-
* `receiver` label: The receiver label is used by alertmanager to decide on the
26-
routing of the notification for the alert. It exists out of `,` seperated list
27-
of receivers, pre- and suffixed with `,` to make regex matching easier in the
28-
alertmanager. For example: `,slack,squadcast,email,` The receivers are defined
29-
in the alertmanager configuration.
30-
16+
* `summary` annotation: This annotation MAY contain a templated variable to differentiate between hosts, pods, clusters, etc. and provides a simple single sentence summary of what the alert is about. For example "Disk space full in acme.lsst.org". When a cluster triggers several alerts, it can be handy to group these alerts into a single notification, this is when the `summary` can be used. It is also useful to set an appropiate title for jira tickets.
17+
* `discription` annotation: This provides a detailed overview of the alert specifically to this instance of the alert. It MAY contain templated variables to enrich the message.
18+
* routing label: Rubin uses labels to route alerts. The label is used by alertmanager to decide on the routing of the notification for the alert. By default, all alerts should be routed to Squadcast. The escalation and notification will be handled by Squadcast API.
19+
3120
Currently (20250616) the following receivers are configured:
32-
* `gnocpush`: Requires label `gnoc = "true"`
33-
* `squadcast-alertmanager`: Requires label `prod = "true"`
21+
* `gnocpush`: Requires label `gnoc: "true"`
22+
* `squadcast-alertmanager`: Requires label `prod: "true"`. In most cases this should be the label of the alert.

0 commit comments

Comments
 (0)