docs(health): correct readiness/liveness route paths in doc comments - #2769
Conversation
The health API handler serves `/ready` and `/live` at the root of the unprivileged API, not `/health/ready` and `/health/live`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
Binary Size Analysis (Agent Data Plane)Baseline: 6e3f308 · Comparison: e1d5ef8 · diff ✅ Binary size difference within thresholdChanges by Module
Detailed Symbol Changes |
Regression Detector (Agent Data Plane)Run ID: Optimization Goals: ✅ No significant changes detectedFine details of change detection per experiment (5)Experiments configured
Bounds Checks: ✅ Passed (5)
ExplanationA change is flagged as a regression when |Δ mean %| > 5.00% in the regressing direction for its optimization goal AND SMP marks the experiment as a regression ( |
…2769) ## Summary The `HealthAPIHandler` and `HealthRegistry::snapshot_json` doc comments say the health routes are `/health/ready` and `/health/live`. They are actually served at `/ready` and `/live` on the unprivileged API, so anyone following the docs gets a 404. This fixes the comments to match the real routes. ## Test plan - [x] Built ADP locally and checked port 5100: `/ready` → 503 with per-component JSON (not ready only because of a dummy API key), `/live` → 200, `/health/ready` and `/health/live` → 404. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: jesse.szwedko <jesse.szwedko@datadoghq.com> fe3c322
Summary
The
HealthAPIHandlerandHealthRegistry::snapshot_jsondoc comments say the health routes are/health/readyand/health/live. They are actually served at/readyand/liveon the unprivileged API, so anyone following the docs gets a 404. This fixes the comments to match the real routes.Test plan
/ready→ 503 with per-component JSON (not ready only because of a dummy API key),/live→ 200,/health/readyand/health/live→ 404.🤖 Generated with Claude Code