Overview
Send Semaphore CI/CD results to Callgoose SQIBS. A notification rule posts each finished pipeline to your SQIBS API endpoint. SQIBS opens an incident when a pipeline fails and resolves it when the next pipeline of the project passes.
How it works
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 Semaphore template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "pipeline"."result" |
failed |
Opens an incident. |
| Resolve | "pipeline"."result" |
passed |
Resolves the open incident. |
| Match | "project"."name" |
Ties the resolve message to the incident it opened. | |
| Title from | "project"."name" |
Becomes the incident title. | |
| Description from | "revision"."commit_message" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
One incident stays open per project until a pipeline passes. To keep branches apart, create one notification per branch and a filter for each. These values follow the payload shown in the test step. Send one test notification first and confirm the keys with the JSON key creator: Semaphore can change its payload between versions, and SQIBS matches key names exactly (upper and lower case matter).
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 notification in Semaphore
- In Semaphore, open the organization Settings > Notifications and click New Notification.
- Name it
callgoose-sqibsand, in the rule, set Projects (comma-separated, or a regular expression such as/.*/), Branches (for examplemain) and Results tofailed,passed. - In Webhook Endpoint, enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=semaphore&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 the notification. With the CLI, the same is
sem create notification callgoose-sqibs --projects "/.*/" --branches "main" --webhook-endpoint "<url>".
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.
- Push a commit that fails the pipeline.
- In SQIBS, a new incident opens, titled with the project name. The notification looks like this (shortened):
{
"project": {
"name": "shop-api"
},
"pipeline": {
"name": "Build and test",
"result": "failed",
"state": "done",
"yaml_file_name": "semaphore.yml"
},
"revision": {
"branch": {
"name": "main"
},
"commit_message": "Fix checkout total"
},
"workflow": {
"id": "a1b2c3d4"
}
}
- Fix the build and push again. When the pipeline result is
passed, 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 Semaphore notification.
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 pipeline fails, SQIBS can run a workflow that checks the target environment and rolls back to the last good release.
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.