* Alerting docs: adds silence RBAC 11.1 * ran prettier * Improve docs with new rule-specific silence RBAC information * Apply suggestions from code review Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Apply suggestions from code review Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * prettier --------- Co-authored-by: Matt Jacobson <matthew.jacobson@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
5.6 KiB
aliases | canonical | description | keywords | labels | title | weight | refs | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
https://grafana.com/docs/grafana/latest/alerting/configure-notifications/create-silence/ | Create silences to stop notifications from getting created for a specified window of time |
|
|
Configure silences | 440 |
|
Configure silences
Silences stop notifications from getting created and last for only a specified window of time.
{{< admonition type="note" >}}
- Inhibition rules are not supported in the Grafana Alertmanager.
- The preview of silenced alerts only applies to alerts in firing state. {{< /admonition >}}
Add silences
To add a silence, complete the following steps.
-
In the left-side menu, click Alerts & IRM and then Alerting.
-
Click Silences.
-
From the Alertmanager dropdown, select an external Alertmanager to create and manage silences for the external data source. Otherwise, keep the default option of Grafana.
-
Click Create silence to open the Create silence page.
-
In Silence start and end, select the start and end date to indicate when the silence should go into effect and expire.
-
Optionally, in Duration, specify how long the silence is enforced. This automatically updates the end time in the Silence start and end field.
-
In the Label and Value fields, enter one or more Matching Labels. Matchers determine which rules the silence will apply to. Any matching alerts (in firing state) will show in the Silenced alert instances field
{{< docs/shared lookup="alerts/how_label_matching_works.md" source="grafana" version="<GRAFANA_VERSION>" >}}
-
In Comment, add details about the silence.
-
Click Submit.
Edit silences
To edit a silence, complete the following steps.
- In the left-side menu, click Alerts & IRM and then Alerting.
- Click Silences to view the list of existing silences.
- Find the silence you want to edit, then click Edit (pen icon).
- Make the desired changes, then click Submit to save your changes.
Create a URL to link to a silence form
When linking to a silence form, provide the default matching labels and comment via matcher
and comment
query parameters. The matcher
parameter should be in the following format [label][operator][value]
where the operator
parameter can be one of the following: =
(equals, not regular expression), !=
(not equals, not regular expression), =~
(equals, regular expression), !~
(not equals, regular expression).
The URL can contain many query parameters with the key matcher
.
For example, to link to silence form with matching labels severity=critical
& cluster!~europe-.*
and comment Silence critical EU alerts
, create a URL https://mygrafana/alerting/silence/new?matcher=severity%3Dcritical&matcher=cluster!~europe-*&comment=Silence%20critical%20EU%20alert
.
To link to a new silence page for an external Alertmanager, add a alertmanager
query parameter with the Alertmanager data source name.
Remove silences
To remove a silence, complete the following steps.
- In the left-side menu, click Alerts & IRM and then Alerting.
- Click Silences to view the list of existing silences.
- Select the silence you want to end, then click Unsilence.
Note: You cannot remove a silence manually. Silences that have ended are retained and listed for five days.
Rule-specific silences
Rule-specific silences are silences that apply only to a specific alert rule. They're created when you silence an alert rule directly using the Silence notifications action in the UI.
{{< admonition type="note" >}}
As opposed to general silences, rule-specific silence access is tied directly to the alert rule they act on. They can be created manually by including the specific label matcher: __alert_rule_uid__=<alert rule UID>
.
{{< /admonition >}}