docs: on-call SLO and alerting runbook for core gauges - #833
Merged
1nonlypiece merged 1 commit intoJun 27, 2026
Merged
Conversation
|
@onyemaechiezekiel9 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
having the slo and alerting runbook written down for the core gauges will save on-call a lot of guessing. merged |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: on-call SLO and alerting runbook for core gauges
Closes #753
Summary
Authors
docs/runbooks/on-call-slo.md— a complete on-call SLO and alerting runbook tying each Prometheus gauge exposed bysrc/routes/metrics.tsto a threshold, a Prometheus alert rule, and a numbered remediation procedure. Metrics without an interpretation guide are not actionable at 3am; this runbook fixes that.No source code was modified.
Files
docs/runbooks/on-call-slo.md— createddocs/operations-metrics.md— cross-link added in See Also sectionGauge Coverage
All gauge names sourced directly from
src/routes/metrics.ts— none invented:disciplr_job_queue_depthdisciplr_db_available_connectionsdisciplr_db_waiting_clientsdisciplr_horizon_listener_lagdisciplr_outbox_relay_lag_secondsdisciplr_job_failed_totalRunbook Structure (per SLO)
Each of the 4 SLOs includes:
Bonus sections: common incident scenarios, full alert config example, and maintenance window guidelines.
How to use
The runbook links directly to remediation steps for each alert so on-call engineers can jump straight to the relevant section from a PagerDuty/Alertmanager notification.
Security Notes
N/A — documentation only. No credentials, PII, or internal endpoints are referenced in the runbook.