Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[v10.4.x] alerting docs: slack integration (#84823)
Alerting docs: Fix format issues on `Configure Slack` guide Co-authored-by: tonypowa <45235678+tonypowa@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
93 changes: 93 additions & 0 deletions
93
...s/alerting/alerting-rules/manage-contact-points/integrations/configure-slack.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
--- | ||
canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/configure-slack/ | ||
description: Configure the Slack integration to connect alerts generated by Grafana Alerting | ||
keywords: | ||
- grafana | ||
- alerting | ||
- slack | ||
- integration | ||
labels: | ||
products: | ||
- cloud | ||
- enterprise | ||
- oss | ||
menuTitle: Slack | ||
title: Configure Slack for Alerting | ||
weight: 300 | ||
--- | ||
|
||
## Configure Slack for Alerting | ||
|
||
Use the Grafana Alerting - Slack integration to send Slack notifications when your alerts are firing. | ||
|
||
There are two ways of integrating Slack into Grafana Alerting. | ||
|
||
1. Use a [Slack API token](https://api.slack.com/authentication/token-types) | ||
|
||
Enable your app to access the Slack API. If, for example, you are interested in more granular control over permissions, or your project is expected to regularly scale, resulting in new channels being created, this is the best option. | ||
|
||
1. Use a [Webhook URL](https://api.slack.com/messaging/webhooks) | ||
|
||
Webhooks is the simpler way to post messages into Slack. Slack automatically creates a bot user with all the necessary permissions to post messages to one particular channel of your choice. | ||
|
||
{{< admonition type="note" >}} | ||
Grafana Alerting only allows one Slack channel per contact point. | ||
{{< /admonition >}} | ||
|
||
## Before you begin | ||
|
||
### Slack API Token | ||
|
||
If you are using a Slack API Token, complete the following steps. | ||
|
||
1. Follow steps 1 and 2 of the [Slack API Quickstart](https://api.slack.com/start/quickstart). | ||
1. Add the [chat:write.public](https://api.slack.com/scopes/chat:write.public) scope to give your app the ability to post in all public channels without joining. | ||
1. In OAuth Tokens for Your Workspace, copy the Bot User OAuth Token. | ||
1. Open your Slack workplace. | ||
1. Right click the channel you want to receive notifications in. | ||
1. Click View channel details. | ||
1. Scroll down and copy the Channel ID. | ||
{{< admonition type="note" >}} | ||
While going through these steps, Slack may prompt you to Reinstall your app in order for the changes to take effect. | ||
{{< /admonition >}} | ||
|
||
### Webhook URL | ||
|
||
If you are using a Webhook URL, follow steps 1 and 5 in the [Slack API Quickstart](https://api.slack.com/start/quickstart). | ||
|
||
{{< admonition type="note" >}} | ||
Make sure you copy the Slack app Webhook URL. You will need this when setting up your contact point integration in Grafana Alerting. | ||
{{< /admonition >}} | ||
|
||
## Procedure | ||
|
||
To create your Slack integration in Grafana Alerting, complete the following steps. | ||
|
||
1. Navigate to Alerts&IRM -> Alerting -> Contact points. | ||
1. Click **+ Add contact point**. | ||
1. Enter a contact point name. | ||
1. From the Integration list, select Slack. | ||
1. If you are using a Slack API token: | ||
- In the **Recipient** field, copy in the channel ID. | ||
- In the **Token** field, copy in the Bot User OAuth Token that starts with “xoxb-”. | ||
1. If you are using a Webhook URL, in the **Webhook** field, copy in your Slack app Webhook URL. | ||
1. Click **Test** to check that your integration works. | ||
1. Click **Save contact point**. | ||
|
||
## Next steps | ||
|
||
To add the contact point and integration you created to your default notification policy, complete the following steps. | ||
|
||
1. Navigate to **Alerts&IRM** -> **Alerting** -> **Notification policies**. | ||
1. In the **Default policy**, click the ellipsis icon (…) and then **Edit**, | ||
1. Change the default policy to the contact point you created. | ||
1. Click **Update default policy**. | ||
|
||
**Note:** | ||
If you have more than one contact point, add a new notification policy rather than edit the default one, so you can route specific alerts to Slack. For more information, refer to [Notification policies][nested-policy]. | ||
|
||
{{% docs/reference %}} | ||
[nested-policy]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-notification-policy#add-new-nested-policy" | ||
|
||
[nested-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/create-notification-policy#add-new-nested-policy" | ||
{{% /docs/reference %}} |