Skip to content

[Docs] Add an indexer/realtime operational runbook (replay/reset/status, lag thresholds, RPC-outage recovery) #849

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Labels: documentation, Stellar Wave, devops, docs

We have plenty of docs under docs/ (SSE architecture, implementation, auth, versioning) but nothing that tells on-call how to actually operate the indexer.

If the Soroban RPC goes down or we miss a batch of ledgers, there's no runbook for recovering. The admin reset/replay endpoints, what indexer lag actually means, and the indexer env vars (INDEXER_POLL_INTERVAL_MS, INDEXER_START_LEDGER, STREAM_CONTRACT_ID) are all undocumented on the ops side. So whoever gets paged is guessing.

What the doc has to cover

  • Reading indexer lag from /health and /v1/admin/metrics, and what the thresholds mean
  • Reset vs replay: what each does, when to reach for it, and the fact that replay is safe to re-run because the dedup constraint makes it idempotent
  • The INDEXER_* vars plus SOROBAN_RPC_URL and STREAM_CONTRACT_ID, and what happens when the indexer is disabled

Done when

  • Lag reading + thresholds documented
  • Reset/replay endpoints documented, including the idempotency note
  • Env vars and disabled-indexer behavior documented

Where to start
Add this to backend/docs/SSE_ARCHITECTURE.md and backend/SSE_README.md. Don't re-document the on-chain data flow that's already in ARCHITECTURE.md. Pure docs, no code changes.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26Stellar WaveIssues in the Stellar wave programdevopsInfrastructure and CI/CDdocsDocumentationdocumentationDocumentation tasks

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions