docs(ops): add retention-gap recovery runbook - #181
Open
Hustler490 wants to merge 1 commit into
Open
Hustler490 wants to merge 1 commit into
Hustler490 wants to merge 1 commit into
Conversation
Contributor
|
The replacement removes the fake CLI commands, but several examples still use APIs that do not exist. |
4 tasks done
The deployment guide explains Soroban RPC retention windows but stops at mitigation options, leaving operators without a step-by-step recovery procedure for a scanner that fell behind the retention boundary. Add a runbook covering detection, checkpoint handling, archive replay, dual-provider and Horizon recovery, safe rescan with deduplication, retention-aware alert thresholds, and the operator evidence to collect. Link it from the monitoring guide and register it in the Operations navigation. Closes wraith-protocol#159
Hustler490
force-pushed
the
docs/retention-gap-recovery
branch
from
October 2, 2026 15:39
34b215a to
d9f412d
Compare
This branch has not been deployed
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.
Closes #159
What
The deployment guide documents Soroban RPC retention windows and the mitigation options, but stops there. It never tells an operator what to actually do when a scanner is offline past the boundary. This adds a dedicated recovery runbook.
Changes
guides/ops/retention-gap-recovery.mdx(new) - step-by-step procedure covering:lastProcessedLedgerto the network tip and classify the gap against the ~17,280-ledger window; confirm viaretention_window_exceeded/RetentionExceededError.lastProcessedLedgerbefore and after, never advance the checkpoint past unpersisted events.fallbackPolicy: "archive_node".contract_id, ledger, tx_hash, event_index) with a unique constraint andON CONFLICT DO NOTHINGupsert.guides/ops/monitoring-and-on-call.mdx- links the runbook from Playbook 3 (Indexer Stall) and Cross-References.docs.json- registers the page in the Operations navigation group.Validation
node localization-qa.cjs? 0 issues (new page recognised as a canonical page).node scripts/check-nav-coverage.mjs? 72 pages checked, 72 nav entries verified.docs.jsonparses as valid JSON.