Overview
Send Checkmk alerts to Callgoose SQIBS. A small notification script posts each problem and recovery to your SQIBS API endpoint, and a notification rule decides which alerts use it. SQIBS opens an incident on a problem and resolves it on recovery.
How it works
PROBLEM opens it, RECOVERY 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
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in Checkmk template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "type" |
PROBLEM |
Opens an incident. |
| Resolve | "type" |
RECOVERY |
Resolves the open incident. |
| Match | "key" |
Host/service: ties the recovery to its problem. | |
| Title from | "output" |
Becomes the incident title. | |
| Description from | "host" |
The host becomes the description. |
- 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.
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 notification script
As the site user, save this as ~/local/share/check_mk/notifications/callgoose and make it executable (chmod +x). The comment on line 2 is the name Checkmk shows in the rule editor:
#!/usr/bin/env python3
# Callgoose SQIBS
import json, os, urllib.request
e = os.environ
body = {
"type": e.get("NOTIFY_NOTIFICATIONTYPE"), # PROBLEM, RECOVERY, ...
"what": e.get("NOTIFY_WHAT"), # HOST or SERVICE
"host": e.get("NOTIFY_HOSTNAME"),
"service": e.get("NOTIFY_SERVICEDESC", ""),
"state": e.get("NOTIFY_SERVICESTATE") or e.get("NOTIFY_HOSTSTATE"),
"output": e.get("NOTIFY_SERVICEOUTPUT") or e.get("NOTIFY_HOSTOUTPUT"),
}
body["key"] = body["host"] + "/" + body["service"]
url = "https://<your-endpoint>/sqibs-api/v1/process?from=checkmk&token=" + e["NOTIFY_PARAMETER_1"]
req = urllib.request.Request(url, data=json.dumps(body).encode(), headers={"Content-Type": "application/json"})
urllib.request.urlopen(req, timeout=20)
Replace <your-endpoint> with your SQIBS endpoint. The token comes from the rule's first parameter, so it is not stored in the script. Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Add a notification rule
- In Checkmk, open Setup > Events > Notifications and add a rule.
- Choose Callgoose SQIBS as the notification method and enter your SQIBS API token as the first parameter.
- Set the conditions (hosts, services, states) and make sure recovery notifications are included.
- Save and activate the changes.
Step 4: 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.
- In the Checkmk monitoring view, use Commands > Fake check results to set a test service to CRIT, or use the notification test tool.
- In SQIBS, a new incident opens, titled with the check output. The payload looks like this:
{
"type": "PROBLEM",
"what": "SERVICE",
"host": "db-prod-1",
"service": "Filesystem /var",
"state": "CRITICAL",
"output": "97.1% used (48.5 of 50.0 GB), (warn/crit at 80.00%/90.00% used)",
"key": "db-prod-1/Filesystem /var"
}
- When the service is OK again, the RECOVERY notification 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 Checkmk notification rule.
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 Checkmk reports a full file system, SQIBS can run a workflow that removes old log archives and rechecks the space.
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:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- 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:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.