Overview
Send Apache SkyWalking alarms to Callgoose SQIBS. The SkyWalking OAP server posts alarm messages to a webhook you define in alarm-settings.yml. SQIBS opens an incident for each alarm, titled with the alarm message.
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 SkyWalking template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | [0]."ruleName" |
Opens an incident for any alarm. Add a value to limit it to one rule. | |
| Title from | [0]."alarmMessage" |
Becomes the incident title. | |
| Description from | [0]."name" |
The service or endpoint name becomes the description. |
- Choose the Priority for these incidents and click Save.
SkyWalking sends a list, so the keys start with [0] (the first alarm in the list). When several alarms fire at once, only the first one sets the title. Recent SkyWalking versions can also send a recovery message; if yours does, add a Resolve filter for it, matched on [0]."id0". Otherwise close these incidents in SQIBS (or with an automation workflow) when the fix is in.
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 webhook hook in SkyWalking
- On the OAP server, edit
config/alarm-settings.yml(on Kubernetes, the alarm settings in your ConfigMap or Helm values). - Add a webhook hook that points at your SQIBS endpoint:
hooks:
webhook:
callgoose:
is-default: true
urls:
- https://<your-endpoint>/sqibs-api/v1/process?from=skywalking&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.
- Make sure your alarm rules use the hook (with
is-default: truethey all do), then reload the settings or restart the OAP server.
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 rule's threshold, for example
service_resp_time_rule, so it fires. - In SQIBS, a new incident opens, titled with the alarm message. SkyWalking sends a list of alarms (shortened):
[
{
"scopeId": 1,
"scope": "SERVICE",
"name": "shop-api",
"id0": "c2hvcC1hcGk=.1",
"id1": "",
"ruleName": "service_resp_time_rule",
"alarmMessage": "Response time of service shop-api is more than 1000ms in 3 minutes of last 10 minutes",
"startTime": 1763806500000,
"tags": [
{
"key": "level",
"value": "WARNING"
}
]
}
]
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 alarm-settings.yml.
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 SkyWalking reports slow responses from a service, SQIBS can run a workflow that scales the deployment out.
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.