Skip to content

docs(health): correct readiness/liveness route paths in doc comments - #2769

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 1 commit into
mainfrom
jszwedko/fix-health-route-docs
Oct 2, 2026
Merged

gh-worker-dd-mergequeue-cf854d[bot] merged 1 commit into
mainfrom
jszwedko/fix-health-route-docs

Conversation

@jszwedko

@jszwedko jszwedko commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator

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

  • 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

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>
@jszwedko
jszwedko requested a review from a team as a code owner October 2, 2026 19:28
@jszwedko jszwedko added the changelog/no-changelog No changelog entry needed label Oct 2, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-02T19:29:48.815343Z e1d5ef8 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@dd-octo-sts dd-octo-sts Bot added the area/core Core functionality, event model, etc. label Oct 2, 2026

@datadog-prod-us1-3 datadog-prod-us1-3 Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bits Code Review: PASS

More details

The corrected /ready and /live references match the routes registered by HealthAPIHandler, including the endpoint description associated with snapshot_json.

Was this helpful? React 👍 or 👎

Open Bits AI session

🤖 Bits Code Review · Commit e1d5ef8 · @DataDog review to ask questions

@pr-commenter

pr-commenter Bot commented Oct 2, 2026

Copy link
Copy Markdown

Binary Size Analysis (Agent Data Plane)

Baseline: 6e3f308 · Comparison: e1d5ef8 · diff
Analysis Configuration: stripped binaries · Pass/Fail Threshold: +5%
Sizes: 38.30 MiB (baseline) vs 38.30 MiB (comparison)
Size Change: -1016 B (-0.00%)

✅ Binary size difference within threshold

Changes by Module
Module File Size Symbols
anon.9d1057ec6821611763596b0232be6ef0.693.llvm.6678353967787269721 -11.14 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.693.llvm.10350347539038466960 +11.13 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.4.llvm.10350347539038466960 +8.48 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.4.llvm.6678353967787269721 -8.48 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.6.llvm.10350347539038466960 +6.32 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.6.llvm.6678353967787269721 -6.32 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.598.llvm.10350347539038466960 +5.66 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.598.llvm.6678353967787269721 -5.66 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.37.llvm.6678353967787269721 -3.82 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.37.llvm.10350347539038466960 +3.82 KiB 1
anon.67a117a504b2341279ac41dc5608f0a0.408.llvm.13022223797115277247 +2.92 KiB 1
anon.67a117a504b2341279ac41dc5608f0a0.408.llvm.10153085046072639149 -2.92 KiB 1
anon.526324b502f0d5ee46d400b5094a2c4f.888.llvm.15188122776301422792 -2.74 KiB 1
anon.526324b502f0d5ee46d400b5094a2c4f.888.llvm.9532847315904408429 +2.74 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.2.llvm.10350347539038466960 +2.61 KiB 1
anon.9d1057ec6821611763596b0232be6ef0.2.llvm.6678353967787269721 -2.61 KiB 1
anon.67a117a504b2341279ac41dc5608f0a0.386.llvm.10153085046072639149 -2.57 KiB 1
anon.67a117a504b2341279ac41dc5608f0a0.386.llvm.13022223797115277247 +2.56 KiB 1
anon.0e4addeb4054399514e831cee86c6c0d.977.llvm.7685692190874187214 -2.42 KiB 1
anon.0e4addeb4054399514e831cee86c6c0d.977.llvm.17021782687419503369 +2.41 KiB 1
Detailed Symbol Changes
    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [NEW] +11.1Ki  [NEW]     +81    anon.9d1057ec6821611763596b0232be6ef0.693.llvm.10350347539038466960
  [NEW] +8.48Ki  [NEW]     +81    anon.9d1057ec6821611763596b0232be6ef0.4.llvm.10350347539038466960
  [NEW] +6.32Ki  [NEW]     +77    anon.9d1057ec6821611763596b0232be6ef0.6.llvm.10350347539038466960
  [NEW] +5.66Ki  [NEW]     +79    anon.9d1057ec6821611763596b0232be6ef0.598.llvm.10350347539038466960
  [NEW] +3.82Ki  [NEW]     +16    anon.9d1057ec6821611763596b0232be6ef0.37.llvm.10350347539038466960
  [NEW] +2.92Ki  [NEW]     +92    anon.67a117a504b2341279ac41dc5608f0a0.408.llvm.13022223797115277247
  [NEW] +2.74Ki  [NEW]     +76    anon.526324b502f0d5ee46d400b5094a2c4f.888.llvm.9532847315904408429
  [NEW] +2.61Ki  [NEW]     +75    anon.9d1057ec6821611763596b0232be6ef0.2.llvm.10350347539038466960
  [NEW] +2.56Ki  [NEW]     +85    anon.67a117a504b2341279ac41dc5608f0a0.386.llvm.13022223797115277247
  [NEW] +2.41Ki  [NEW]    +101    anon.0e4addeb4054399514e831cee86c6c0d.977.llvm.17021782687419503369
  -0.1%   -1013  [ = ]       0    [5681 Others]
  [DEL] -2.42Ki  [DEL]    -101    anon.0e4addeb4054399514e831cee86c6c0d.977.llvm.7685692190874187214
  [DEL] -2.57Ki  [DEL]     -85    anon.67a117a504b2341279ac41dc5608f0a0.386.llvm.10153085046072639149
  [DEL] -2.61Ki  [DEL]     -75    anon.9d1057ec6821611763596b0232be6ef0.2.llvm.6678353967787269721
  [DEL] -2.74Ki  [DEL]     -76    anon.526324b502f0d5ee46d400b5094a2c4f.888.llvm.15188122776301422792
  [DEL] -2.92Ki  [DEL]     -92    anon.67a117a504b2341279ac41dc5608f0a0.408.llvm.10153085046072639149
  [DEL] -3.82Ki  [DEL]     -16    anon.9d1057ec6821611763596b0232be6ef0.37.llvm.6678353967787269721
  [DEL] -5.66Ki  [DEL]     -79    anon.9d1057ec6821611763596b0232be6ef0.598.llvm.6678353967787269721
  [DEL] -6.32Ki  [DEL]     -77    anon.9d1057ec6821611763596b0232be6ef0.6.llvm.6678353967787269721
  [DEL] -8.48Ki  [DEL]     -81    anon.9d1057ec6821611763596b0232be6ef0.4.llvm.6678353967787269721
  [DEL] -11.1Ki  [DEL]     -81    anon.9d1057ec6821611763596b0232be6ef0.693.llvm.6678353967787269721
  -0.0%   -1016  [ = ]       0    TOTAL

@pr-commenter

pr-commenter Bot commented Oct 2, 2026

Copy link
Copy Markdown

Regression Detector (Agent Data Plane)

Run ID: c455d2bf-3ada-4210-ab0a-28eef9d23948
Baseline: 6e3f3086 · Comparison: e1d5ef8b · diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment (5)

Experiments configured erratic: true are tagged (ignored) and skipped when determining which experiments regressed or improved. Experiments which are detected as erratic at runtime are tagged (erratic) to flag that the run's sample dispersion was high, but their regression / improvement signal still counts.

experiment goal Δ mean % links
quality_gates_rss_dsd_ultraheavy memory ⚪ +1.08 metrics profiles logs
quality_gates_rss_dsd_heavy memory ⚪ +0.67 metrics profiles logs
quality_gates_rss_idle memory ⚪ +0.41 metrics profiles logs
quality_gates_rss_dsd_low memory ⚪ +0.07 metrics profiles logs
quality_gates_rss_dsd_medium memory ⚪ -0.42 metrics profiles logs
Bounds Checks: ✅ Passed (5)
experiment check replicates observed links
quality_gates_rss_dsd_heavy memory_usage 10/10 ✅ 231 MiB ≤ 250 MiB metrics profiles logs
quality_gates_rss_dsd_low memory_usage 10/10 ✅ 51.6 MiB ≤ 60 MiB metrics profiles logs
quality_gates_rss_dsd_medium memory_usage 10/10 ✅ 90.2 MiB ≤ 100 MiB metrics profiles logs
quality_gates_rss_dsd_ultraheavy memory_usage 10/10 ✅ 387 MiB ≤ 420 MiB metrics profiles logs
quality_gates_rss_idle memory_usage 10/10 ✅ 33.2 MiB ≤ 40 MiB metrics profiles logs
Explanation

A 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 (is_regression: true). Improvements use the matching criteria for the improving direction. Experiments configured erratic: true (tagged (ignored)) are skipped outright; experiments detected as erratic at runtime (tagged (erratic)) still count, since that flag describes sample dispersion rather than directional certainty. The Δ mean % cell is colored accordingly: 🟢 = improvement, 🔴 = regression, ⚪ = neutral. Reduction in CPU or memory is an improvement; reduction in ingress throughput is a regression. Experiments tagged (no analysis) show ⚠️ n/a: SMP ran them but produced no analysis, usually because a replicate failed and exhausted its retries. Check the SMP report for that experiment's replicate failures.

@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot merged commit fe3c322 into main Oct 2, 2026
123 checks passed
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot deleted the jszwedko/fix-health-route-docs branch October 2, 2026 20:54
dd-octo-sts Bot pushed a commit that referenced this pull request Oct 2, 2026
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Core functionality, event model, etc. changelog/no-changelog No changelog entry needed mergequeue-status: done

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants