docs: document /ready /status /metrics and Kubernetes probes (COW-983)#72
Merged
lgahdl merged 3 commits intoMay 29, 2026
Conversation
…983) Add /ready, /status, and /metrics to the endpoints table with full descriptions. Document Kubernetes liveness/readiness probe config. Explain /status response shape and what "stuck" looks like vs normal backfill. Addresses client feedback about underdocumented health endpoints. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3 tests: verifies 200 status, {"status":"ok"} body, and JSON content-type.
Matches the behaviour documented in docs/api-reference.md.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
jeffersonBastos
approved these changes
May 29, 2026
Contributor
There was a problem hiding this comment.
I don't think that we need this... looks overhead.
| | `/status` | GET | Sync progress per chain. Returns current indexed block, latest chain block, and a completion percentage. Useful for monitoring backfill progress. | | ||
| | `/metrics` | GET | Prometheus metrics. Exposes Ponder internals (block lag, handler latency, RPC call counts). | | ||
|
|
||
| ### Health and readiness probes |
Contributor
There was a problem hiding this comment.
Also, overhead, the description of each one is in the previous table. And this kind of endpoint doesn't need a section; it is a "universal" endpoint
yvesfracari
approved these changes
May 29, 2026
yvesfracari
left a comment
yvesfracari
left a comment
There was a problem hiding this comment.
Approved but agree with Jeff comments
Addresses reviewer feedback: endpoint descriptions in the table are sufficient; the dedicated sub-sections and the healthz unit test are overhead. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
lgahdl
deleted the
luizhatem/cow-983-docs-document-all-health-readiness-status-and-metrics
branch
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
3 participants
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
/ready,/status, and/metricsto the endpoints table indocs/api-reference.md/healthz) and readiness (/ready) probe configuration with example YAML/statusresponse shape and what the fields mean (checkpoint, latest, ready)/statusshowing block lag during backfill is normal — not brokenAddresses client feedback: "/status and /metrics endpoints are not documented. There are liveness probes but not a readiness one."
Related Issues
COW-983
🤖 Generated with Claude Code