Skip to content
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.

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

[Metrics] Add --show-hidden-metrics-for-version CLI arg #13295

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

markmc
Copy link
Contributor

@markmc markmc commented Feb 14, 2025

Part of #10582 and discussed in #12745

Add some infrastructure to help us deprecate and remove metrics in a less user-hostile way.

Our deprecation process will now be:

  1. Deprecate the metric in 0.N.0 - document the deprecation in
    release notes, user-facing docs, and the help text in /metrics
  2. Hide the metric in 0.N+1.0 - users can still re-enable the
    metrics using --show-hidden-metrics-for-version=0.N.0 as an
    escape hatch
  3. Remove the metric completely in 0.N+2.0

--show-hidden-metrics takes a version string argument so that users cannot fall into the habit of always enabling all deprecated metrics, which would defeat the purpose.

This approach is copied directly from kubernetes/kubernetes#85270

Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added documentation Improvements or additions to documentation v1 labels Feb 14, 2025
@markmc markmc force-pushed the metrics-v1-show-hidden-metrics-for-version branch from 52c20bf to b02294b Compare February 14, 2025 15:46
Add some infrastructure to help us deprecate and remove metrics
in a less user-hostile way.

Our deprecation process will now be:

1) Deprecate the metric in 0.N.0 - document the deprecation in
   release notes, user-facing docs, and the help text in `/metrics`
2) Hide the metric in 0.N+1.0 - users can still re-enable the
   metrics using `--show-hidden-metrics-for-version=0.N.0` as an
   escape hatch
3) Remove the metric completely in 0.N+2.0

`--show-hidden-metrics` takes a version string argument so that
users cannot fall into the habit of always enabling all deprecated
metrics, which would defeat the purpose.

This approach is copied directly from kubernetes/kubernetes#85270

Signed-off-by: Mark McLoughlin <[email protected]>
@markmc markmc force-pushed the metrics-v1-show-hidden-metrics-for-version branch from b02294b to b7ca51b Compare February 15, 2025 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant