Overview

Send Alibaba Cloud CloudMonitor threshold alerts to Callgoose SQIBS. An alert rule calls your SQIBS API endpoint when its state changes. SQIBS opens an incident when the rule goes into alert and resolves it when the metric returns to normal.

You need
An Alibaba Cloud account with permission to manage CloudMonitor alert rules, and a SQIBS API token
Setup time
About 15 minutes
Result
CloudMonitor alerts open and resolve SQIBS incidents

How it works

CloudMonitor
Alert fires
A threshold alert rule changes to the alert state.
CloudMonitor
Sends a webhook
The rule's alert callback posts to SQIBS.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
An alert state opens it, the OK state closes it once you add a match key.

Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.

Step 1: Add the API filter in SQIBS

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in CloudMonitor template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger (none) ALERT Opens an incident. An empty key searches the whole message.
  1. Choose the Priority for these incidents and click Save.

CloudMonitor's callback format depends on the rule type, and some callbacks are sent as form fields instead of JSON. A filter with an empty key searches the whole raw message, so it works with either. A resolve needs a match key, so once you have seen a real message, add the rule and instance as Map incident with to make the OK message resolve the incident.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
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 alert callback in CloudMonitor

  1. In the Alibaba Cloud console, open CloudMonitor > Alerts > Alert Rules, and create or edit a rule.
  2. Set the metric, threshold and alert contact group as usual.
  3. Under the advanced settings, enter your SQIBS endpoint as the Alert Callback URL:
https://<your-endpoint>/sqibs-api/v1/process?from=alibabacloud&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.

  1. Save the rule.

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.

  1. Lower a rule's threshold so it alerts, then put it back.
  2. Open the API log and look at the message CloudMonitor sent. Its fields (for example the alert state, rule name and instance) tell you which keys to put in the filter: use the alert state as the trigger and resolve key, and the rule and instance as the match key, so the OK message resolves the right incident.
  3. Update the filter with those keys and test again.

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 CloudMonitor alert rule.

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 CloudMonitor reports high CPU on an ECS instance, SQIBS can run a workflow that restarts the runaway process.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

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:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. 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: