Overview
Send Nagios host and service alerts to Callgoose SQIBS. You add two notification commands that post each alert to SQIBS, and a contact that uses them. SQIBS opens an incident on a problem and resolves it on recovery.
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.
- In Select Integration Template, choose Nagios. It fills in these filter values:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | (none) | (anything) | No key, so every message opens an incident. |
- Choose the Priority for these incidents and click Save.
The Nagios template has no key, so every notification opens an incident, recoveries included. With the commands below, use these values instead so a recovery resolves the incident it belongs to:
| 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 | "Additional Info" |
Becomes the incident title. |
The template is a starting point, not a lock-in: every value stays visible and you can change it.
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 two notification commands in Nagios
In Nagios XI, go to Configure > Core Config Manager > Commands and click Add New twice:
notify-service-alert (Command Type: misc command):
/usr/bin/curl -s -X POST 'https://<your-endpoint>/sqibs-api/v1/process?from=nagios&token=<your-token>' \
-H 'Content-Type: application/json' \
--data-raw '{
"Alert type": "service alert",
"Notification Type": "$NOTIFICATIONTYPE$",
"Service Desc": "$SERVICEDESC$",
"Hostname": "$HOSTNAME$",
"Host address": "$HOSTADDRESS$",
"Service State": "$SERVICESTATE$",
"Log date time": "$LONGDATETIME$",
"Additional Info": "$SERVICEOUTPUT$",
"Alert key": "$HOSTNAME$/$SERVICEDESC$"
}'
notify-host-alert (Command Type: misc command):
/usr/bin/curl -s -X POST 'https://<your-endpoint>/sqibs-api/v1/process?from=nagios&token=<your-token>' \
-H 'Content-Type: application/json' \
--data-raw '{
"Alert type": "host alert",
"Notification Type": "$NOTIFICATIONTYPE$",
"Hostname": "$HOSTNAME$",
"Host address": "$HOSTADDRESS$",
"Host State": "$HOSTSTATE$",
"Log date time": "$LONGDATETIME$",
"Additional Info": "$HOSTOUTPUT$",
"Alert key": "$HOSTNAME$"
}'
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
Click Save, then Apply Configuration. The Alert key field gives every host and every service its own key, so SQIBS can match a recovery to the right incident.
Step 3: Add a SQIBS contact and use it
- Go to Alerting > Contacts and click Add New. Set Contact Name to
Callgoose SQIBS. - On the Alert Settings tab:
- Host notifications: On, period 24x7, options Down, Unreachable and Recovery; command notify-host-alert.
- Service notifications: On, period 24x7, options Warning, Unknown, Critical and Recovery; command notify-service-alert.
- Click Save, then Apply Configuration.
- Add the contact to the hosts and services you want in SQIBS: open the host or service, Re-configure it, and on Notifications choose Callgoose SQIBS.
Keep Recovery on in both option lists: without it Nagios never tells SQIBS that the problem is over.
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, for example SSH.
- When Nagios notifies, SQIBS opens an incident titled with the check output.
- Start the service again. Nagios sends a
RECOVERYnotification and SQIBS resolves the incident.
You can also see the notifications under Reports > Notifications in Nagios.
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 two Nagios commands.
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 Nagios reports a stopped service, SQIBS can run a workflow that starts it again over SSH.
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.