Add monitoring, alerting, and on-call runbook for operations - #142
Merged
truthixify merged 1 commit intoAug 27, 2026
Merged
Conversation
- Created comprehensive guides/ops/monitoring-and-on-call.mdx with: * Key metrics for RPC, indexer, contracts, and watcher * Healthy baselines and alert thresholds * Six incident playbooks with diagnosis and mitigation steps * Severity matrix mapped to Auditor Guide * Quarterly tabletop exercise script - Added Grafana dashboards in guides/ops/dashboards/: * rpc-health.json - RPC latency, error rates, backpressure * indexer-performance.json - announcement lag, backlog, sync height * contract-monitoring.json - contract errors, invocation latency - Added Prometheus alerting rules in guides/ops/alerts/: * wraith-alerts.yml with 20+ production-ready rules * Rationale and runbook links per alert * Severity labels mapped to SLA requirements - Updated docs.json with Operations nav entry - Cross-linked with self-hosted-deployment.mdx and auditor-guide.mdx Resolves wraith-protocol#133
|
@code3ks 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
|
Merged. Three importable dashboards plus alert rules with a rationale per rule, not just a page describing them. That is the version an operator can actually use @code3ks. |
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
2 participants
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.
Description
This PR adds a comprehensive monitoring and on-call runbook for Wraith Protocol operations, addressing issue #133.
Changes
New Documentation
guides/ops/monitoring-and-on-call.mdx: Complete operational runbook including:Grafana Dashboards
guides/ops/dashboards/rpc-health.json: RPC latency, error rates, Horizon backpressure, Soroban failuresguides/ops/dashboards/indexer-performance.json: Announcement lag, backlog count, scan miss rate, sync height lagguides/ops/dashboards/contract-monitoring.json: Contract error rates, invocation latency, registration failures, unauthorized access alertsPrometheus Alerting Rules
guides/ops/alerts/wraith-alerts.yml: Production-ready alert rules with:promtool check rulesNavigation & Cross-Links
docs.jsonwith new Operations nav entryguides/ops/self-hosted-deployment.mdxreference/auditor-guide.mdxseverity matrixAcceptance Criteria Met
✅ New
guides/ops/monitoring-and-on-call.mdxcreated✅ Key metrics defined with healthy baselines and alert thresholds
✅ Three Grafana dashboards created (RPC, indexer, contracts)
✅ Prometheus alerting rules file with rationale per rule
✅ Six named incident playbooks included
✅ Severity matrix mapping to Auditor Guide response SLAs
✅ Tabletop exercise script for quarterly drills
✅ Cross-linked with self-hosted-deployment.mdx and auditor-guide.mdx
✅ Nav entry added under Operations in docs.json
Testing
promtool check rules guides/ops/alerts/wraith-alerts.ymlmint devFiles Changed
Created (5 files):
guides/ops/monitoring-and-on-call.mdx- Main runbook documentationguides/ops/dashboards/rpc-health.json- RPC monitoring dashboardguides/ops/dashboards/indexer-performance.json- Indexer monitoring dashboardguides/ops/dashboards/contract-monitoring.json- Contract monitoring dashboardguides/ops/alerts/wraith-alerts.yml- Prometheus alerting rulesModified (2 files):
docs.json- Added navigation entry under Operationsguides/ops/self-hosted-deployment.mdx- Added cross-link to monitoring guideTotal: 1,716 insertions, 1 deletion
Closes #133