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

Why this matters

docs/ has SSE_ARCHITECTURE/IMPLEMENTATION and auth/versioning docs but no indexer runbook. The admin recovery endpoints, the lag/health semantics, and the indexer env vars (INDEXER_POLL_INTERVAL_MS, INDEXER_START_LEDGER, STREAM_CONTRACT_ID) are undocumented operationally, so on-call has no guidance for recovering after an RPC outage or replaying missed ledgers.

Acceptance criteria

  • Document how to read indexer lag from /health and /v1/admin/metrics and what lag thresholds mean
  • Document the reset vs replay endpoints, when to use each, and that replay is idempotent via the dedup constraint
  • Document the INDEXER_*/SOROBAN_RPC_URL/STREAM_CONTRACT_ID env vars and the disabled-indexer behavior

Files to touch

  • backend/docs/SSE_ARCHITECTURE.md
  • backend/SSE_README.md

Out of scope

  • Re-documenting the on-chain data-flow already in ARCHITECTURE.md

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdevopsInfrastructure and CI/CDdocsDocumentationdocumentationDocumentation tasks

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions