chore: Add documentation note about @traced()#291
Merged
Conversation
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| # This would be a database call in a real application | ||
| return f"User {user_id}: Sample information" | ||
|
|
||
| @interaction(pipeline_id=GENTRACE_PIPELINE_ID) |
Contributor
There was a problem hiding this comment.
The GENTRACE_PIPELINE_ID variable is referenced but not defined in this code example. Consider either:
-
Adding a definition at the top of the example:
GENTRACE_PIPELINE_ID = "your-pipeline-id"
-
Or replacing the direct reference with a placeholder:
@interaction(pipeline_id="your-pipeline-id")
This will make the example more self-contained and easier for users to understand what they need to replace with their own values.
Suggested change
| @interaction(pipeline_id=GENTRACE_PIPELINE_ID) | |
| @interaction(pipeline_id="your-pipeline-id") |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
viveknair
force-pushed
the
05-18-chore_add_documentation_note_about_traced_
branch
from
cd99fb2 to
03e7993
Compare
joshlebed
approved these changes
May 19, 2025
Contributor
Author
Merge activity
|
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
3 participants
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
Added documentation for the new
@traceddecorator that enables lower-level OpenTelemetry tracing.What changed?
traced)" to the README@traceddecorator@tracedand@interactiondecoratorsHow to test?
Review the new documentation section to ensure it clearly explains:
@traceddecorator@interactiondecoratorWhy make this change?
The
@traceddecorator provides more granular control over tracing, allowing developers to instrument specific functions or code blocks within a larger system. This addition complements the existing@interactiondecorator by enabling more detailed observability into application performance and behavior, especially for helper functions that don't represent complete interactions but are still important for debugging and monitoring.