Grafana Provider

​

Authentication

This provider requires authentication.

• token: Token (required: True, sensitive: True)
• host: Grafana host (required: True, sensitive: False)
• datasource_uid: Datasource UID (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

• alert.rules:read: Read Grafana alert rules in a folder and its subfolders. (mandatory) (Documentation)
• alert.provisioning:read: Read all Grafana alert rules, notification policies, etc via provisioning API. (Documentation)
• alert.provisioning:write: Update all Grafana alert rules, notification policies, etc via provisioning API. (Documentation)

​

In workflows

This provider can’t be used as a “step” or “action” in workflows. If you want to use it, please let us know by creating an issue in the GitHub repository.

​

Topology

This provider pulls topology to Keep. It could be used in correlations and mapping, and as a context for alerts and incidents.

​

Connecting via Webhook (omnidirectional)

This provider supports webhooks.

If your Grafana is unreachable from Keep, you can use the following webhook url to configure Grafana to send alerts to Keep:

1. In Grafana, go to the Alerting tab in the Grafana dashboard.
2. Click on Contact points in the left sidebar and create a new one.
3. Give it a name and select Webhook as kind of contact point with webhook url as KEEP_BACKEND_URL/alerts/event/grafana.
4. Add ‘X-API-KEY’ as the request header .
5. Save the webhook.
6. Click on Notification policies in the left sidebar
7. Click on “New child policy” under the “Default policy”
8. Remove all matchers until you see the following: “If no matchers are specified, this notification policy will handle all alert instances.”
9. Chose the webhook contact point you have just created under Contact point and click “Save Policy”

​

Legacy vs Unified Alerting

Keep supports both Grafana’s legacy alerting system and the newer Unified Alerting system. Here are the key differences:

​

Legacy Alerting

• Uses notification channels for alert delivery
• Configured at the dashboard level
• Uses a different API endpoint (/api/alerts and /api/alert-notifications)
• Simpler setup but fewer features
• Alerts are tightly coupled with dashboard panels

​

Unified Alerting (Default from Grafana 9.0)

• Uses alert rules and contact points
• Configured centrally in the Alerting section
• Uses the newer /api/v1/alerts endpoint
• More powerful features including label-based routing
• Supports multiple data sources in a single alert rule

​

Connecting with the Provider

To connect to Grafana, you need to create an API Token:

1. Log in to your Grafana account.
2. Go to the Service Accounts page (cmd+k -> service).
3. Click the Add service account button and provide a name for your service account.
4. Grant “alerting” permissions:

5. Now generate Service Account Token:

6. Use the token value in the authentication section in the Grafana Provider configuration.

​

Post Installation Validation

You can check that the Grafana Provider works by testing Keep’s contact point (which was installed via the webhook integration).

1. Go to Contact Points (cmd k -> contact).
2. Find the keep-grafana-webhook-integration:

3. Click on the View contact point:

4. Click on Test:

5. Go to Keep – you should see an alert from Grafana!

Alternative Validation Methods (When Keep is Not Accessible Externally):

If Keep is not accessible externally and the webhook cannot be created, you can manually validate the Grafana provider setup using the following methods:

1. Manual Test Alerts in Grafana:

   • Create a manual test alert in Grafana.
   • Set up a contact point within Grafana that would normally send alerts to Keep.
   • Trigger the alert and check Grafana’s logs for errors or confirmation that the alert was sent.

2. Check Logs in Grafana:

   • Access Grafana’s log files or use the Explore feature to query logs related to the alerting mechanism.
   • Ensure there are no errors related to the webhook integration and that alerts are processed correctly.

3. Verify Integration Status:

   • Navigate to the Alerting section in Grafana.
   • Confirm that the integration status shows as active or functioning.
   • Monitor any outbound HTTP requests to verify that Grafana is attempting to communicate with Keep.

4. Network and Connectivity Check:

   • Use network monitoring tools to ensure Grafana can reach Keep or any alternative endpoint configured for alerts.

​

Webhook Integration Modifications

The webhook integration adds Keep as a contact point in the Grafana instance. This integration can be located under the “Contact Points” section. Keep also gains access to the following scopes:

• alert.provisioning:read
• alert.provisioning:write