Overview

Send Bigeye data quality alerts to Callgoose SQIBS. A Bigeye webhook posts each alert (freshness, volume, schema and custom metrics) to your SQIBS API endpoint. SQIBS opens an incident when a metric alerts and resolves it when the metric is healthy again.

You need
A Bigeye workspace with admin access, and a SQIBS API token
Setup time
About 15 minutes
Result
Bigeye alerts open and resolve SQIBS incidents

How it works

Bigeye
Alert fires
A metric breaks its threshold or an anomaly is detected.
Bigeye
Sends a webhook
Through a webhook notification, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
An alerting status opens it, a healthy status 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 Bigeye template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "status" alerting Opens an incident.
Resolve "status" healthy Resolves the open incident.
Match "metric_id" Ties the resolve message to the incident it opened.
Title from "metric_name" Becomes the incident title.
Description from "message" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Bigeye's exact field names were not confirmed for this page. Use the values above as a starting point and adjust them from your first test message.

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 in Bigeye

  1. In Bigeye, open Settings > Notifications (or Integrations) and add a Webhook destination named Callgoose SQIBS.
  2. Enter your SQIBS endpoint, with method POST and content type application/json:
https://<your-endpoint>/sqibs-api/v1/process?from=bigeye&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, then add the webhook to the notification settings of the metrics or collections you want in SQIBS.

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. Trigger a test notification, or tighten a metric's threshold so it alerts.
  2. In SQIBS, a new incident opens. The payload below shows the shape to expect. Field names can differ between versions, so send one test message first and copy the exact keys from the API log with the JSON key creator.
{
  "status": "alerting",
  "metric_id": 50213,
  "metric_name": "Freshness: analytics.orders",
  "message": "Table analytics.orders has not updated for 6 hours",
  "table": "analytics.orders"
}
  1. When the metric is healthy again, the resolve filter closes 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 Bigeye webhook.

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 Bigeye reports a stale table, SQIBS can run a workflow that restarts the upstream load job.

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: