Overview

Send Percona Monitoring and Management (PMM) alerts to Callgoose SQIBS. PMM alerting is built on Grafana alerting: you add SQIBS as a webhook contact point and route alerts to it. SQIBS opens an incident for a firing alert and resolves it when PMM reports it resolved.

You need
PMM 2 or 3 with admin access, and a SQIBS API token
Setup time
About 10 minutes
Result
PMM alerts open and resolve SQIBS incidents

How it works

PMM
Alert fires
An alert rule (for example MySQL down) fires.
PMM
Sends a webhook
Through a webhook contact point, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
firing opens it, resolved closes it.

Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.

Step 1: Add the API filter in SQIBS

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in PMM template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Resolve "status" resolved Resolves the open incident.
Trigger "status" firing Opens an incident.
Match "groupKey" Ties the resolved message to the incident it opened.
Title from "commonLabels"."alertname" Becomes the incident title.
Description from "commonAnnotations"."summary" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
In the API Integration window, click the round {} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.

Step 2: Add SQIBS as a contact point in PMM

  1. In PMM, open Alerting > Contact points and click + Add contact point.
  2. Name it Callgoose SQIBS, choose the Webhook integration, and set the URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=pmm&token=<your-token>

Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.

  1. Make sure Disable resolved message is off, click Test, and save.
  2. In Notification policies, route the alerts you want (for example severity = critical) to Callgoose SQIBS.

Step 3: Test it

The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.

  1. Click Test on the contact point, or stop a test database instance.
  2. In SQIBS, a new incident opens, titled with the alert name. The payload looks like this (shortened):
{
  "receiver": "Callgoose SQIBS",
  "status": "firing",
  "alerts": [
    {
      "status": "firing",
      "labels": {
        "alertname": "MySQL down",
        "severity": "critical",
        "service_name": "mysql-01"
      },
      "annotations": {
        "summary": "MySQL instance mysql-01 is down"
      }
    }
  ],
  "groupKey": "{}:{alertname=\"MySQL down\"}",
  "commonLabels": {
    "alertname": "MySQL down"
  },
  "commonAnnotations": {
    "summary": "MySQL instance mysql-01 is down"
  }
}
  1. When the instance is back, PMM sends "status": "resolved" with the same groupKey, and SQIBS resolves the incident.

No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in the PMM contact point.

Fix known issues automatically

Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when PMM reports MySQL replication stopped, SQIBS can run a workflow that checks the replica's error and restarts replication when the error is a known safe one.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.

To set it up, in the same API filter:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.

Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.

Learn more: