From cbf8e7e679cd47b6faa875f073dd148baf960b34 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Tue, 1 Oct 2024 17:28:26 +0200 Subject: [PATCH] Alerting docs: update that test functionality only for G Alertmanager (#94064) * Alerting docs: update that test functionality only for G Alertmanager * ran prettier * fixed alphabetical order * indentation * format * all pretty, no pity --------- Co-authored-by: tonypowa --- .../configure-notifications/manage-contact-points/_index.md | 4 ++++ .../integrations/configure-amazon-sns.md | 2 -- .../manage-contact-points/integrations/configure-discord.md | 2 ++ .../manage-contact-points/integrations/configure-email.md | 3 +++ .../integrations/configure-google-chat.md | 2 ++ .../manage-contact-points/integrations/configure-mqtt.md | 6 +++++- .../integrations/configure-opsgenie.md | 2 ++ .../manage-contact-points/integrations/configure-slack.md | 3 +++ .../manage-contact-points/integrations/configure-teams.md | 4 ++++ .../integrations/configure-telegram.md | 3 +++ .../manage-contact-points/integrations/pager-duty.md | 2 ++ .../manage-contact-points/integrations/webhook-notifier.md | 3 +++ 12 files changed, 33 insertions(+), 3 deletions(-) diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md b/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md index 4631a6742b1..7ab9ffe5385 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/_index.md @@ -87,6 +87,8 @@ refs: Use contact points to select your preferred communication channel for receiving notifications when your alert rules are firing. You can add, edit, delete, export, and test a contact point. +Testing a contact point is only available for Grafana Alertmanager. + On the **Contact Points** tab, you can: - Search for name and type of contact points and integrations. @@ -144,6 +146,8 @@ Complete the following steps to add templates to your contact point. ## Test a contact point +** For Grafana Alertmanager only.** + Complete the following steps to test a contact point. 1. In the left-side menu, click **Alerts & IRM** and then **Alerting**. diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-amazon-sns.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-amazon-sns.md index 1763f0c25a3..e0209ac8f50 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-amazon-sns.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-amazon-sns.md @@ -33,8 +33,6 @@ For an example setup, see [Example Minimal Setup Using Assumed IAM Role]({{< rel With AWS resources configured, proceed to add SNS as a contact point in Grafana. -### 1. Add a New Contact Point - - Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**. - Click on **"Add contact point"**. - **Name**: Enter a descriptive name (e.g., `AWS SNS`). diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-discord.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-discord.md index 7c5baff4446..399c3b31579 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-discord.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-discord.md @@ -39,6 +39,8 @@ To create your Discord integration in Grafana Alerting, complete the following s 1. In the **Webhook URL** field, paste in your Webhook URL. 1. Click **Test** to check that your integration works. + ** For Grafana Alertmanager only.** + A test alert notification should be sent to the Discord channel that you associated with the Webhook. 1. Click **Save contact point**. diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-email.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-email.md index 81b6ccac4d8..3b2b1898dc5 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-email.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-email.md @@ -79,6 +79,9 @@ To set up email integration, complete the following steps. E-mail addresses are case sensitive. Ensure that the e-mail address entered is correct. 1. Click **Test** to check that your integration works. + + ** For Grafana Alertmanager only.** + 1. Click **Save contact point**. ## Next steps diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-google-chat.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-google-chat.md index e20a31606e9..b0440d06ff2 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-google-chat.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-google-chat.md @@ -39,6 +39,8 @@ To create your Google Chat integration in Grafana Alerting, complete the followi 1. In the **URL** field, paste in your Webhook URL. 1. Click **Test** to check that your integration works. + ** For Grafana Alertmanager only.** + A test alert notification should be sent to the Google Chat space that you associated with the Webhook. 1. Click **Save contact point**. diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-mqtt.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-mqtt.md index 0ded51cd145..0f9567a0a21 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-mqtt.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-mqtt.md @@ -14,7 +14,7 @@ labels: - oss menuTitle: MQTT notifier title: Configure the MQTT notifier for Alerting -weight: 80 +weight: 0 --- # Configure the MQTT notifier for Alerting @@ -33,7 +33,11 @@ To configure the MQTT integration for Alerting, complete the following steps. 1. Enter the MQTT topic name in the **Topic** field. 1. In **Optional MQTT settings**, specify additional settings for the MQTT integration if needed. 1. Click **Test** to check that your integration works. + + ** For Grafana Alertmanager only.** + A test alert notification should be sent to the MQTT broker. + 1. Click **Save** contact point. The integration sends data in JSON format by default. You can change that using **Message format** field in the **Optional MQTT settings** section. There are two supported formats: diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-opsgenie.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-opsgenie.md index 0ffa3dcf20e..e1f455af2dc 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-opsgenie.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-opsgenie.md @@ -44,6 +44,8 @@ To create your Opsgenie integration in Grafana Alerting, complete the following 1. In the **Alert API URL**, enter `https://api.opsgenie.com/v2/alerts`. 1. Click **Test** to check that your integration works. + ** For Grafana Alertmanager only.** + A test alert notification is sent to the Alerts page in Opsgenie. 1. Click **Save contact point**. diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md index 6777771bf9a..359cebc1bd3 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md @@ -78,6 +78,9 @@ 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-”. 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. + + ** For Grafana Alertmanager only.** + 1. Click **Save contact point**. ## Next steps diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-teams.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-teams.md index 1141af8db6c..4f720bb616d 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-teams.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-teams.md @@ -43,7 +43,11 @@ To create your MS Teams integration in Grafana Alerting, complete the following 1. From the Integration list, select **Microsoft Teams**. 1. In the **URL** field, copy in your Webhook URL. 1. Click **Test** to check that your integration works. + + ** For Grafana Alertmanager only.** + A test alert notification should be sent to the MS Team channel. + 1. Click **Save** contact point. ## Next steps diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-telegram.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-telegram.md index dd5ca20d7bb..1c86f94d0cc 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-telegram.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-telegram.md @@ -64,6 +64,9 @@ To create your Telegram integration in Grafana Alerting, complete the following 1. In the **BOT API Token** field, copy in the bot API token. 1. In the **Chat ID** field, copy in the chat ID. 1. Click **Test** to check that your integration works. + + ** For Grafana Alertmanager only.** + 1. Click **Save contact point**. ## Next steps diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md index d6202d7adc4..ebfdec1f364 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md @@ -57,6 +57,8 @@ To create your PagerDuty integration in Grafana Alerting, complete the following 1. In the **Integration Key** field, copy in your integration key. 1. Click **Test** to check that your integration works. + ** For Grafana Alertmanager only.** + An incident should display in the Service’s Activity tab in PagerDuty. 1. Click **Save contact point**. diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md index 556d66755ce..17468cac706 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md @@ -152,6 +152,9 @@ To create your Webhook integration in Grafana Alerting, complete the following s 1. From the Integration list, select **Webhook**. 1. In the **URL** field, copy in your Webhook URL. 1. Click **Test** to check that your integration works. + + ** For Grafana Alertmanager only.** + 1. Click **Save contact point**. ## Next steps