Grafana

Grafana is an open source metric analytics & visualization suite. It is most commonly used for visualizing time series data for infrastructure and application analytics but many use it in other domains including industrial sensors, home automation, weather, and process control.

Supported Versions:
Grafana >= v5.0.0

Type:
Webhook

Key Features

  • Uses native webhook notification channel in Grafana to forward alerts to BigPanda
  • Automatically resolves incidents in BigPanda when they resolve in Grafana
  • Extensible alert configuration
  • Intelligently correlates alerts from Grafana to help you understand and respond faster to production issues

How It Works

The integration works by configuring a webhook notification channel in Grafana which forwards alerts to the Grafana integration where they are normalized and transmitted to BigPanda. BigPanda then processes and correlates the alert data from Grafana to create and maintain up-to-date incidents in BigPanda.

Data Model

BigPanda normalizes alert data from Grafana into tags. You can use tag values to filter the incident feed and to define filter conditions for Environments. The primary and secondary properties are also used during the correlation process. The following specifies the mapping of Grafana alert properties to BigPanda tags.

BigPanda Property

Grafana Property

primary_property

"title"

secondary_property

"ruleName"

status

state

description

message

title

title

ruleName

ruleName

ruleUrl

ruleUrl

imageUrl

imageUrl

source_system

"grafana"

metric

evalMatches[n].metric

metric_value

evalMatches[n].value

tag_name

tags.tag_name
evalMatches[n].tags.tag_name

Installing the Integration

Prerequisites

Setup Notification Channel in Grafana

  1. Login to your Grafana instance
  2. In the left sidebar click the alerting icon (bell) then open the Notification channels tab
  3. Click the New channel button
  4. Fill in the form as follows:

Channel Settings

Name (Required)

A useful channel name, such as “BigPanda”

Type (Required)

webhook

Send Reminder (Required)

When this option is checked additional notifications (reminders) will be sent for triggered alerts. You can specify how often reminders should be sent using number of seconds (s), minutes (m) or hours (h), for example, 30s, 3m, 5m, 1h, etc.
We recommend setting this to 30s as a default.

Send on all alerts (Optional)

Check the box if you’d like to send all alerts to BigPanda. If not then you will need to manually add the BigPanda notification channel to every alert

Include image (Optional

Check the box if you’d like a link to an image of the metric to be available from the incident in BigPanda

🚧

Include Image Option

If including images please make sure you've enabled Grafana's image rendering:
https://grafana.com/docs/grafana/latest/alerting/notifications/#external-image-store

Webhook Settings

URL

https://inbound.bigpanda.io/grafana/alerts?access_token=BIGPANDA_TOKEN&app_key=BIGPANDA_APP_KEY
Replace the BIGPANDA_APP_KEY and BIGPANDA_TOKEN placeholders with the appropriate values from the integration page.

Http Method

POST

Username

leave blank

Password

leave blank

  1. Click Send Test to ensure the configuration is correct. If successful a green toast message should appear saying Test Notification Sent
  2. Click Save to save the notification channel
  3. If you did not choose to send all alerts to the notification channel please add the notification channel to alerts you wish to send to BigPanda

Advanced Configuration

Sending Custom Properties with Alerts

You can use the BigPanda Grafana integration to send custom attributes along with your alerts. You do this by adding a configuration block to the notification message on each alert you want to send custom attributes for. You can even override primary and secondary properties.

  1. Locate and open for editing the panel with the alert you wish to edit
  2. Open the Alert > Notifications section
  3. In the Message field add the [bigpanda_config] config block to the end, customizing as needed.
  4. Save the dashboard
Your normal alert message text, no need to change me...

[bigpanda_config]
; override primary and secondary properties
primary_property = my_custom_prop_1
secondary_property = my_custom_prop_2

; override grafana alert status
status = warning

; set values for any custom properties
my_custom_prop_1 = value_1
my_custom_prop_2 = value_2
my_custom_prop_3 = value_3

The configuration section is INI format and supports comments and arrays according to the INI format. You can add as many custom properties as you wish.

By default all Grafana alerts are forwarded as critical status, use the INI status property to specify a different status. All valid bigpanda statuses are accepted except "ok".

Note: All text after the [bigpanda_config] section will be treated as part of the configuration. All text before will be processed normally as part of the alert description.

Uninstalling the Integration

Remove Integration from Grafana

  1. Login to your Grafana instance
  2. In the left sidebar click the alerting icon (bell) then open the Notification channels tab
  3. Locate the BigPanda notification channel and click the red X button to delete it
  4. Remove [bigpanda_config] blocks in your alert messages (if you added any)

Manually Resolve All Open Alerts

Manually resolve any open Grafana alerts as they will not auto-resolve with the integration removed.

Remove Integration from BigPanda

Delete the Integration in BigPanda to remove the Grafana integration from your UI.

Updated 5 months ago


Grafana


Grafana is an open source metric analytics & visualization suite. It is most commonly used for visualizing time series data for infrastructure and application analytics but many use it in other domains including industrial sensors, home automation, weather, and process control.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.