mirror of https://github.com/grafana/grafana
Docs: Refactors notifications in alerting (#57653)
* Refactors notifications in alerting * Fixes broken links * adds headings * fixes broken links * Adds line space and intro sentencespull/57701/head
brendamuir
3 years ago
committed by
GitHub
parent
7b819284c1
commit
596b4fecb0
@ -1,30 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/contact-points/ |
||||
description: Create or edit contact point |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- notification channel |
||||
- create |
||||
title: Contact points |
||||
weight: 430 |
||||
--- |
||||
|
||||
# Contact points |
||||
|
||||
Use contact points to define how your contacts are notified when an alert fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert fires, a notification is sent to all contact point types listed for a contact point. Optionally, use [message templates]({{< relref "message-templating/" >}}) to customize notification messages for the contact point types. |
||||
|
||||
You can configure Grafana managed contact points as well as contact points for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager/" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager/" >}}). |
||||
|
||||
Before you begin, see [Grafana Alerting]({{< relref "../../alerting/" >}}) which explains the various components of Grafana Alerting. We also recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "../fundamentals/" >}}) of Grafana Alerting. |
||||
|
||||
- [Create contact point]({{< relref "create-contact-point/" >}}) |
||||
- [Edit contact point]({{< relref "edit-contact-point/" >}}) |
||||
- [Test contact point]({{< relref "test-contact-point/" >}}) |
||||
- [Delete contact point]({{< relref "delete-contact-point/" >}}) |
||||
- [List of notifiers]({{< relref "notifiers/" >}}) |
||||
- [Message templating]({{< relref "message-templating/" >}}) |
||||
@ -1,32 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/create-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Add contact point |
||||
weight: 100 |
||||
--- |
||||
|
||||
# Add a contact point |
||||
|
||||
Use contact points to define how your contacts are notified when an alert fires. |
||||
|
||||
To add a contact point |
||||
|
||||
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. |
||||
1. Click **Contact points** to open the page listing existing contact points. |
||||
1. Click **New contact point**. |
||||
1. From the **Alertmanager** dropdown, select an Alertmanager. By default, Grafana Alertmanager is selected. |
||||
1. In **Name**, enter a descriptive name for the contact point. |
||||
1. From **Contact point type**, 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 types, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point type. |
||||
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 type, click **New contact point type** and repeat steps 6 through 8. |
||||
1. Click **Save contact point** to save your changes. |
||||
@ -1,27 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/delete-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Delete a contact point |
||||
weight: 115 |
||||
--- |
||||
|
||||
## Delete a contact point |
||||
|
||||
For Grafana managed contact points, you can send a test notification which helps verify a contact point is configured correctly. |
||||
|
||||
To delete a contact point |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. Find the contact point to delete, then click **Delete** (trash icon). |
||||
1. In the confirmation dialog, click **Yes, delete**. |
||||
|
||||
> **Note:** You cannot delete contact points that are in use by a notification policy. You will have to either delete the [notification policy]({{< relref "../notifications/" >}}) or update it to use another contact point. |
||||
@ -1,27 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/edit-alertmanager-config/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Edit contact point |
||||
weight: 120 |
||||
--- |
||||
|
||||
# Edit Alertmanager global config |
||||
|
||||
To edit global configuration options for an external Alertmanager, like SMTP server, that is used by default for all email contact types: |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. From the **Alertmanager** drop-down, select an external Alertmanager data source. |
||||
1. Click the **Edit global config** option. |
||||
1. Add global configuration settings. |
||||
1. Click **Save global config** to save your changes. |
||||
|
||||
> **Note** This option is available only for external Alertmanagers. You can configure some global options for Grafana contact types, like email settings, via [Grafana configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) |
||||
@ -1,25 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/edit-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Edit contact point |
||||
weight: 105 |
||||
--- |
||||
|
||||
# Edit a contact point |
||||
|
||||
Use contact points to define how your contacts are notified when an alert fires. |
||||
|
||||
To edit a contact point |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. Find the contact point to edit, then click **Edit** (pen icon). |
||||
1. Make any changes and click **Save contact point**. |
||||
@ -1,25 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/delete-message-template/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Delete message template |
||||
weight: 110 |
||||
--- |
||||
|
||||
# Edit a message template |
||||
|
||||
Message templates customize notification messages for the contact point types. |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. In the Template table, find the template you want to delete, then click the **Delete** (trash icon). |
||||
1. In the confirmation dialog, click **Yes, delete** to delete the template. |
||||
|
||||
Use caution when deleting a template since Grafana does not prevent you from deleting templates that are in use. |
||||
@ -1,25 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/edit-message-template/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Edit message template |
||||
weight: 100 |
||||
--- |
||||
|
||||
# Edit a message template |
||||
|
||||
Message templates customize notification messages for the contact point types. |
||||
|
||||
To edit a message template |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. In the Template table, find the template you want to edit, then click the **Edit** (pen icon). |
||||
1. Make your changes, then click **Save template**. |
||||
@ -1,27 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/contact-points/test-contact-point/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Test a contact point |
||||
weight: 110 |
||||
--- |
||||
|
||||
# Test a contact point |
||||
|
||||
For Grafana managed contact points, you can send a test notification which helps verify a contact point is configured correctly. |
||||
|
||||
To send a test notification: |
||||
|
||||
1. In the Grafana side bar, hover your cursor over the **Alerting** (bell) icon and then click **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. Click **Test** (paper airplane icon) 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. |
||||
@ -0,0 +1,21 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/contact-points/ |
||||
description: Create or edit contact point |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- notification channel |
||||
- create |
||||
title: Contact points |
||||
weight: 410 |
||||
--- |
||||
|
||||
# Contact points |
||||
|
||||
Use contact points to define how your contacts are notified when an alert fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert fires, a notification is sent to all contact point types listed for a contact point. Optionally, use message templating to customize notification messages for the contact point types. |
||||
|
||||
You can configure Grafana managed contact points as well as contact points for an external Alertmanager data source. |
||||
@ -1,6 +1,6 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/fundamentals/contact-points/contact-point-types/ |
||||
- /docs/grafana/latest/alerting/contact-points/notifiers/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
@ -0,0 +1,25 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/manage-notifications |
||||
description: Manage alert notifications |
||||
keywords: |
||||
- grafana |
||||
- alert |
||||
- notifications |
||||
title: Manage alert notifications |
||||
weight: 160 |
||||
--- |
||||
|
||||
# Manage alert notifications |
||||
|
||||
Choosing how, when, and where to send your alert notifications is an important part of setting up your alerting system. These decisions will have a direct impact on your ability to resolve issues quickly and not miss anything important. |
||||
|
||||
As a first step, define your contact points; where to send your alert notifications to. A contact point can be a set of destinations for matching notifications. Add message templates to contact points for reuse and consistent messaging in your notifications. |
||||
|
||||
Next, create a notification policy which is a set of rules for where, when and how your alerts are routed to contact points. In a notification policy, you define where to send your alert notifications by choosing one of the contact points you created.Add mute timings to your notification policy. A mute timing is a recurring interval of time during which you don’t want any notifications to be sent out. |
||||
|
||||
You can also add silences to stop notifications from one or more alert rules. The difference between a silence and a mute timing is that a silence only lasts for only a specified window of time. |
||||
|
||||
When an alert rule fires, the alert ruler sends alert instances to the Alertmanager; one alert rule can trigger multiple individual alert instances. |
||||
|
||||
The Alertmanager receives these alert instances and then handles silences, groups alerts, and sends notifications to your contact points as defined in the notification policy. |
||||
@ -0,0 +1,66 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/alerting/contact-points/create-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/message-templating/ |
||||
- /docs/grafana/latest/alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/unified-alerting/message-templating/ |
||||
- /docs/grafana/latest/alerting/contact-points/delete-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/edit-contact-point/ |
||||
- /docs/grafana/latest/alerting/contact-points/test-contact-point/ |
||||
- /docs/grafana/latest/alerting/manage-notifications/create-contact-point/ |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- contact point |
||||
- templating |
||||
title: Manage contact points |
||||
weight: 100 |
||||
--- |
||||
|
||||
# Manage 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. |
||||
|
||||
## Add a contact point |
||||
|
||||
Complete the following steps to add a contact point. |
||||
|
||||
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts. |
||||
1. Click **Contact points** to open the page listing existing contact points. |
||||
1. Click **New contact point**. |
||||
1. From the **Alertmanager** dropdown, select an Alertmanager. By default, Grafana Alertmanager is selected. |
||||
1. In **Name**, enter a descriptive name for the contact point. |
||||
1. From **Contact point type**, 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 types, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point type. |
||||
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 type, click **New contact point type** and repeat steps 6 through 8. |
||||
1. Click **Save contact point** to save your changes. |
||||
|
||||
## Edit a contact point |
||||
|
||||
Complete the following steps to edit a contact point. |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. Find the contact point to edit, then click **Edit** (pen icon). |
||||
1. Make any changes and click **Save contact point**. |
||||
|
||||
## Delete a contact point |
||||
|
||||
Complete the following steps to delete a contact point. |
||||
|
||||
1. In the Alerting page, click **Contact points** to open the page listing existing contact points. |
||||
1. Find the contact point to delete, then click **Delete** (trash icon). |
||||
1. In the confirmation dialog, click **Yes, delete**. |
||||
|
||||
> **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. |
||||
|
||||
## Test a contact point |
||||
|
||||
Complete the following steps to test a contact point. |
||||
|
||||
1. In the Grafana side bar, hover your cursor over the **Alerting** (bell) icon and then click **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. Click **Test** (paper airplane icon) 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. |
||||
Loading…
Reference in new issue