Overview
Send Broadcom DX Spectrum alarms to Callgoose SQIBS. Spectrum's AlarmNotifier runs a script for every alarm that is set or cleared; the script posts the alarm to your SQIBS API endpoint. SQIBS opens an incident when an alarm is set and resolves it when the alarm clears.
How it works
SET opens it, CLEAR 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 DX Spectrum template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "action" |
SET |
Opens an incident. |
| Resolve | "action" |
CLEAR |
Resolves the open incident. |
| Match | "alarm_id" |
Ties the resolve message to the incident it opened. | |
| Title from | "cause" |
Becomes the incident title. | |
| Description from | "model" |
The device model becomes the description. |
- Choose the Priority for these incidents and click Save.
AlarmNotifier passes alarm values to your scripts as arguments; the exact order is set in its resource file, so match the script's $1...$5 to your configuration.
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 script
On the server that runs AlarmNotifier, create a script like this and make it executable:
#!/bin/sh
# Called by Spectrum's AlarmNotifier SetScript/ClearScript with the alarm values as arguments.
# $1 = CLEAR or SET, $2 = alarm id, $3 = model name, $4 = severity, $5 = probable cause text
curl -s -X POST "https://<your-endpoint>/sqibs-api/v1/process?from=spectrum&token=<your-token>" \
-H 'Content-Type: application/json' \
-d "{\"action\": \"$1\", \"alarm_id\": \"$2\", \"model\": \"$3\", \"severity\": \"$4\", \"cause\": \"$5\"}"
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Step 3: Call it from AlarmNotifier
- In the AlarmNotifier resource file, point the set and clear script settings (
SET_SCRIPTandCLEAR_SCRIPT) at wrapper scripts that call the script above withSETorCLEARand the alarm values. - Use the notification policy to limit which alarms are sent (for example critical and major only).
- Restart AlarmNotifier.
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.
- Generate a test alarm on a lab device, for example by shutting a monitored interface.
- In SQIBS, a new incident opens, titled with the probable cause. The payload looks like this:
{
"action": "SET",
"alarm_id": "5f2a1c0b-0001",
"model": "core-sw-01",
"severity": "CRITICAL",
"cause": "DEVICE HAS STOPPED RESPONDING TO POLLS"
}
- Bring the interface back. When the alarm clears, 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 AlarmNotifier script.
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 Spectrum reports a device not responding to polls, SQIBS can run a workflow that pings it from two sites and power-cycles its PDU port if both fail.
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.