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
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.
Labels:
documentation,Stellar Wave,devops,docsWe 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
/healthand/v1/admin/metrics, and what the thresholds meanINDEXER_*vars plusSOROBAN_RPC_URLandSTREAM_CONTRACT_ID, and what happens when the indexer is disabledDone when
Where to start
Add this to
backend/docs/SSE_ARCHITECTURE.mdandbackend/SSE_README.md. Don't re-document the on-chain data flow that's already in ARCHITECTURE.md. Pure docs, no code changes.