Overview

Send groundcover alerts from your Kubernetes clusters to Callgoose SQIBS. A groundcover webhook integration posts each alert to your SQIBS API endpoint, and SQIBS opens an incident.

You need
A groundcover workspace with admin access, and a SQIBS API token
Setup time
About 10 minutes
Result
groundcover alerts open SQIBS incidents

How it works

groundcover
Alert fires
An alert on a workload fires.
groundcover
Sends a webhook
A webhook integration posts the alert.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
SQIBS opens an incident for the alert.

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 groundcover template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger (none) No key yet: every message opens an incident. Narrow it after the first test.
  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 a webhook in groundcover

  1. In groundcover, add a Webhook integration (under integrations or the alert's notification settings) with your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=groundcover&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. Edit the alerts you want in SQIBS and choose the webhook as their notification. Turn on resolved notifications if available, so incidents can resolve.

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. Make an alert fire, for example by scaling a test deployment to an image that does not exist.
  2. In SQIBS, a new incident opens.

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 groundcover webhook.

Refine the filter from a real groundcover message

groundcover does not publish a fixed payload, so build the filter from the first message SQIBS receives:

  1. Turn on API Tracking for the token, send a test from groundcover, and open the API log.
  2. Paste the payload into the JSON key creator.
  3. Set the Trigger filter's Payload JSON key to the field that holds the alert state, and Key value contains to the problem value. Use the alert status field (firing and resolved).
  4. If the payload has a recovery value, add a Resolve filter on the same key with that value.
  5. In Map incident with, choose an id that stays the same from the problem message to the recovery message (an alert or check id, not a run or event id).
  6. Set Incident title from to a readable field, such as the alert or check name.

Values in one Key value contains box must all be present. For "critical or warning", add two filters.

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 groundcover reports a pod in CrashLoopBackOff, SQIBS can run a kubectl workflow that collects its logs and rolls the deployment back.

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: