docs: docs for machine id metrics and hw-health metrics fetch#3377
docs: docs for machine id metrics and hw-health metrics fetch#3377yoks wants to merge 2 commits into
Conversation
Signed-off-by: ianisimov <ianisimov@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
Summary by CodeRabbit
WalkthroughExpanded monitoring documentation with hardware entity metrics configuration and output details, plus opt-in per-object health metrics behavior and lifecycle semantics. ChangesMonitoring health documentation
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3377.docs.buildwithfern.com/infra-controller |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/operations/monitoring-health.md`:
- Around line 595-597: The monitoring documentation inaccurately claims
classification-based emission keeps cardinality bounded. In the opt-in emission
description, replace “bounded” with wording that it helps contain cardinality,
clarify that object_id still scales series with fleet size, and note that
multiple enabled classifications multiply per-object series.
- Around line 610-617: The rack alert example is incompatible with the
documented metric labels because it neither filters to machines nor identifies
racks. Update the example prose and PromQL to describe a fleet-wide
hardware-unhealthy machine count, or add/document a `rack_id` label and group
the query by rack so it can correctly alert on per-rack totals.
- Around line 227-232: Clarify the sink-specific query contract in the section
describing series labels and OTLP. State that Prometheus exposes inventory
context as metric labels, while OTLP exports it as resource attributes; document
the exact attribute-to-label mapping and query differences, or limit the claim
to shared metric names without asserting identical Grafana queries.
- Around line 604-608: The monitoring documentation’s eviction timing statement
is inaccurate: update the paragraph near the per-object classification metrics
to state that series are retained for the registry’s hold period, which is
configured slightly longer than the state controllers’ `metric_hold_time`,
rather than expiring exactly at that value. Preserve the existing behavior for
empty classifications and aggregate metrics.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 8e57c192-97ff-41ed-a3de-ae7a282c8c64
📒 Files selected for processing (1)
docs/operations/monitoring-health.md
Signed-off-by: ianisimov <ianisimov@nvidia.com>
Documentation updates for #2433 and #2168
Related issues
#2433 #2168
Type of Change
Breaking Changes
Testing
Additional Notes