docs(tracing): add OpenTelemetry span format guide #1350
Merged
Conversation
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
Add documentation describing the new OpenTelemetry-based span format for tracing, including configuration, key differences from the legacy format, migration steps, and important considerations around privacy and performance. Also add a test script to verify Jaeger integration with NeMo-Guardrails using OpenTelemetry, demonstrating trace export and event-span correlation.
Documentation preview |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1350 +/- ##
===========================================
+ Coverage 71.59% 71.62% +0.03%
===========================================
Files 168 171 +3
Lines 16862 17020 +158
===========================================
+ Hits 12072 12191 +119
- Misses 4790 4829 +39
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
miyoungc
requested changes
Aug 27, 2025
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
Co-authored-by: Miyoung Choi <[email protected]> Signed-off-by: Pouyan <[email protected]>
|
Thank you @miyoungc for the review. I applied the suggestions 👍🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Add documentation describing the new OpenTelemetry-based span format for tracing, including configuration, key differences from the legacy format, migration steps, and important considerations around privacy and performance. Also add a test script to verify Jaeger integration with NeMo-Guardrails using OpenTelemetry, demonstrating trace export and event-span correlation.