Overview
Send Amazon OpenSearch Service alerts to Callgoose SQIBS. You add SQIBS as a custom webhook notification channel, then send a monitor's trigger action to it. SQIBS opens an incident each time the trigger fires.
How it works
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 Amazon OpenSearch. It fills in these filter values:
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "trigger" |
(anything) | Opens an incident. |
| Title from | "description" |
Becomes the incident title. |
- Choose the Priority for these incidents and click Save.
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 SQIBS as a notification channel
In OpenSearch 2.0 and later, notification channels replace the old alerting destinations.
- Sign in to OpenSearch Dashboards and go to Notifications > Channels. Click Create channel.
- Set Name to
Callgoose_SQIBS_APIand Channel type to Custom webhook. - Define the endpoint by URL and enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=opensearch&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.
- Add the header
Content-Type: application/json, then click Create.
Step 3: Send a monitor's trigger to SQIBS
- Go to Alerting > Monitors, and create a monitor or edit an existing one.
- In a trigger, add an action named
Callgoose_SQIBS_Alertsand choose theCallgoose_SQIBS_APIchannel. - Set the Message to this JSON (keep each value on one line, or the JSON breaks):
{
"description": "Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue.",
"trigger": "{{ctx.trigger.name}}",
"severity": "{{ctx.trigger.severity}}",
"start": "{{ctx.periodStart}}",
"end": "{{ctx.periodEnd}}"
}
- Save the monitor.
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 Send test message in the trigger action, or let the monitor trigger.
- In SQIBS, a new incident opens, titled with the description.
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 OpenSearch channel.
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 an OpenSearch monitor sees a spike of 5xx errors in the logs, SQIBS can run a workflow that restarts the failing application pods.
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.