public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[release-11.6.1] docs(alerting): Configure IRM for Alerting (OSS/Enterprise) (#103625)

Browse Source 
docs(alerting): Configure IRM for Alerting (OSS/Enterprise) (#103614)

(cherry picked from commit 6a358c7fd6)
This commit is contained in:
Pepe Cano
2025-04-08 17:50:24 +02:00
committed by GitHub
parent e95177c13c
commit 6ef3ef5764
1 changed files with 56 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-irm.md
+56 -105
View File
@@ -14,142 +14,93 @@ keywords:
- integration
labels:
products:
- cloud
- oss
- enterprise
menuTitle: Grafana IRM
title: Configure Grafana IRM for Alerting
weight: 120
refs:
notification-templates:
configure-contact-points:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/template-notifications/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/
irm:
- pattern: /docs/
destination: /docs/grafana-cloud/alerting-and-irm/irm/
irm-alert-templates:
- pattern: /docs/
destination: /docs/grafana-cloud/alerting-and-irm/irm/configure/escalation-routing/alert-templates/
irm-escalation-chains:
- pattern: /docs/
destination: /docs/grafana-cloud/alerting-and-irm/irm/configure/escalation-routing/escalation-chains/
irm-configure-integrations:
- pattern: /docs/
destination: /docs/grafana-cloud/alerting-and-irm/irm/configure/integrations/configure-integrations/
webhook-contact-point:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier
webhook-json-payload:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/#json-payload
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/#json-payload
configure-contact-points:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/manage-contact-points/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/
irm-contact-point-in-gc:
- pattern: /docs/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/manage-contact-points/integrations/configure-irm
---
[//]: <> (The IRM instructions are different for Grafana Cloud, so this page is currently skipped from Cloud docs.)
# Configure Grafana IRM for Alerting
Use the Grafana IRM integration in contact points to send alerts to [Grafana IRM](ref:irm). You can then route them based on the escalation chains and schedules defined in Grafana IRM.
In Grafana OSS and Grafana Enterprise, you can use a webhook contact point to send alerts to [Grafana IRM](ref:irm). Grafana IRM can then route alerts based on escalation chains for your team's workflows.
## Before you begin
The alert notification flow is as follows:
The Grafana IRM contact point is only available when using the built-in Grafana Alertmanager.
<sup>\*</sup> **Grafana OSS/Enterprise** (send webhook alerts)->**Grafana Cloud IRM** (route via [escalation chains](ref:irm-escalation-chains))
Ensure that Grafana IRM is activated in your Grafana Cloud instance.
{{< admonition type="note" >}}
## Configure Grafana IRM for a contact point
The Free Forever plan in Grafana Cloud IRM includes 3 IRM active users per month.
To create a contact point with a Grafana IRM integration, complete the following steps:
These instructions apply only to Grafana OSS and Grafana Enterprise. To configure IRM for Grafana Cloud Alerting, refer to the [Grafana Cloud documentation](ref:irm-contact-point-in-gc).
{{< /admonition >}}
## Configure an integration in Grafana IRM
First, enable an integration in IRM to accept alerts from Grafana Alerting. You can either create a new integration or use an existing **Grafana Alerting** or **Webhook** integration in IRM.
To create the integration, follow the same steps as described in [Configure an OnCall integration in IRM](ref:irm-configure-integrations):
1. Navigate to **Alerts & IRM** -> **IRM** -> **Integrations**.
1. Click **+ New integration**.
1. Select either **Grafana Alerting** or **Webhook** integration from the list.
- **Grafana Alerting** integration – Includes preconfigured IRM templates for processing Grafana alerts.
- **Webhook** integration – Uses default IRM templates for general alert processing.
1. Provide a title, description, and assign it to a team, then click **Create Integration**.
1. On the integration details page, copy the **HTTP Endpoint** URL to use in the next section.
## Configure a webhook contact point in Grafana Alerting
Next, configure the contact point in Grafana Alerting to send alert notifications to Grafana IRM.
In **Grafana OSS** and **Grafana Enterprise**, you need to create a **Webhook** contact point using the HTTP endpoint URL you copied in the previous step.
1. Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**.
1. Click **+ Add contact point**.
1. Enter a name for the contact point.
1. From the **Integration** list, select **Grafana IRM**.
1. Choose whether to add a new IRM integration or add an existing one.
- If you add a new one, enter an integration name.
- If you add an existing one, choose from the list of available integrations.
1. (Optional) Configure [optional settings](#webhook-settings).
1. From the **Integration** list, select **Webhook**.
1. In the **URL** field, enter the HTTP endpoint URL of the IRM integration.
1. Click **Save contact point**.
For more details on contact points, including how to test them and enable notifications, refer to [Configure contact points](ref:configure-contact-points).
After configuring the contact point in Grafana Alerting and the integration in Grafana IRM, you can start testing the Alerting-to-IRM integration.
### Optional settings
For more information, see:
The IRM contact point in Grafana Alerting integrates with Grafana IRM using webhook requests. The following settings allow you to customize webhook requests when needed.
| Key | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| HTTP Method | Specifies the HTTP method to use: `POST` or `PUT`. |
| Basic Authentication Username | Username for HTTP Basic Authentication. |
| Basic Authentication Password | Password for HTTP Basic Authentication. |
| Authentication Header Scheme | Scheme for the `Authorization` Request Header. Default is `Bearer`. |
| Authentication Header Credentials | Credentials for the `Authorization` Request header. |
| Max Alerts | Maximum number of alerts to include in a notification. Any alerts exceeding this limit are ignored. `0` means no limit. |
### Optional payload settings
The IRM contact point sends alert messages to Grafana IRM using the [JSON payload format used by the webhook integration](ref:webhook-json-payload):
```json
{
"orgId": 1,
"state": "alerting",
"title": "[FIRING:1] TestAlert Grafana ",
"alerts": [
{
"endsAt": "0001-01-01T00:00:00Z",
"labels": {
"instance": "Grafana",
"alertname": "TestAlert"
},
"status": "firing",
"values": null,
"panelURL": "",
"startsAt": "2025-04-07T14:42:52.388041666Z",
"silenceURL": "https://alerttest.grafana.net/alerting/silence/new?alertmanager=grafana&matcher=alertname%3DTestAlert&matcher=instance%3DGrafana",
"annotations": {
"summary": "Notification test"
},
"fingerprint": "57c6d9296de2ad39",
"valueString": "[ metric='foo' labels={instance=bar} value=10 ]",
"dashboardURL": "",
"generatorURL": ""
}
],
"status": "firing",
"message": "**Firing**\n\nValue: [no value]\nLabels:\n - alertname = TestAlert\n - instance = Grafana\nAnnotations:\n - summary = Notification test\nSilence: https://alerttest.grafana.net/alerting/silence/new?alertmanager=grafana&matcher=alertname%3DTestAlert&matcher=instance%3DGrafana\n",
"version": "1",
"groupKey": "test-57c6d9296de2ad39-1744036972",
"receiver": "test",
"numFiring": 1,
"externalURL": "https://alerttest.grafana.net/",
"groupLabels": {
"instance": "Grafana",
"alertname": "TestAlert"
},
"numResolved": 0,
"commonLabels": {
"instance": "Grafana",
"alertname": "TestAlert"
},
"truncatedAlerts": 0,
"commonAnnotations": {
"summary": "Notification test"
}
}
```
You can also customize some fields in the JSON payload using [notification templates](ref:notification-templates).
| Option | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Title | Sends the value as a string in the `title` field of the JSON payload. Supports [notification templates](ref:notification-templates). |
| Message | Sends the value as a string in the `message` field of the JSON payload. Supports [notification templates](ref:notification-templates). |
{{< admonition type="note" >}}
A Grafana IRM contact point can either create or use a Grafana Alerting integration from your Grafana IRM account.
The Grafana Alerting integration in IRM includes preconfigured templates that automatically process JSON messages sent from Grafana Alerting. For additional details, refer to [Configure IRM alert templates](ref:irm-alert-templates).
{{< /admonition >}}
### Optional notification settings
| Key | Description |
| ------------------------ | ------------------------------------------------------------------- |
| Disable resolved message | Enable this option to prevent notifications when an alert resolves. |
- **[Configure contact points](ref:configure-contact-points)** – Learn how to test the integration and enable notifications in Alerting.
- **[Webhook contact point](ref:webhook-contact-point)** – Learn the format of the webhook payload and additional settings in Alerting.
- **[Configure IRM alert templates](ref:irm-alert-templates)** – Learn how to process the incoming webhook messages in IRM.