Overview
Jaeger has no alerting of its own: you alert on Jaeger's metrics with Prometheus, and Alertmanager sends the alerts to your SQIBS API endpoint. Because the messages are standard Alertmanager webhooks, the built-in Prometheus template in SQIBS handles them: an incident opens when an alert fires and resolves when it clears.
How it works
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
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- In Select Integration Template, choose Prometheus. It fills in these filter values:
| 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. |
- Choose the Priority for these incidents and click Save.
Jaeger has no template of its own; its alerts come from Alertmanager, which is exactly what the Prometheus template matches.
The template is a starting point, not a lock-in: every value stays visible and you can change it.
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 Jaeger and add alert rules
Jaeger v1 reached end of life; Jaeger v2 is built on the OpenTelemetry Collector and exposes its metrics on the admin port (8888 by default, path /metrics). Add it to Prometheus as the job jaeger, then add rules like these:
groups:
- name: jaeger
rules:
- alert: JaegerDown
expr: up{job="jaeger"} == 0
for: 5m
labels:
severity: critical
annotations:
summary: "Jaeger is not reachable on {{ $labels.instance }}"
description: "Prometheus has not scraped Jaeger on {{ $labels.instance }} for 5 minutes."
- alert: JaegerDroppingSpans
# Jaeger v2 is built on the OpenTelemetry Collector: check the exact metric name on your /metrics page.
expr: sum by (instance) (rate(otelcol_exporter_send_failed_spans_total{job="jaeger"}[5m])) > 0
for: 10m
labels:
severity: warning
annotations:
summary: "Jaeger is failing to store spans on {{ $labels.instance }}"
description: "The storage exporter has failed to send spans for 10 minutes."
With the Prometheus Operator, put the same rules in a PrometheusRule resource and scrape Jaeger with a ServiceMonitor.
Step 3: Send the alerts to SQIBS
Add SQIBS as an Alertmanager receiver. Keep send_resolved: true so incidents resolve:
receivers:
- name: callgoose-sqibs
webhook_configs:
- url: "https://<your-endpoint>/sqibs-api/v1/process?from=jaeger&token=<your-token>"
send_resolved: true
route:
receiver: callgoose-sqibs
group_by: ["alertname", "instance"]
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.
- Scale the Jaeger deployment to zero for a few minutes on a test cluster, or temporarily lower a rule threshold.
- In SQIBS, a new incident opens, titled with the alert summary.
- Restore Jaeger. Alertmanager sends
"status": "resolved"for the same group, and 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 Jaeger starts failing to store spans, SQIBS can run a workflow that checks the storage backend and restarts the Jaeger collector pods.
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:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- 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:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.