docs: add production incident runbooks (#287) - #344
Open
i-amdaveee wants to merge 1 commit into
Open
Conversation
Add docs/runbooks/ with an index plus 10 incident runbooks covering the top production issues: provider down, database index bloat, high API latency, queue backlog, Redis outage, Horizon degradation, DB pool exhaustion, replica lag, ledger imbalance, and elevated error rate. Each runbook is command-driven (symptoms -> diagnose -> mitigate -> recover -> verify -> post-incident) and grounded in the real codebase: metric names from src/utils/metrics.ts, health/metrics endpoints from src/index.ts, scripts from package.json, KEDA/HPA thresholds from k8s/, and the Grafana/Loki queries in docs/observability.md. Linked from docs/BRIDGE_DOCUMENTATION_INDEX.md and README.md.
|
@i-amdaveee 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! 🚀 |
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
1 participant
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.
closes #287
Create Runbook for Common Production Issues (#287)
Adds
docs/runbooks/— an index plus 10 incident runbooks for the most common production incidents on the ProxyPay bridge. Covers deposit/withdraw path, provider, data-tier, and financial-integrity failures.What's included
slow_querylogshttp_request_duration_secondsbreachtotal_depthhigh, KEDA at max replicas/readyshows Redis down, cache/queue impacthorizon_node_health=0too many clients,/readyDB check failingdb_replica_lag_secondshigh, stale readsreconcile:ledgerreports debits ≠ creditstransaction_errors_totalspikeEach runbook follows the same structure — symptoms → diagnose → mitigate → recover → verify → post-incident — and is command-driven rather than prose.
Grounded in the actual codebase
Not generic templates. Every command, metric, and endpoint references real project internals:
src/utils/metrics.ts(provider_circuit_breaker_state,horizon_node_health,db_replica_lag_seconds, …)src/index.ts(/ready,/health/queue/depth,/metrics)package.json(reconcile:ledger,reindex:bloated-indexes,audit:indexes)k8s/(KEDA threshold 20, HPA 80% CPU / min 2 max 10)docs/observability.md(Grafana/Loki LogQL)ledger_entriesschema (debit_amount/credit_amount)Discoverability
Linked from
docs/BRIDGE_DOCUMENTATION_INDEX.mdand a new Operations section inREADME.md.Acceptance criteria
Notes
Docs-only change; no code touched. Cross-links verified to resolve.