Overview
Send Virtana infrastructure performance alerts to Callgoose SQIBS. Virtana posts a small JSON body to your SQIBS API endpoint when an alert is raised and when it clears. SQIBS opens an incident for the problem and resolves it when the alert clears.
How it works
PROBLEM opens it, OK 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 Virtana template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "state" |
PROBLEM |
Opens an incident. |
| Resolve | "state" |
OK |
Resolves the open incident. |
| Match | "alert_id" |
Ties the clear message to the incident it opened. | |
| Title from | "name" |
Becomes the incident title. | |
| Description from | "message" |
Becomes the incident 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: Add the webhook in Virtana
- In Virtana, open the alert notification settings and add a webhook notification for the alert policies you want in SQIBS.
- Set the method to POST, the content type to
application/json, and the URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=virtana&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.
Use this body, replacing each <...> with the matching Virtana variable. Send the same alert_id when the alert clears:
{
"source": "virtana",
"alert_id": "<alert id>",
"state": "<PROBLEM or OK>",
"severity": "<severity>",
"name": "<alert name>",
"resource": "<affected host or device>",
"message": "<alert text>"
}
If your Virtana edition cannot change the request body, keep its own payload: send one test, open it in the JSON key creator, and use its keys in the filter instead.
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.
- Raise a test alert in Virtana, for example with a low threshold.
- In SQIBS, a new incident opens, titled with the alert name.
- When the alert clears, the same
alert_idarrives with"state": "OK", 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 Virtana notification.
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 Virtana reports storage latency on a datastore, SQIBS can run a workflow that checks the busiest virtual machines on 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.