Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Integrations

Grafana Alerting

Open source

Grafana Alerting integration for Grafana OnCall

⚠️ A note about (Legacy) integrations: Integrations that were created before version 1.3.21 were marked as (Legacy) and recently migrated. These integrations are receiving and escalating alerts, but some manual adjustments might be required. Here you can read more about changes.

Grafana Alerting for Grafana OnCall can be set up using two methods:

Grafana Alerting: Grafana OnCall is connected to the same Grafana instance being used to manage Grafana OnCall.
Grafana (Other Grafana): Grafana OnCall is connected to one or more Grafana instances, separate from the one being used to manage Grafana OnCall.

Configure Grafana Alerting for Grafana OnCall

You must have an Admin role to create integrations in Grafana OnCall.

In the Integrations tab, click + New integration to receive alerts.
Select Grafana Alerting by clicking the Quick connect button or select Grafana (Other Grafana) from the integrations list.
Follow the configuration steps that display in the How to connect window to retrieve your unique integration URL and complete any necessary configurations.

Configure Grafana Cloud Alerting

Use the following method if you are connecting Grafana OnCall with alerts coming from the same Grafana instance from which Grafana OnCall is being managed.

In Grafana OnCall, navigate to the Integrations tab and select New Integration to receive alerts.
Click Quick connect in the Grafana Alerting tile. This will automatically create the integration in Grafana OnCall as well as the required contact point in Alerting.
Note: You must connect the contact point with a notification policy. For more information, see Contact points in Grafana Alerting
Determine the escalation chain for the new integration by either selecting an existing one or by creating a new escalation chain.
In Grafana Cloud Alerting, navigate to Alerting > Contact Points and find a contact point with a name matching the integration you created in Grafana OnCall.
Click the Edit (pencil) icon, then click Test. This will send a test alert to Grafana OnCall.

Configure Grafana (Other Grafana)

Connect Grafana OnCall with alerts coming from a Grafana instance that is different from the instance that Grafana OnCall is being managed:

In Grafana OnCall, navigate to the Integrations tab and select New Integration to receive alerts.
Select the Alertmanager tile.
Enter a name and description for the integration, click Create
A new page will open with the integration details. Copy the OnCall Integration URL from HTTP Endpoint section.
Go to the other Grafana instance to connect to Grafana OnCall and navigate to Alerting > Contact Points.
Select New Contact Point.
Choose the contact point type webhook, then paste the URL generated in step 3 into the URL field.
Note: You must connect the contact point with a notification policy. For more information, see Contact points in Grafana Alerting.
Click the Edit (pencil) icon, then click Test. This will send a test alert to Grafana OnCall.

Note about grouping and autoresolution

Grafana OnCall relies on the Grafana Alerting grouping and autoresolution mechanism to ensure consistency between alert state in OnCall and AlertManager. It’s recommended to configure grouping on the Grafana Alerting side and use default grouping and autoresolution templates on the OnCall side. Changing this templates might lead to incorrect grouping and autoresolution behavior.

Note about legacy integration

Before we were using each alert from Grafana Alerting group as a separate payload:

{
  "labels": {
    "severity": "critical",
    "alertname": "InstanceDown"
  },
  "annotations": {
    "title": "Instance localhost:8081 down",
    "description": "Node has been down for more than 1 minute"
  },
  ...
}

This behaviour was leading to mismatch in alert state between OnCall and Grafana Alerting and draining of rate-limits, since each Grafana Alerting alert was counted separately.

We decided to change this behaviour to respect Grafana Alerting grouping by using AlertManager group as one payload.

{
  "alerts": [...],
  "groupLabels": {
    "alertname": "InstanceDown"
  },
  "commonLabels": {
    "job": "node", 
    "alertname": "InstanceDown"
  },
  "commonAnnotations": {
    "description": "Node has been down for more than 1 minute"
  },
  "groupKey": "{}:{alertname=\"InstanceDown\"}",
  ...
}

You can read more about AlertManager Data model here.

After-migration checklist

Integration URL will stay the same, so no need to change AlertManager or Grafana Alerting configuration. Integration templates will be reset to suit new payload. It is needed to adjust routes and outgoing webhooks manually to new payload.

Send a new demo alert to the migrated integration.
Adjust routes to the new shape of payload. You can use payload of the demo alert from previous step as an example.
If outgoing webhooks utilized the alerts payload from the migrated integration in the [trigger][trigger_webhook_template] or [data][data_webhook_template] template it’s needed to adjust them as well.