Overview
Send GoCD pipeline results to Callgoose SQIBS. Two small tasks at the end of a job post to your SQIBS API endpoint: one runs only when the job failed, one only when it passed. SQIBS opens an incident on the failure and resolves it on the next pass.
How it works
run_if: failed task posts JSON with curl.failed opens it, passed 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 GoCD template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "status" |
failed |
Opens an incident. |
| Resolve | "status" |
passed |
Resolves the open incident. |
| Match | "pipeline" |
The same for every run, so the next passing run resolves it. | |
| Title from | "title" |
Becomes the incident title. |
- 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 tasks in GoCD
- Store the SQIBS token as a secure environment variable named
SQIBS_TOKENon the pipeline (or in a secret config). - Add two tasks after your build task, using GoCD's run if condition: one for Failed, one for Passed. In YAML config they look like this:
# In a job of the stage you want to watch (GoCD YAML config):
tasks:
- exec:
command: /bin/bash
arguments: [-c, ./build.sh]
- exec:
run_if: failed
command: /bin/bash
arguments:
- -c
- >-
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=gocd&token=$SQIBS_TOKEN"
-H 'Content-Type: application/json'
-d "{\"status\": \"failed\", \"pipeline\": \"$GO_PIPELINE_NAME\", \"stage\": \"$GO_STAGE_NAME\", \"run\": \"$GO_PIPELINE_COUNTER\", \"title\": \"GoCD $GO_PIPELINE_NAME/$GO_STAGE_NAME failed (run $GO_PIPELINE_COUNTER)\"}"
- exec:
run_if: passed
command: /bin/bash
arguments:
- -c
- >-
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=gocd&token=$SQIBS_TOKEN"
-H 'Content-Type: application/json'
-d "{\"status\": \"passed\", \"pipeline\": \"$GO_PIPELINE_NAME\", \"stage\": \"$GO_STAGE_NAME\"}"
Replace <your-endpoint> with your SQIBS endpoint host. See how to get the endpoint URL. In the GoCD UI, set Run if conditions on each task instead.
3. Save the pipeline.
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.
- Run the pipeline with a change that fails the build.
- In SQIBS, a new incident opens, titled with the pipeline, stage and run.
- Fix it and run again. The passed task sends
"status": "passed"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 GoCD 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 deployment stage fails because a target server is out of disk, SQIBS can run a workflow that clears old releases on that server.
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.