Overview

Send Apigee alerts to Callgoose SQIBS. Apigee (Apigee X and hybrid) publishes its API proxy metrics, such as response codes and latency, to Cloud Monitoring. An alerting policy on those metrics notifies SQIBS through a webhook channel. SQIBS opens an incident when the policy fires and resolves it when the incident closes.

You need
An Apigee organization in a Google Cloud project, Monitoring Editor access, and a SQIBS API token
Setup time
About 15 minutes
Result
Apigee alerts open and resolve SQIBS incidents

How it works

Apigee
Alert fires
An API proxy's error rate or latency crosses a threshold.
Apigee
Sends a webhook
Cloud Monitoring posts the incident to a webhook channel.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
State open opens it, closed 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. In Select Integration Template, choose GoogleCloud. It fills in these filter values:
Part Payload JSON key Key value contains What it does
Trigger "incident"."state" open Opens an incident.
Resolve "incident"."state" closed Resolves the open incident.
Match "incident"."resource_id" Ties the resolve message to the incident it opened.
Title from "incident"."summary" Becomes the incident title.
  1. Choose the Priority for these incidents and click Save.

The template matches on "incident"."resource_id", so two policies alerting on the same resource share one incident. Change Map incident with (trigger and resolve) to "incident"."incident_id", which Cloud Monitoring keeps from open to closed.

The template is a starting point, not a lock-in: every value stays visible and you can change it.

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 notification channel

  1. In the Google Cloud console, open Monitoring > Alerting and click Edit notification channels.
  2. In the Webhook section, click Add new. Enter your SQIBS endpoint as the Endpoint URL and a display name, for example Callgoose SQIBS:
https://<your-endpoint>/sqibs-api/v1/process?from=apigee&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 connection, then Save.

Step 3: Create an alerting policy on Apigee metrics

  1. In Monitoring > Alerting, click Create policy.
  2. Click Select a metric, turn off Active if there is no recent traffic, and choose Apigee Proxy > Proxy > Apigee proxy response count (apigee.googleapis.com/proxy/response_count; on Apigee hybrid 1.10 and 1.11 it is apigee.googleapis.com/proxyv2/response_count). Add a filter on response_code, for example 500, and set the threshold.
  3. Under Notifications, add the Callgoose SQIBS channel and keep Notify on incident closure on, so SQIBS receives the closed message.
  4. Name the policy, for example Apigee payments 5xx, and save it.

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. Click Test connection on the channel, or let the policy fire.
  2. In SQIBS, a new incident opens, titled with the incident summary. The payload looks like this (shortened):
{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "state": "open",
    "policy_name": "Apigee payments 5xx",
    "condition_name": "Apigee proxy response count",
    "resource_name": "payments-v1",
    "summary": "500 responses for payments-v1 are above the threshold of 10 with a value of 37.",
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.opqiw61fsv7p",
    "started_at": 1764000000
  },
  "version": "1.2"
}
  1. When the error rate drops, Cloud Monitoring sends "state": "closed" for the same incident, and SQIBS resolves it.

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 Cloud Monitoring 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 Apigee reports 5xx errors from a proxy's target, SQIBS can run a workflow that checks the backend service and restarts it if its health check fails.

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: