Skip to content

Missing Logger Documentation Content #2314

Description

@AbdulSamad94

The Logger documentation page in the OpenAI Agents SDK documentation is missing its main content. The page only shows the navigation sidebar and the "logger" link in the table of contents, but the actual documentation content explaining how to use the Logger functionality is not present.

Image

Expected Behavior

The Logger documentation page should contain:

  • Overview of the Logger functionality
  • How to enable/configure logging in the Agents SDK
  • Examples of using different logging levels
  • Integration with enable_verbose_stdout_logging()
  • How to customize logging output
  • Best practices for debugging agent runs

Current Behavior

  • The page loads with only navigation elements
  • No content is displayed in the main documentation area
  • Users cannot learn about logging capabilities from the documentation

Impact

This makes it difficult for developers to:

  • Debug their agent applications
  • Understand how to enable verbose logging
  • Configure custom logging for their use cases
  • Follow best practices for monitoring agent behavior

Suggested Fix

Add comprehensive documentation for the Logger module including:

  1. Basic Usage

    from agents import enable_verbose_stdout_logging
    import logging
    
    # Enable verbose logging
    enable_verbose_stdout_logging()
    
    # Set log level
    logging.basicConfig(level=logging.DEBUG)
  2. Configuration Options

    • How to set different logging levels
    • Configuring specific loggers (agents, openai, httpx)
    • Output formatting options
  3. Integration Examples

    • Using logging with tracing
    • Logging to files
    • Custom log handlers
  4. Debugging Tips

    • What information is logged at each level
    • How to troubleshoot common issues
    • Reading and interpreting agent logs

Would you like me to contribute documentation for this section? I'm happy to submit a PR with comprehensive Logger documentation including examples and best practices.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions