Overview

Send VMware Aria Operations alerts to Callgoose SQIBS. Aria Operations (now VCF Operations) watches your vSphere and cloud estate and raises alerts from symptoms and thresholds. Alerts reach SQIBS through the Operations webhook notification plugin: SQIBS opens an incident when an alert becomes active and resolves it when the alert is canceled.

You need
VCF Operations (formerly Aria Operations) with admin access, and a SQIBS API token
Setup time
About 20 minutes
Result
Active alerts open SQIBS incidents; canceled alerts close them

How it works

VMware Aria Operations
Alert fires
An alert becomes active on a host, VM or cluster.
VMware Aria Operations
Sends a webhook
A notification rule sends it through the webhook plugin, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
ACTIVE opens it, CANCELED 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

  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 VMware Aria Operations template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "status" ACTIVE Opens an incident.
Resolve "status" CANCELED Resolves the open incident.
Match "alert_id" Ties the canceled alert to the incident it opened.
Title from "name" Becomes the incident title.
Description from "message" Becomes the incident description.
  1. 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.

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 a webhook outbound instance

  1. In VCF Operations (Aria Operations), go to the alert Outbound Settings and click Add.
  2. Set Plugin Type to Webhook Notification Plugin, name it Callgoose SQIBS, and set the URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=vmware&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. Click Test and Save.

Step 3: Add a payload template and a notification

  1. Go to Payload Templates, add a template for the webhook plugin, and set the body to this JSON, picking each value from the template's variable list:
{
  "alert_id": "<alert id variable>",
  "status": "<alert status variable: ACTIVE or CANCELED>",
  "criticality": "<criticality variable>",
  "name": "<alert definition name variable>",
  "resource": "<resource name variable>",
  "message": "<alert description variable>"
}
  1. Go to Notifications, add a rule, choose the alerts (by criticality, object type or definition), select the Callgoose SQIBS outbound instance and the payload template, and include canceled alerts so incidents resolve.
  2. Save the rule.

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.

  1. Lower an alert definition's threshold on a test object, or use Test on the notification.
  2. In SQIBS, a new incident opens, titled with the alert definition name.
  3. When the alert is canceled, 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 outbound instance.

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 Aria Operations reports a VM out of memory, SQIBS can run a workflow that restarts the service using the most memory, then rechecks.

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: