docs(monitoring): add PromQL recipes page for joining metrics - #730
docs(monitoring): add PromQL recipes page for joining metrics#730imantaba wants to merge 2 commits into
Conversation
Add a Querying and joining metrics page under userguide/monitoring that shows how to correlate the scheduler allocation view and the real-time device usage view via the shared device_uuid label, and lists a few ready-to-use PromQL queries. Registered in the current and v2.9.0 sidebars. Signed-off-by: imantaba <itn.taba@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: imantaba The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Welcome @imantaba! It looks like this is your first PR to Project-HAMi/website 🎉 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAdded a PromQL recipes guide for HAMi monitoring queries. The guide covers device-label joins, node filtering, memory utilization, high-memory containers, shared GPUs, and 0–100 ratio metrics. Added the page to current and v2.9.0 Monitoring navigation. ChangesPromQL monitoring documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
@Shenhan11 can you take a look? |
mesutoezdil
left a comment
There was a problem hiding this comment.
checked all metric names and labels against the monitoring pages, they match. checklist is unchecked and the docs health ci did not run, please rebase and run the checks.
| @@ -0,0 +1,54 @@ | |||
| --- | |||
There was a problem hiding this comment.
this adds a brand new page to the frozen v2.9.0 snapshot. is that wanted, or current docs only?
There was a problem hiding this comment.
Current docs only. I'd originally added it to the v2.9.0 snapshot so it would show on the default docs version, but you are right that the versioned snapshot should stay frozen.
I've dropped the page and it.s sidebar entry from version-v2.9.0 the guide now lives only under current docs/ and will roll into the next version snapshot at release time.
Remove the page and its sidebar entry from the frozen v2.9.0 snapshot; the guide belongs in the current docs only. Signed-off-by: imantaba <itn.taba@gmail.com>
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds a "Querying and joining metrics" page under
userguide/monitoring(sidebar: "PromQL recipes"). The existing monitoring pages document each metrics endpoint separately; none show how to correlate them. This page fills that gap:device_uuidlabel, so you can relate a device's allocation to its live usage. Covers theand on (device_uuid)filter and, because the host usage metrics carry nonodelabel, a* on (device_uuid) group_left(node)join that actually carriesnodeacross._ratiometrics use a 0-100 scale.Registered in both the current and the v2.9.0 sidebars, with the page added under
docs/andversioned_docs/version-v2.9.0/.Follow-up to Project-HAMi/HAMi#2374, which @archlitchi redirected here (main-repo
docs/is design-docs-only; user-guide content belongs on the website).Which issue(s) this PR fixes:
Checklist:
npm run lint/npm run format:check— not run locally; page written to.markdownlint.json/.prettierrcconventions (single-line prose, dash bullets, final newline). Please let CI verify.npm run build(en/zh) — not run locally.zhtranslation if you'd like it in this PR.git commit -s)This change was prepared with AI assistance (per CONTRIBUTING.md); all changes were reviewed and verified by me.
Summary by CodeRabbit