Overview

Watch Tiger Data (formerly Timescale) services with Callgoose SQIBS. You chart your Tiger Data service in Grafana, alert on it with Grafana alerting, and send the alerts to your SQIBS API endpoint through a webhook contact point. SQIBS opens an incident when an alert fires and resolves it when it clears.

You need
A Tiger Data service, Grafana with alerting, and a SQIBS API token
Setup time
About 20 minutes
Result
Database alerts open and resolve SQIBS incidents

How it works

Tiger Data (Timescale)
Alert fires
A Grafana alert rule on a Tiger Data query fires.
Tiger Data (Timescale)
Sends a webhook
Through a Grafana webhook contact point, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
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

  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 Tiger Data (Timescale) 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 resolve message to the incident it opened.
Title from "commonLabels"."alertname" Becomes the incident title.
Description from "commonAnnotations"."summary" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Grafana sends the same format as Prometheus Alertmanager, and groupKey stays the same from firing to resolved.

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: Connect Grafana to your Tiger Data service

  1. In Grafana, go to Connections > Data sources and add a PostgreSQL data source with your Tiger Data service's host, port, database and a read-only user. Turn on TimescaleDB.
  2. Build the query to alert on, for example slow queries from pg_stat_statements or replication lag.

Step 3: Alert through SQIBS

  1. Add a webhook contact point for SQIBS and route alerts to it, as described in Grafana with SQIBS. Use this endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=tigerdata&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. Create a Grafana alert rule on the query from step 2 and route it to the contact point.

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 the alert threshold so the rule fires.
  2. In SQIBS, a new incident opens. Grafana's payload looks like this (shortened):
{
  "status": "firing",
  "groupKey": "{}/{alertname=\"High query latency\"}",
  "commonLabels": {
    "alertname": "High query latency",
    "service": "tigerdata",
    "severity": "critical"
  },
  "commonAnnotations": {
    "summary": "Query latency above 500 ms"
  },
  "alerts": [
    {
      "status": "firing",
      "labels": {
        "alertname": "High query latency"
      }
    }
  ]
}
  1. Put the threshold back. When Grafana 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 Grafana contact point.

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 query latency rises on the database, SQIBS can run a workflow that finds and cancels long-running queries over an agreed limit.

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: