docs: add a docs/guides/metrics.md #2160
Conversation
keivenchang
requested review from
biswapanda,
hhzhang16,
hutm,
ishandhanani,
julienmancuso,
mohammedabdulwahhab and
nnshah1
as code owners
WalkthroughA note was added to the beginning of the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
deploy/metrics/README.md (1)
5-7: Adopt repository-wide admonition syntax for consistencyOther Markdown guides in this repo appear to use the common
!!! note/ indented-block style (rendered by MkDocs & most Markdown processors with the admonition plugin).
The current[!NOTE]blockquote renders as plain text on GitHub and breaks the visual consistency of the docs set.-> [!NOTE] -> For detailed information about Dynamo's metrics system, including hierarchical metrics, automatic labeling, and usage examples, see the [Metrics Guide](../../docs/guides/metrics.md). +!!! note + For detailed information about Dynamo's metrics system—including hierarchical metrics, automatic labeling, and usage examples—see the [Metrics Guide](../../docs/guides/metrics.md).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
deploy/metrics/README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Build and Test - vllm
- GitHub Check: Build and Test - vllm
keivenchang
force-pushed
the
keivenchang/create-a-new-guide-on-using-the-metricsregistry-apis__DYN-779
branch
from
1a58512 to
87bb602
Compare
rmccorm4
left a comment
rmccorm4
left a comment
There was a problem hiding this comment.
Left a couple questions - but great foundation for the metrics docs!
nnshah1
left a comment
nnshah1
left a comment
There was a problem hiding this comment.
very nice. I think we should think about the best places for "Overview" -> which I think this does a great job. Then developer guide - likely a new doc. then dasbhoard guide - which I think is what the deploy/readme.md should be.
Finally - the metrics returned by a component - we should reference the component documentation. Each component should document their metrics there - to avoid having to blow this one up.
If that makes sense - we can add follow up tickets
keivenchang
force-pushed
the
keivenchang/create-a-new-guide-on-using-the-metricsregistry-apis__DYN-779
branch
from
76e6064 to
b8a4a1d
Compare
keivenchang
deleted the
keivenchang/create-a-new-guide-on-using-the-metricsregistry-apis__DYN-779
branch
Overview:
This PR adds a comprehensive metrics guide documenting Dynamo's hierarchical Prometheus metrics system, including the MetricsRegistry trait, automatic labeling, and base metrics.
Details:
Where should the reviewer start?
docs/guides/metrics.md: Review the overall structure and completenes
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
DYN-779: Create a new guide on using the MetricsRegistry APIs
Summary by CodeRabbit