[serve] metrics route filters #57604
Open
Conversation
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
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds filters to exclude metrics from health check (/-/healthz) and routes (/-/routes) endpoints in test utility functions. This ensures that tests for application-level metrics are not affected by these internal endpoints. The changes are correct and achieve the stated goal. I've provided a couple of suggestions to improve code quality by reducing duplication and improving readability.
Signed-off-by: omkar <omkar@anyscale.com>
ray-gardener
bot
added
serve
akyang-anyscale
approved these changes
Oct 9, 2025
| from ray.serve.generated import serve_pb2, serve_pb2_grpc | ||
| from ray.util.state import list_actors | ||
|
|
||
| ALLOWED_ROUTES = ("/-/healthz", "/-/routes") |
There was a problem hiding this comment.
I think EXCLUDED_ROUTES is more fitting. Also do we need to include /-/routes?
Comment on lines
+719
to
+720
| if any(f'route="{route}"' in line for route in ALLOWED_ROUTES): | ||
| continue |
There was a problem hiding this comment.
can simplify the expression if we're just checking for /-/healthz
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Why are these changes needed?
For tests, currently health check and
routesendpoint requests are counted. This PR adds a filter to remove these endpoints from metrics aggregation to ensure only valid app level api requests are counted.Related issue number
Checks
git commit -s) in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.