Overview
Send Bamboo build results to Callgoose SQIBS. A small script task in the plan's final tasks posts the result to your SQIBS API endpoint after every build. SQIBS opens an incident when a build fails and resolves it when the next build of the same plan passes.
How it works
failed opens it, successful 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 Bamboo template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "state" |
failed |
Opens an incident. |
| Resolve | "state" |
successful |
Resolves the open incident. |
| Match | "plan" |
The plan key ties the next good build to the failure. | |
| Title from | "plan_name" |
Becomes the incident title. | |
| Description from | "url" |
A link to the build result. |
- 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: Store the token in Bamboo
In the plan, open Plan configuration > Variables and add a variable named callgoose_token with your SQIBS API token. Bamboo masks variables whose names contain token in build logs.
Step 3: Add a final script task
- In each job of the plan, add a Script task under Final tasks, so it runs even when an earlier task fails.
- Paste this script:
#!/bin/bash
# Bamboo final task: tell Callgoose SQIBS whether this build failed or passed.
if [ "${bamboo_buildFailed}" = "true" ]; then STATE=failed; else STATE=successful; fi
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=bamboo&token=${bamboo_callgoose_token}" \
-H 'Content-Type: application/json' \
-d "{\"state\": \"${STATE}\", \"plan\": \"${bamboo_planKey}\", \"plan_name\": \"${bamboo_planName}\", \"build\": \"${bamboo_buildResultKey}\", \"url\": \"${bamboo_buildResultsUrl}\"}"
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Save the job.
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.
- Run the plan with a change that breaks the build.
- In SQIBS, a new incident opens, titled with the plan name. The payload looks like this:
{
"state": "failed",
"plan": "SHOP-API",
"plan_name": "Shop - API",
"build": "SHOP-API-JOB1-128",
"url": "https://bamboo.example.com/browse/SHOP-API-128"
}
- Fix the build and run it again. When it passes, 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 final task.
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 an agent ran out of disk, SQIBS can run a workflow that cleans the agent's build directory and requeues the plan.
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.