Skip to content

Document health payload field order and grouping #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chucks1093 merged 1 commit into from
May 27, 2026
Merged

Document health payload field order and grouping #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/health-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,28 @@ Full system snapshot including memory, uptime, system info, database
response time, chain-sync lag and per-service health flags. Intended for
operators rather than load balancers — cheaper liveness/readiness paths
should be preferred for automated probing.

### Field order and grouping

The detailed health payload should preserve this top-level order to keep
JSON snapshots predictable for contributors and dashboards:

1. `success`
2. `message`
3. `timestamp`
4. `version`
5. `environment`
6. `uptime`
7. `memory`
8. `system`
9. `database`
10. `syncing`
11. `services`

Nested grouping follows the same convention:

- `memory`: `used`, `total`
- `system`: `platform`, `nodeVersion`
- `database`: `status`, `responseTime` (when connected)
- `syncing`: `status`, `latestIndexedLedger`, `observedHeadLedger`, `syncLagLedgers`
- `services`: ordered as `API Server`, `Database`, `Chain Sync`
Loading