Overview
Send Pandora FMS alerts to Callgoose SQIBS. An alert command posts JSON to your SQIBS API endpoint when an alert fires, and again, with a different value, when it recovers. SQIBS opens the incident on the first and resolves it on the second.
How it works
firing opens it, recovered 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 Pandora FMS template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Resolve | "state" |
recovered |
Resolves the open incident. |
| Trigger | "state" |
firing |
Opens an incident. |
| Match | "alert_key" |
Agent and module: ties the recovery to its alert. | |
| Title from | "alert" |
Becomes the incident title. | |
| Description from | "data" |
The module value becomes the description. |
- 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: Create the alert command and action
- In Pandora FMS, go to Alerts > Commands and create a command
Callgoose SQIBSwith this command line._field1_carries the state, and the other macros are filled in by Pandora FMS:
curl -s -X POST 'https://<your-endpoint>/sqibs-api/v1/process?from=pandorafms' \
-H 'Authorization: Bearer <your-token>' -H 'Content-Type: application/json' \
--data '{"state": "_field1_", "alert_key": "_agent_/_module_", "agent": "_agent_", "module": "_module_", "module_status": "_modulestatus_", "data": "_data_", "alert": "_alert_name_"}'
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Go to Alerts > Actions and create an action that uses the command. Set Field 1 to
firingand Field 1 recovery torecovered. - Assign the action to the modules (or a policy) you want in SQIBS, with an alert template that has recovery turned on.
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.
- Push a test module into critical, for example by lowering its threshold.
- In SQIBS, a new incident opens, titled with the alert name.
- Restore the threshold. The recovery runs the command with
recovered, 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 alert command.
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 Pandora FMS reports a service module critical, SQIBS can run a workflow that restarts the service on that agent's host.
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.