API DocsDeveloper PortalSystem StatusTry for Free

Grafana

Efficiently manage incidents with Grafana integration. Our step-by-step guide configures Grafana for optimal incident response using Squadcast.

Grafana is a Data Visualization platform that allows you to query, visualize and alert on metrics no matter where they are stored.

Route detailed alerts from Grafana to the right users in Squadcast.

How to integrate Grafana with Squadcast

In Squadcast: Using Grafana as an Alert Source

  1. Navigate to Services -> Service Overview -> select or search for your Service. Expand the accordion -> In the Alert Sources section, click Add.

How to configure Grafana integration in Squadcast

2. Select Grafana. Copy the displayed Webhook URL to configure it within Grafana. Finish by clicking Add Alert Source -> Done.

Steps to add Grafana integration to a service in Squadcast

Important:

When an alert source turns Active, it’ll show up under Configured Alert Sources. You can either generate a test alert from the integration or wait for a real-time alert to be generated by the Alert Source. An Alert Source is active if there is a recorded incident via that Alert Source for the Service.

In Grafana: Create a Squadcast Webhook as a Notification Channel

  1. Login to your Grafana dashboard, click on the Alerting (Bell) icon and select Notification Channels

Add Notification Channels for Grafana incidents

  1. Click on Add Channel or New Channel and enter the Notification Channel Name as Squadcast and under Type, select webhook

  2. Under url, enter the Webhook URL we have got from the Squadcast Service you copied before

Add Webhook details in the Webhook URL section

  1. Expand Optional Webhook Settings and select POST under Http method.

Select POST as the HTTP method

  1. Under Notification Settings, check Default to send all alert data to Squadcast. You can uncheck this if you want only specific Grafana Panels to send alerts to Squadcast. Move over to this section of our documentation to set up alerting for Specific Grafana Panels.

Sending Grafana Images into Squadcast

  • If you'd like to include images to your incident, check Include Image and you should see it as a part of your incident description in Squadcast.

  • The Image URL must be public or accessible from your computer for it to be visible on Squadcast.

  • Even if the Image is not accessible, the Image URL will be provided in the Incident Description.

Helpful Grafana Links

Important: Auto Resolve

If you would like to enable Auto-Resolve in Squadcast, then make sure the Disable Resolve Message is unchecked.

Select the optional webhook settings

  1. Click on Save to enable the integration. You can test the integration by clicking on Test. This will trigger a test incident in Squadcast.

Save the webhook configuration settings in Grafana
Test an incident in Squadcast for Grafana incident

Setup Alerting for Specific Grafana Panels

Pre-requisite

Squadcast should be added as a Notification Channel in your Grafana account. Follow steps 1-5 here and ensure the following:

  • Default is unchecked to allow only specific alerts of your choosing

  • Include image is checked if you want to add images to your Squadcast incidents

  1. After you've saved Squadcast Webhook as a Notification Channel for your Grafana account, navigate to the panel from your Grafana Dashboard and under options select Edit

Setup Alerting for Specific Grafana Panels

  1. Under Alerts, click Create Alert button

Setup Alerting for Specific Grafana Panels

  1. To configure your alerts, set rules for when you want an alert triggered in the Rules section

  2. In the Notifications section, under Send to, search and add your previously saved Squadcast Webhook and enter a Message for the alert and save it. The message here will be your Incident Message in Squadcast. Ensure that this message is meaningful and provides an immediate context in an on-call scenario

Setup Alerting for Specific Grafana Panels using Squadcast Webhooks

Now, whenever an alert is triggered in Grafana for that particular panel, an incident will be created in Squadcast.

  • When it is resolved in Grafana, it will automatically get Resolved in Squadcast, provided the Disable Resolve Message checkbox is unchecked.

Have any questions? Ask the community.

PreviousGrafana 8NextGraylog v4

Last updated

Was this helpful?