Skip to content

docs: rewrite metrics.md for current EPP subsystems#19

Open
chethanuk wants to merge 2 commits into
mainfrom
fix/issue-1394-metrics-docs
Open

docs: rewrite metrics.md for current EPP subsystems#19
chethanuk wants to merge 2 commits into
mainfrom
fix/issue-1394-metrics-docs

Conversation

@chethanuk

@chethanuk chethanuk commented Jul 19, 2026

Copy link
Copy Markdown
Owner

User description

What type of PR is this?

/kind documentation

What this PR does / why we need it:

docs/metrics.md stated that all metrics live under the
llm_d_inference_scheduler subsystem, which is now deprecated after the
router rename and metrics migration. This rewrites the guide against the
current code:

Notes for reviewers on the issue's wording vs the code: the canonical EPP-wide
prefix is llm_d_epp_*, not llm_d_router_epp_* (which is kv-cache-only); and
pd_decision_total / disagg_decision_total are both current llm_d_epp_*
metrics — the actual deprecation is llm_d_inference_scheduler_* -> llm_d_epp_* per metric. Every documented metric name was cross-checked against
its registration in pkg/. The e2e kv-cache metrics assertion (issue item 4)
is left as the noted follow-up.

Which issue(s) this PR fixes:

Fixes llm-d#1394

Release note:

NONE

CodeAnt-AI Description

Update the metrics guide for the current EPP metrics and scrape setup

What Changed

  • Replaces the outdated single-prefix view with the current EPP metric names and shows which legacy names are still emitted during migration
  • Adds the current scrape layout: the EPP /metrics endpoint, model-server data-layer metrics, and embedded kv-cache metrics on the shared registry
  • Expands the catalog to cover request, pool, scheduler, plugin, data-layer, flow control, ext_proc, prefix cache, multimodal, fairness, predicted latency, and kv-cache metrics
  • Clarifies the deprecated pd_decision_total behavior and points readers to the current disaggregation metric
  • Adds links to related observability work

Impact

✅ Easier metrics migration
✅ Clearer operator scrape setup
✅ Fewer mismatches between docs and live metrics

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

The metrics guide claimed all series live under the llm_d_inference_scheduler
subsystem, which is now deprecated. Document the current subsystems
(llm_d_epp_ for EPP-wide metrics, llm_d_router_epp_ for the embedded
kv-cache), mark the legacy dual-emitted prefixes and their replacements,
expand the catalog beyond disaggregation to the full request, pool,
scheduler, plugin, and data-layer set, and add operator scrape topology
(EPP :9090/metrics, model-server data layer, embedded kv-cache on the
shared registry).

Refs: llm-d#1394
Signed-off-by: ChethanUK <chethanuk@outlook.com>
@codeant-ai

codeant-ai Bot commented Jul 19, 2026

Copy link
Copy Markdown

🤖 CodeAnt AI — Review Status

Status Commit Started (UTC) Finished (UTC)
✅ Reviewed your PR 7ba7025 Jul 19, 2026 · 11:59 12:00

Updated in place by CodeAnt AI · last 5 reviews

@codeant-ai

codeant-ai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@chethanuk, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c1f37247-bb99-4e71-a8b3-0e427aea31f0

📥 Commits

Reviewing files that changed from the base of the PR and between c82561b and d07fd54.

📒 Files selected for processing (1)
  • docs/metrics.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-1394-metrics-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codeant-ai codeant-ai Bot added the size:L This PR changes 100-499 lines, ignoring generated files label Jul 19, 2026

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates and expands the documentation in docs/metrics.md to comprehensively detail the Prometheus metrics exposed by the llm-d-router Endpoint Picker (EPP). It introduces structured sections explaining subsystems and naming prefixes, scrape topologies, deprecated series, and a detailed metrics catalog categorized by functional areas such as flow control, disaggregation, and the KV-cache index. No review comments were provided, so there is no additional feedback to address.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Only recorders that have a deprecated predecessor dual-emit; current-only
series (ext_proc, program-aware fairness, encoder cache, kv-cache events)
emit a single series. Qualify the sentence so it does not read as universal.

Signed-off-by: ChethanUK <chethanuk@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Observability] improve EPP observability guide and metrics documentation

1 participant