Overview
Send Buildbot build results to Callgoose SQIBS. The HttpStatusPush reporter posts each finished build to your SQIBS API endpoint as JSON. SQIBS opens an incident when a build fails and resolves it when the next build on the same builder passes.
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 Buildbot template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "state_string" |
failed |
Opens an incident. |
| Resolve | "state_string" |
build successful |
Resolves the open incident. |
| Match | "builderid" |
The builder ties the next good build to the failure. | |
| Title from | "state_string" |
Becomes the incident title. | |
| Description from | "buildid" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Buildbot also sends a numeric "results" (0 success, 2 failure). The text in "state_string" depends on your build steps, so check it in the API log and adjust the values if needed.
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 reporter to master.cfg
Add this to master.cfg on the Buildbot master:
from buildbot.plugins import reporters, util
c['services'].append(reporters.HttpStatusPush(
serverUrl="https://<your-endpoint>/sqibs-api/v1/process?from=buildbot&token=<your-token>",
generators=[reporters.BuildStatusGenerator(mode=("failing", "passing", "problem", "warnings", "exception"))],
))
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Then run buildbot checkconfig and buildbot reconfig on the master.
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.
- Force a build that fails on a test builder.
- In SQIBS, a new incident opens. Buildbot sends the build as returned by its data API (shortened):
{
"buildid": 1284,
"builderid": 7,
"number": 211,
"complete": true,
"results": 2,
"state_string": "failed test (failure)",
"properties": {
"branch": [
"main",
"Build"
]
}
}
- Fix the build. When the next build on that builder passes (
build successful), 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 master.cfg.
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 build fails because a worker lost its toolchain, SQIBS can run a workflow that reprovisions the worker and forces the build again.
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.