docs(byoo): document upstream telemetry compatibility - #763
Open
sbaum1994 wants to merge 2 commits into
Open
Conversation
Define upstream metric semantics as authoritative for BYOO telemetry. Explain how collector and cAdvisor changes update validation references instead of adding compatibility rewrites. Signed-off-by: Stephanie Baum <sbaum@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)
📝 WalkthroughWalkthroughThis change adds BYOO telemetry compatibility guidance and links the page from Observability navigation. The guidance covers upstream metric preservation, validation, fixture updates, upgrade review, and documented transformation rules. ChangesBYOO telemetry documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/user/cluster-management/byoo-telemetry-compatibility.md`:
- Around line 59-60: Update the link label in the BYOO collector options
guidance from “NVCA Configuration” to “NVCF Configuration,” preserving the
existing configuration.md#agent-config-merging target.
- Around line 12-18: Update the preservation rule in the telemetry compatibility
guidance to explicitly include histogram bucket boundaries alongside metric
names, types, labels, and label values. Keep the existing prohibition on
unnecessary transformations and the surrounding authoritative-upstream guidance
unchanged.
🪄 Autofix
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: e5dc06d3-1207-4111-be20-a39534f15e94
📒 Files selected for processing (2)
docs/user/cluster-management/byoo-telemetry-compatibility.mdfern/versions/dev.yml
Comment on lines
+59
to
+60
| For BYOO collector options, refer to | ||
| [NVCA Configuration](./configuration.md#agent-config-merging). |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the configuration link label.
NVCA Configuration does not match the NVCF product name used throughout this page. Rename the label to NVCF Configuration.
🤖 Prompt for 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.
In `@docs/user/cluster-management/byoo-telemetry-compatibility.md` around lines 59
- 60, Update the link label in the BYOO collector options guidance from “NVCA
Configuration” to “NVCF Configuration,” preserving the existing
configuration.md#agent-config-merging target.
Frame upstream telemetry preservation as a team decision and state the upgrade cost directly. Clarify that validation fixtures detect changes rather than freeze the upstream contract. Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
TL;DR
Document the BYOO telemetry compatibility policy so users and maintainers treat
valid upstream OpenTelemetry Collector and cAdvisor metric semantics as
authoritative. This closes the documentation gap left after #693 restored valid
collector and pod-sandbox metrics.
Additional Details
and histogram buckets.
validation shape.
container="POD"changes asconcrete examples.
metric references and golden fixtures.
devdocumentation navigation underObservability.
Customer release notes: Documentation only. No runtime behavior changes.
Plan summary: Not applicable.
Dependencies: None. No license review or NOTICE update is required.
Related pull request: #693.
For the Reviewer
Review the boundary between preserving valid upstream telemetry and applying
documented filters for workload scope, sensitive metadata, or customer metric
subsets.
For QA
./tools/ci/check-docspassed. The advisory version-sync check could not findthe repository root after the worktree resolved under
/private/tmp.fern check --warningsfound zero errors. It reported one warning because theredirects check requires Fern authentication.
git diff --checkpassed.QA is not needed for this documentation-only change.
Issues
Closes #705
Checklist
Summary by CodeRabbit