Link Alerts to Runbooks for On-Call Guidance
Attach a runbook URL to every alert so the on-call engineer sees the exact steps to diagnose and mitigate, not just a metric name.
Task
Instrument alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } so on-call engineers can diagnose an incident without guessing at log lines.
When to use this
An outage lasts 47 minutes because the team cannot correlate alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } across services without structured traces.
Prerequisites
- An application with structured logging available
- A metrics or tracing backend configured
Steps
1. Configure alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } in the project configuration file with the recommended defaults.
alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } }
Expected output: The configuration is accepted and alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } runs without errors on the first invocation.
2. Run the check locally to verify alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } produces the expected result before pushing.
act -j build # or: pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } blocks merge on failure.
- name: Run add on call runbook link
run: pnpm test
Expected output: Pull requests with failing alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } } are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Make the system observable
Start by measuring the problem. Attach a runbook URL to every alert so the on-call engineer sees the exact steps to diagnose and mitigate, not just a metric name. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run alert: { annotations: { runbook: ‘https://wiki/runbooks/high-error-rate’ } } against the current codebase and inspect the output before wiring it into CI.
alert: { annotations: { runbook: 'https://wiki/runbooks/high-error-rate' } }Correlate across services
Once the gate is in place, make failures actionable. A failing alert: { annotations: { runbook: ‘https://wiki/runbooks/high-error-rate’ } } should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.