Overview
Send VictoriaMetrics Cloud alerts to Callgoose SQIBS. VictoriaMetrics alerting rules (vmalert) hand alerts to Alertmanager, and an Alertmanager webhook receiver posts them to your SQIBS API endpoint. SQIBS opens an incident while an alert is firing and resolves it when it clears.
How it works
firing opens it, resolved 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 VictoriaMetrics Cloud template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "status" |
firing |
Opens an incident. |
| Resolve | "status" |
resolved |
Resolves the open incident. |
| Match | "groupKey" |
Ties the resolved message to the incident it opened. | |
| Title from | "commonAnnotations"."summary" |
Becomes the incident title. | |
| Description from | "commonAnnotations"."description" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
VictoriaMetrics uses the same Alertmanager format as Prometheus, so the Prometheus template in Select Integration Template works too. Alertmanager sends "status": "firing" while an alert group is active and "resolved" when it clears, with the same groupKey.
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 SQIBS as an Alertmanager receiver
- In VictoriaMetrics Cloud, open your deployment's alerting settings and edit the Alertmanager configuration.
- Add a webhook receiver for SQIBS and route alerts to it. Keep
send_resolved: trueso incidents resolve:
route:
receiver: callgoose-sqibs
receivers:
- name: callgoose-sqibs
webhook_configs:
- url: "https://<your-endpoint>/sqibs-api/v1/process?from=victoriametrics&token=<your-token>"
send_resolved: true
Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.
- Make sure your alerting rules set a
summaryannotation, which becomes the incident title. Save the configuration.
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.
- Add a test rule that is always true, for example
vector(1) > 0, and wait for it to fire. - In SQIBS, a new incident opens, titled with the rule's summary.
- Remove the test rule. When Alertmanager sends
"status": "resolved", 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 Alertmanager receiver.
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 a VictoriaMetrics rule reports a full disk on a node, SQIBS can run a workflow that clears old logs and rechecks the space.
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.