Overview

Zipkin collects and shows traces, but it does not send alerts itself. To be paged when tracing breaks, scrape the Zipkin server's Prometheus metrics, alert on them in Prometheus, and send the alerts to Callgoose SQIBS through Alertmanager. SQIBS opens an incident while an alert is firing and resolves it when it clears.

You need
A Zipkin server, Prometheus with Alertmanager, and a SQIBS API token
Setup time
About 20 minutes
Result
Zipkin health alerts open and resolve SQIBS incidents

How it works

Prometheus
Alert fires
A Zipkin health rule starts firing.
Prometheus
Sends a webhook
Alertmanager posts the alert group to SQIBS.
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 Zipkin (through Prometheus) 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 resolved message to the incident it opened.
Title from "commonAnnotations"."summary" Becomes the incident title.
  1. Choose the Priority for these incidents and click Save.

Or choose the Prometheus template in Select Integration Template, which fills in the same values. Alertmanager sends "status": "firing" while an alert group is active and "resolved" when it clears, with the same groupKey.

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: Scrape Zipkin and add alert rules

  1. Zipkin server exposes metrics at /prometheus (port 9411 by default). Add it as a Prometheus scrape job named zipkin.
  2. Add rules such as these to Prometheus:
groups:
  - name: zipkin
    rules:
      - alert: ZipkinDown
        expr: up{job="zipkin"} == 0
        for: 2m
        annotations:
          summary: "Zipkin server {{ $labels.instance }} is down"
      - alert: ZipkinSpansDropped
        expr: rate(zipkin_collector_spans_dropped_total[5m]) > 0
        for: 5m
        annotations:
          summary: "Zipkin is dropping spans on {{ $labels.instance }}"
  1. Reload Prometheus.

Step 3: Send the alerts to SQIBS

Add SQIBS as an Alertmanager webhook receiver, exactly as on the Prometheus page, with this URL:

https://<your-endpoint>/sqibs-api/v1/process?from=zipkin&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.

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. Stop a test Zipkin instance, or point the scrape job at a wrong port, and wait two minutes.
  2. In SQIBS, a new incident opens, titled with the rule's summary.
  3. Start Zipkin again. When Alertmanager 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 Alertmanager receiver.

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 Zipkin starts dropping spans, SQIBS can run a workflow that checks the storage backend and restarts the Zipkin collector.

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: