Overview
Send SolarWinds NPM alerts to Callgoose SQIBS. SolarWinds NPM runs on the SolarWinds Platform (Orion), so its alerts use the platform's alert actions: a trigger action posts JSON to your SQIBS API endpoint when the alert fires, and a reset action posts again when it clears. Use it for node down, interface down and high-utilization alerts.
How it works
triggered opens it, the reset action's resolved 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 SolarWinds NPM template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "event_type" |
triggered |
Opens an incident. |
| Resolve | "event_type" |
resolved |
Resolves the open incident. |
| Match | "alert_key" |
Ties the reset to the alert it belongs to. | |
| Title from | "alert_name" |
Becomes the incident title. | |
| Description from | "message" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
These are the same values as the SolarWinds page; the built-in SolarWinds template has no key, so enter these instead.
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: Create the alert and its trigger action
- In the SolarWinds Platform web console, go to Alerts & Activity > Alerts > Manage Alerts and click Add New Alert (or edit one of the built-in alerts).
- Set the Trigger Condition (for example a node going down or an interface going over 90% utilization) and the Reset Condition.
- Under Trigger Actions, click Add Action, choose Send a GET or POST Request to a Web Server and click Configure Action. Name it
CallgooseSQIBS - Triggered. - Enter your SQIBS endpoint as the URL:
https://<your-endpoint>/sqibs-api/v1/process?from=solarwinds&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.
- Choose Use HTTP/S POST, set the content type to
application/json, and paste this body:
{
"event_type": "triggered",
"alert_key": "${N=Alerting;M=AlertObjectID}",
"alert_name": "${N=Alerting;M=AlertName}",
"object": "${N=SwisEntity;M=Caption}",
"message": "${N=Alerting;M=AlertMessage}",
"severity": "${N=Alerting;M=Severity}",
"details_url": "${N=Alerting;M=AlertDetailsUrl}"
}
- Click Save Changes.
Step 3: Add the reset action
- Under Reset Actions, add the same kind of action, named
CallgooseSQIBS - Resolved, with the same URL. - Use the same body with
"event_type": "resolved":
{
"event_type": "resolved",
"alert_key": "${N=Alerting;M=AlertObjectID}",
"alert_name": "${N=Alerting;M=AlertName}",
"object": "${N=SwisEntity;M=Caption}",
"message": "${N=Alerting;M=AlertMessage}",
"severity": "${N=Alerting;M=Severity}",
"details_url": "${N=Alerting;M=AlertDetailsUrl}"
}
- Save, review the summary and click Submit.
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.
- Use Simulate on the trigger action, or let the alert fire.
- In SQIBS, a new incident opens, titled with the alert name.
- When the reset condition is met, the reset action sends
"event_type": "resolved"with the samealert_key, 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 SolarWinds actions.
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 NPM reports an interface error storm, SQIBS can run a workflow that collects the interface counters over SSH and bounces the port.
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.