Overview
Send ITRS Opsview alerts to Callgoose SQIBS. A notification method runs a small script that posts each problem and recovery to your SQIBS API endpoint. SQIBS opens an incident on a problem and resolves it when the same host or service recovers.
How it works
PROBLEM opens it, RECOVERY 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 ITRS Opsview template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "notification_type" |
PROBLEM |
Opens an incident. |
| Resolve | "notification_type" |
RECOVERY |
Resolves the open incident. |
| Match | "alert_key" |
Host, or host/service: ties the recovery to its problem. | |
| Title from | "output" |
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 notification script
On the Opsview orchestrator, save this script in the notifications scripts directory (/opt/opsview/monitoringscripts/notifications/notify_callgoose), put in your endpoint and token, and make it executable by the Opsview user:
#!/bin/bash
# notify_callgoose - Opsview notification script. Opsview passes the Nagios macros as NAGIOS_* environment variables.
URL="https://<your-endpoint>/sqibs-api/v1/process?from=opsview&token=<your-token>"
esc() { printf '%s' "$1" | sed 's/\\/\\\\/g; s/"/\\"/g' | tr '\n\r\t' ' '; }
STATE="${NAGIOS_SERVICESTATE:-$NAGIOS_HOSTSTATE}"
OUTPUT="${NAGIOS_SERVICEOUTPUT:-$NAGIOS_HOSTOUTPUT}"
KEY="$NAGIOS_HOSTNAME${NAGIOS_SERVICEDESC:+/$NAGIOS_SERVICEDESC}"
curl -s -m 20 -X POST "$URL" -H 'Content-Type: application/json' --data-binary @- <<EOF
{
"notification_type": "$(esc "$NAGIOS_NOTIFICATIONTYPE")",
"alert_key": "$(esc "$KEY")",
"host": "$(esc "$NAGIOS_HOSTNAME")",
"service": "$(esc "$NAGIOS_SERVICEDESC")",
"state": "$(esc "$STATE")",
"output": "$(esc "$OUTPUT")"
}
EOF
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: Create the notification method and profile
- In Opsview, go to Configuration > Notification Methods and add a method named
Callgoose SQIBSthat runs the commandnotify_callgoose. - Edit the user or shared notification profile that should page through SQIBS, select the
Callgoose SQIBSmethod, and choose the host groups and service checks to send. Include recovery notifications. - Apply Changes so the configuration is reloaded.
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.
- Stop a monitored service on a test host.
- In SQIBS, a new incident opens, titled with the check output.
- Start the service again. Opsview sends
RECOVERYwith 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 script (run it by hand with the same NAGIOS_* variables).
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 Opsview reports a Windows service stopped, SQIBS can run a workflow that starts it again and rechecks it.
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.