opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-01 20:42:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Alerting docs: Fix format issues in recent Slack tutorial (#84651)

Browse Source 
* Alerting docs: Fix format issues in Slack tutorial

* Alerting docs: Include link to Slack docs

* Alerting docs: fix Slack `nested-policy` link
This commit is contained in:
Pepe Cano
2024-03-18 13:18:57 +01:00
committed by GitHub
parent 3297d589c0
commit a7c7a1ffed
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/sources/alerting/configure-notifications/manage-contact-points/_index.md
View File

@ -123,7 +123,7 @@ Once configured, you can use integrations as part of your contact points to rece
| Pushover | `pushover` | | Pushover | `pushover` |
| Sensu | `sensu` | | Sensu | `sensu` |
| Sensu Go | `sensugo` | | Sensu Go | `sensugo` |
| Slack | `slack` | | [Slack][slack] | `slack` |
| Telegram | `telegram` | | Telegram | `telegram` |
| Threema | `threema` | | Threema | `threema` |
| VictorOps | `victorops` | | VictorOps | `victorops` |
@ -136,6 +136,9 @@ Once configured, you can use integrations as part of your contact points to rece
[oncall]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall" [oncall]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall"
[oncall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall" [oncall]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall"
[slack]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/configure-slack"
[slack]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/configure-slack"
[webhook]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier" [webhook]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier"
[webhook]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier" [webhook]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier"
{{% /docs/reference %}} {{% /docs/reference %}}

7
docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md
View File

@ -29,6 +29,7 @@ Enable your app to access the Slack API. If, for example, you are interested in
1. Use a [Webhook URL](https://api.slack.com/messaging/webhooks) 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. 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" >}} {{< admonition type="note" >}}
Grafana Alerting only allows one Slack channel per contact point. Grafana Alerting only allows one Slack channel per contact point.
{{< /admonition >}} {{< /admonition >}}
@ -71,7 +72,7 @@ To create your Slack integration in Grafana Alerting, complete the following ste
- In the **Token** field, copy in the Bot User OAuth Token that starts with “xoxb-”. - 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. 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 **Test** to check that your integration works.
1[]. Click **Save contact point**. 1. Click **Save contact point**.
## Next steps ## Next steps
@ -86,7 +87,7 @@ To add the contact point and integration you created to your default notificatio
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]. 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 %}} {{% docs/reference %}}
[nested-policy]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-notification-policy/#add-new-nested-policy" [nested-policy]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/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" [nested-policy]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/create-notification-policy#add-new-nested-policy"
{{% /docs/reference %}} {{% /docs/reference %}}