docs(instrument): explain native Event context values#3768
Open
chet wants to merge 1 commit into
Open
Conversation
This is the documentation half of NVIDIA#3746. Document the narrow `#[context(value)]` form for Event context that must retain its structured tracing type. The guide names the supported native types, requires checked lossless conversion for other numeric widths, and keeps `Display` as the fallback when that guarantee is unavailable. This supports NVIDIA#3731 Signed-off-by: Chet Nichols III <chetn@nvidia.com>
Contributor
|
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)
Summary by CodeRabbit
WalkthroughThe instrumentation guide clarifies supported ChangesObservability documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
Author
|
@coderabbitai full_review, thanks! |
Contributor
|
🐇🔍 ✅ Action performedFull review finished. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3768.docs.buildwithfern.com/infra-controller |
10 tasks
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.
This is the documentation half of #3746.
Document the narrow
#[context(value)]form for Event context that must retain its structured tracing type. The guide names the supported native types, requires checked lossless conversion for other numeric widths, and keepsDisplayas the fallback when that guarantee is unavailable.Related issues
Type of Change
Breaking Changes
Testing
Verified with:
cargo make format-nightlygit diff --checkThe native-value and parser coverage remains with #3746.
Additional Notes
This docs PR depends on #3746 and should merge after it so
maindoes not advertise syntax before the implementation is available. The crate-level example and derive documentation remain with the code so their Rust examples are compiled against the API they describe.