Grafana Health Check

‍

Gremlin can use Grafana alert rules as Health Checks. To add a Grafana Health Check:

1. Open the Health Checks page in the Gremlin web app, click + Health Check, then select Grafana Cloud from the Integrations drop-down.
2. If Grafana Cloud is already authenticated, skip the following steps. Otherwise:
   1. Enter your Grafana instance URL in the API Base URL text box. For Grafana Cloud, the full URL should appear similar to: https://example.grafana.net/.
   2. Under Is this observability tool behind a firewall or on-prem?, choose:
      
      1. No if your instance is cloud-hosted and accessible over the Internet.
      2. Yes if your instance is self-hosted or behind a firewall.
   3. Enter your Grafana API key in the Value box under the Authentication section. If you don't have one, you can create one by following the instructions in the Grafana docs.
   4. Click Save. To validate the endpoint with the added header, Gremlin calls the following API: <span class="code-class-custom">https://<your_instance_URL>/api/alertmanager/grafana/api/v2/alerts</span>
3. Enter a Health Check Name to identify this check within Gremlin.
4. Choose how you want to define the monitor:
   
   1. If you don’t know the URL of the Grafana alert you want to use, select Search for Grafana Alert by name or tag. Enter part of the alert name or tag(s) (such as “request rate” or “error_rate”), click Search, and select the desired alert from the list. Gremlin returns the first 100 results matching your query.
   2. If you know the URL of the Grafana alert you want to use, select Provide Grafana Alert URL and paste the full URL. You can retrieve your Alert Rule URL from the relevant alert's page in the Grafana web app. See Grafana Alerting in the Grafana documentation for more information.
5. Click Test Health Check to verify connectivity.
6. Optionally, change the Polling Interval to change how frequently Gremlin polls Prometheus during testing.
7. Optionally, choose the category that best describes this test from the Category drop-down. This is used to provide recommended remediations if a test fails.
8. Click Create Health Check.