Overview
Send OpsDash alerts to Callgoose SQIBS. An OpsDash webhook notification posts a JSON summary each time graphs breach their thresholds or a source goes down. SQIBS opens an incident with the summary as its title.
How it works
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 OpsDash template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "breach".[0]."breachtype" |
crit |
Opens an incident for critical breaches (critub, critlb). |
| Trigger | "down".[0]."down" |
true |
A second filter: opens an incident when a source is down. |
| Title from | "status" |
Becomes the incident title, for example 1 down, 1 critical. |
- Choose the Priority for these incidents and click Save.
OpsDash lists breaches and down sources in arrays and sends no message key that stays the same from alert to recovery, so these incidents are closed in SQIBS. Warning-level breaches (warnub, warnlb) are left out on purpose; add a filter with warn if you want them.
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 a webhook notification channel in OpsDash
- In OpsDash, open the notification channels settings and add a Webhook channel.
- Set its URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=opsdash&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.
- Save, and select the channel in the alert settings of the dashboards you want in 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.
- Lower a threshold on a test graph so it breaches.
- In SQIBS, a new incident opens. OpsDash's payload looks like this (shortened):
{
"version": 1,
"at": 1763808000,
"breach": [
{
"dashname": "web-01",
"graphname": "Load Average",
"source": "web-01",
"metric": "sys.os.loadavg",
"breachtype": "critub",
"value": 4.5,
"threshold": 2
}
],
"status": "1 critical"
}
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 OpsDash channel.
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 OpsDash reports a high load average on a host, SQIBS can run a workflow that lists the top processes and restarts the worker pool.
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.