docs: Fix tracing setup documentation #1734
Merged
+270
−27
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
|
Thanks for sending this. However, the ref files are generated from docstring in source code; so improve the docstring instead. |
- Replace stub documentation in docs/ref/tracing/setup.md with comprehensive content - Add detailed function documentation for all setup functions - Include practical examples and common setup patterns - Add troubleshooting section for common setup issues - Document environment variables and configuration options Fixes incomplete reference documentation that was previously just a module reference.
- Add detailed class and method descriptions - Include practical usage examples - Add implementation notes and best practices - Document attributes and parameters - Fix according to review feedback
abdul-kabir-jawed
force-pushed
the
fix-tracing-setup-docs
branch
from
cfdfddc to
0b5a7de
Compare
seratch
approved these changes
Sep 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR fixes the incomplete tracing setup documentation by replacing a stub with comprehensive documentation.
Problem
The current
docs/ref/tracing/setup.mdfile contains only:# `Setup` ::: agents.tracing.setupThis provides no useful information to developers trying to understand how to configure tracing.
Solution
Replaced the stub with comprehensive documentation including:
Function Documentation: Detailed explanations for all setup functions:
set_tracing_disabled()set_tracing_export_api_key()add_trace_processor()set_trace_processors()Practical Examples: Working code examples for each function
Common Patterns: Real-world setup scenarios
Environment Variables: Documentation of
OPENAI_AGENTS_DISABLE_TRACINGTroubleshooting: Common setup issues and solutions
Changes Made
Impact