Add an incident response runbook for stellar rpc or ipf gateway outages - #571
Open
Johnsource-hub wants to merge 4 commits into
Conversation
added 4 commits
July 19, 2026 14:39
…nt related database functionality
…ogging and auth introspection
…ted readiness endpoint for resilient monitoring
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
1 participant
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
#512
Description
This Pull Request introduces operational runbooks and mitigation strategies for managing outages of external service dependencies (Stellar/Soroban RPC and IPFS/Pinata). It addresses the risk of complete service unavailability caused by health check degradation on non-blockchain endpoints during external service disruptions.
Key Changes
Created a comprehensive runbook at docs/runbooks/dependency-outages.md containing actionable steps for on-call engineers.
Documents detection signals (specific log formats and HTTP response payloads) for both Stellar RPC and IPFS/Pinata outages.
Explains concrete, immediate mitigation procedures using environment variables and fallback mechanisms.
Outlines recovery verification queries and communication templates for stakeholders.
/ready Endpoint Mapping: Added the GET /ready route in src/index.ts to align the application's actual routes with test cases, README.md, and DEPLOYMENT.md.
IPFS Stub Mode (IPFS_STUB_MODE):
Added config.ipfsStubMode property, mapped to the IPFS_STUB_MODE environment variable.
Updated src/services/ipfs.ts to intercept JSON/file pinning requests and health checks. When IPFS Stub Mode is enabled, the service resolves health checks instantly and returns a valid static mock CID (QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG), allowing player registration and validator milestone submissions to proceed during Pinata downtime.
Added process.env.STELLAR_HEALTH_CHECK = 'false' in tests/routes/health.test.ts to prevent external network calls to the Soroban RPC endpoint during testing, preventing 5000ms test timeouts and improving pipeline build speeds.
Linked the outage runbook in README.md (under "Health Endpoints") and DEPLOYMENT.md (under "Health & Monitoring").