Overview

Send Sensu Go events to Callgoose SQIBS. A pipe handler turns each event into a small JSON message and posts it to your SQIBS API endpoint. SQIBS opens an incident when a check goes into warning or critical and resolves it when the check is OK again.

You need
Sensu Go with sensuctl access, `jq` and `curl` on the backend, and a SQIBS API token
Setup time
About 15 minutes
Result
Failing checks open SQIBS incidents; recoveries resolve them

How it works

Sensu
Alert fires
A check returns warning (1) or critical (2).
Sensu
Sends a webhook
A pipe handler posts JSON with curl.
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 Sensu template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "state" firing Opens an incident.
Resolve "state" resolved Resolves the open incident.
Match "key" Entity and check: ties the recovery to its problem.
Title from "output" Becomes the incident title.
Description from "entity" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

The handler builds key from the entity and check names, so each failing check on each host has its own incident.

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 the handler in Sensu

  1. Save this handler as callgoose-sqibs.yml. The built-in is_incident filter passes failing events and the first OK after a failure, which is what resolves the incident:
type: Handler
api_version: core/v2
metadata:
  name: callgoose-sqibs
spec:
  type: pipe
  filters:
    - is_incident
    - not_silenced
  command: >-
    jq -c '{key: (.entity.metadata.name + "/" + .check.metadata.name),
            state: (if .check.status == 0 then "resolved" else "firing" end),
            status: .check.status, entity: .entity.metadata.name,
            check: .check.metadata.name, output: .check.output}' |
    curl -s -X POST -H 'Content-Type: application/json' --data-binary @-
    "https://<your-endpoint>/sqibs-api/v1/process?from=sensu&token=$SQIBS_TOKEN"
  env_vars:
    - SQIBS_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. In production, keep the token in a Sensu secret instead of env_vars.

  1. Create it with sensuctl create --file callgoose-sqibs.yml.
  2. Add callgoose-sqibs to the handlers of each check (or to a pipeline) that should page through 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. Make a check fail, for example by stopping the service it watches.
  2. In SQIBS, a new incident opens, titled with the check output:
{
  "key": "web-01/check-nginx",
  "state": "firing",
  "status": 2,
  "entity": "web-01",
  "check": "check-nginx",
  "output": "CRITICAL: nginx is not running"
}
  1. Start the service again. Sensu sends "state": "resolved" for the same key, 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 Sensu handler.

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 a Sensu check reports nginx down on a host, SQIBS can run a workflow that restarts nginx and runs the check again.

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: