feat: add dependency probes to /api/indexer/health - #557
Merged
greatest0fallt1me merged 3 commits intoJul 27, 2026
Merged
Conversation
|
@adesuwa-tech Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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.
Summary
Add Postgres and Soroban RPC dependency probes to the
GET /api/indexer/healthendpoint alongside the existing cursor lag check.Changes
src/routes/indexer/health.ts: Added injectable dependency probes for database (PostgresSELECT 1) and Soroban RPC (getLatestLedger). Response now includesdependencies(database, sorobanRpc) with status/latency,correlationId,checkedAt, and preserves the existingdatafield with lag information. ETag is computed from the deterministic parts only (dependencies + data) to maintain stability across requests.tests/indexerHealth.test.ts: Rewrote tests to use injectable deps pattern (followingwebhooksHealth.test.ts). Added 19 new test cases covering dependency probe status, overall status computation, correlationId, and error handling.tests/indexerHealthEtag.test.ts: Updated to use injectable deps pattern. All 12 ETag/conditional GET tests pass with the new response shape.README.md: Updated endpoint description to reflect the new dependency probe functionality.Response shape
{ "status": "ok" | "degraded" | "down", "correlationId": "<uuid>", "checkedAt": "<ISO-8601>", "dependencies": { "database": { "status": "ok"|"down", "latencyMs": <n>, "error?": "..." }, "sorobanRpc": { "status": "ok"|"down", "latencyMs": <n>, "error?": "..." } }, "data": { "status": "ok" | "degraded" | "down", "cursor": <n>, "chainTip": <n> | null, "lag": <n> | null, "maxLag": <n> } }statusis"down"if any dependency is down or chain tip is unreachable,"degraded"if lag exceeds threshold,"ok"otherwise.Closes #488