mirror of
https://github.com/grafana/grafana.git
synced 2025-08-06 20:59:35 +08:00
Alerting docs: Contact points updates (#77848)
* Alerting docs: adds and reworks contact points content * gh cli to get build to work * contact point docs rework * fixes canonicals with new folder name * adds integrations to index md * deletes pagerduty anchor * ran prettier * updates mute timing section with redesign * Updates alert rules with menu paths and export features * updates menu paths on notification templates tab * updates notification policy with new redesign menu paths * updates time interval tag * ran prettier * corrects typo
This commit is contained in:
brendamuir
@ -26,7 +26,7 @@ weight: 410
|
||||
|
||||
# Configure contact points
|
||||
|
||||
Use contact points to define how your contacts are notified when an alert rule fires. You can create, edit, delete, and test a contact point.
|
||||
Use contact points to define how your contacts are notified when an alert rule fires. You can add, edit, delete, and test a contact point.
|
||||
|
||||
## Add a contact point
|
||||
|
||||
@ -35,13 +35,13 @@ Complete the following steps to add a contact point.
|
||||
1. In the left-side menu, click **Alerts & IRM** and then **Alerting**.
|
||||
1. Click **Contact points**.
|
||||
1. From the **Choose Alertmanager** dropdown, select an Alertmanager. By default, **Grafana Alertmanager** is selected.
|
||||
1. Click **+ Add contact point**.
|
||||
1. In **Name**, enter a descriptive name for the contact point.
|
||||
1. On the **Contact Points** tab, click **+ Add contact point**.
|
||||
1. Enter a descriptive name for the contact point.
|
||||
1. From **Integration**, select a type and fill out mandatory fields. For example, if you choose email, enter the email addresses. Or if you choose Slack, enter the Slack channel(s) and users who should be contacted.
|
||||
1. Some contact point integrations, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point integration.
|
||||
1. In Notification settings, optionally select **Disable resolved message** if you do not want to be notified when an alert resolves.
|
||||
1. To add another contact point integration, click **Add contact point integration** and repeat steps 6 through 8.
|
||||
1. Click **Save contact point** to save your changes.
|
||||
1. Save your changes.
|
||||
|
||||
## Edit a contact point
|
||||
|
||||
@ -49,8 +49,8 @@ Complete the following steps to edit a contact point.
|
||||
|
||||
1. In the left-side menu, click **Alerts & IRM** and then **Alerting**.
|
||||
1. Click **Contact points** to view a list of existing contact points.
|
||||
1. Find the contact point to edit, and then click **Edit** (pen icon).
|
||||
1. Make any changes and click **Save contact point**.
|
||||
1. On the **Contact Points** tab, find the contact point you want to edit, and then click **Edit**.
|
||||
1. Update the contact point and save your changes.
|
||||
|
||||
## Delete a contact point
|
||||
|
||||
@ -58,11 +58,11 @@ Complete the following steps to delete a contact point.
|
||||
|
||||
1. In the left-side menu, click **Alerts & IRM** and then **Alerting**.
|
||||
1. Click **Contact points** to view a list of existing contact points.
|
||||
1. Find the contact point to delete, and then click **Delete** (trash icon).
|
||||
1. On the **Contact Points** tab, find the contact point you want to delete, and then click **More** -> **Delete**.
|
||||
1. In the confirmation dialog, click **Yes, delete**.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
You cannot delete contact points that are in use by a notification policy. You will have to either delete the notification policy or update it to use another contact point.
|
||||
You cannot delete contact points that are in use by a notification policy. Either delete the notification policy or update it to use another contact point.
|
||||
{{% /admonition %}}
|
||||
|
||||
## Test a contact point
|
||||
@ -71,7 +71,7 @@ Complete the following steps to test a contact point.
|
||||
|
||||
1. In the left-side menu, click **Alerts & IRM** and then **Alerting**.
|
||||
1. Click **Contact points** to view a list of existing contact points.
|
||||
1. Find the contact point to test, then click **Edit** (pen icon). You can also create a new contact point if needed.
|
||||
1. On the **Contact Points** tab, find the contact point you want to test, then click **Edit**. You can also create a new contact point if needed.
|
||||
1. Click **Test** to open the contact point testing modal.
|
||||
1. Choose whether to send a predefined test notification or choose custom to add your own custom annotations and labels to include in the notification.
|
||||
1. Click **Send test notification** to fire the alert.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
aliases:
|
||||
- alerting/manage-notifications/manage-contact-points/configure-integrations/
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/configure-integrations/
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/integrations/
|
||||
description: Configure integrations
|
||||
keywords:
|
||||
- Grafana
|
||||
@ -15,13 +15,13 @@ labels:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
title: Configure integrations
|
||||
title: Configure contact point integrations
|
||||
weight: 100
|
||||
---
|
||||
|
||||
# Configure integrations
|
||||
# Configure contact point integrations
|
||||
|
||||
Configure integrations in Grafana to select your preferred communication channel for receiving notifications when your alert rules are firing. Each integration has its own configuration options and setup process. In most cases, this involves providing an API key or a Webhook URL.
|
||||
Configure contact point integrations in Grafana to select your preferred communication channel for receiving notifications when your alert rules are firing. Each integration has its own configuration options and setup process. In most cases, this involves providing an API key or a Webhook URL.
|
||||
|
||||
Once configured, you can use integrations as part of your contact points to receive notifications whenever your alert changes its state. In this section, we'll cover the basic steps to configure your integrations, so you can start receiving real-time alerts and stay on top of your monitoring data.
|
||||
|
||||
@ -38,7 +38,7 @@ Once configured, you can use integrations as part of your contact points to rece
|
||||
| Line | `line` |
|
||||
| Microsoft Teams | `teams` |
|
||||
| Opsgenie | `opsgenie` |
|
||||
| [Pagerduty](#pagerduty) | `pagerduty` |
|
||||
| Pagerduty | `pagerduty` |
|
||||
| Prometheus Alertmanager | `prometheus-alertmanager` |
|
||||
| Pushover | `pushover` |
|
||||
| Sensu | `sensu` |
|
||||
@ -48,28 +48,3 @@ Once configured, you can use integrations as part of your contact points to rece
|
||||
| Threema | `threema` |
|
||||
| VictorOps | `victorops` |
|
||||
| Webhook | `webhook` |
|
||||
|
||||
### PagerDuty
|
||||
|
||||
To set up PagerDuty, provide an integration key.
|
||||
|
||||
| Setting | Description |
|
||||
| --------------- | ------------------------------------------------------ |
|
||||
| Integration Key | Integration key for PagerDuty |
|
||||
| Severity | Level for dynamic notifications, default is `critical` |
|
||||
| Custom Details | Additional details about the event |
|
||||
|
||||
The `CustomDetails` field is an object containing arbitrary key-value pairs. The user-defined details are merged with the ones we use by default.
|
||||
|
||||
Our default values for `CustomDetails` are:
|
||||
|
||||
```go
|
||||
{
|
||||
"firing": `{{ template "__text_alert_list" .Alerts.Firing }}`,
|
||||
"resolved": `{{ template "__text_alert_list" .Alerts.Resolved }}`,
|
||||
"num_firing": `{{ .Alerts.Firing | len }}`,
|
||||
"num_resolved": `{{ .Alerts.Resolved | len }}`,
|
||||
}
|
||||
```
|
||||
|
||||
In case of duplicate keys, the user-defined details overwrite the default ones.
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/configure-oncall/
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/integrations/configure-oncall/
|
||||
description: Configure the Alerting - Grafana OnCall integration
|
||||
keywords:
|
||||
- grafana
|
||||
@ -11,11 +11,12 @@ labels:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
title: Configure Grafana OnCall integration
|
||||
menuTitle: Grafana OnCall
|
||||
title: Configure Grafana OnCall for Alerting
|
||||
weight: 300
|
||||
---
|
||||
|
||||
## Grafana OnCall integration for Alerting
|
||||
## Configure Grafana OnCall for Alerting
|
||||
|
||||
Use the Grafana Alerting - Grafana OnCall integration to effortlessly connect alerts generated by Grafana Alerting with Grafana OnCall, where you can then route them according to defined escalation chains and schedules.
|
||||
|
||||
@ -0,0 +1,41 @@
|
||||
---
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/integrations/pager-duty/
|
||||
description: Configure PagerDuty
|
||||
keywords:
|
||||
- grafana
|
||||
- alerting
|
||||
- pagerduty
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
menuTitle: PagerDuty
|
||||
title: Configure PagerDuty for Alerting
|
||||
weight: 400
|
||||
---
|
||||
|
||||
# Configure PagerDuty for Alerting
|
||||
|
||||
To set up PagerDuty, provide an integration key.
|
||||
|
||||
| Setting | Description |
|
||||
| --------------- | ------------------------------------------------------ |
|
||||
| Integration Key | Integration key for PagerDuty |
|
||||
| Severity | Level for dynamic notifications, default is `critical` |
|
||||
| Custom Details | Additional details about the event |
|
||||
|
||||
The `CustomDetails` field is an object containing arbitrary key-value pairs. The user-defined details are merged with the ones we use by default.
|
||||
|
||||
Our default values for `CustomDetails` are:
|
||||
|
||||
```go
|
||||
{
|
||||
"firing": `{{ template "__text_alert_list" .Alerts.Firing }}`,
|
||||
"resolved": `{{ template "__text_alert_list" .Alerts.Resolved }}`,
|
||||
"num_firing": `{{ .Alerts.Firing | len }}`,
|
||||
"num_resolved": `{{ .Alerts.Resolved | len }}`,
|
||||
}
|
||||
```
|
||||
|
||||
In case of duplicate keys, the user-defined details overwrite the default ones.
|
||||
@ -3,7 +3,7 @@ aliases:
|
||||
- ../contact-points/notifiers/webhook-notifier/
|
||||
- ../fundamentals/contact-points/webhook-notifier/
|
||||
- alerting/manage-notifications/manage-contact-points/webhook-notifier/
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/webhook-notifier/
|
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/manage-contact-points/integrations/webhook-notifier/
|
||||
description: Configure the webhook notifier for notifications
|
||||
keywords:
|
||||
- grafana
|
||||
@ -16,11 +16,12 @@ labels:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
title: Configure the webhook notifier
|
||||
menuTitle: Webhook notifier
|
||||
title: Configure the webhook notifier for Alerting
|
||||
weight: 200
|
||||
---
|
||||
|
||||
### Configure the webhook notifier
|
||||
### Configure the webhook notifier for Alerting
|
||||
|
||||
Example JSON body:
|
||||
|
||||
Reference in New Issue
Block a user