Skip to content

Enhance Python logs auto-instrumentation documentation #1687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Calm-Rock
Copy link
Member

@Calm-Rock Calm-Rock commented Jul 17, 2025

Summary

This PR enhances the Python logs auto-instrumentation documentation to address the requirements outlined in issue #1421. The documentation now provides comprehensive guidance on:

  • Ideal way of sending logs from Python applications using OpenTelemetry auto-instrumentation
  • Logs correlation with traces and spans, including automatic correlation and best practices
  • Helm chart log collection with metadata enrichment for Kubernetes deployments
  • Pipeline parsing examples for JSON, trace information, and custom attributes
  • Troubleshooting guide with common issues and debug steps

Key Changes

  • Added prerequisites section for clear setup requirements
  • Expanded introduction with recommended approach and benefits
  • New comprehensive logs correlation section with code examples
  • Kubernetes deployment guidance with Helm chart configuration
  • Pipeline parsing examples for different log formats
  • Troubleshooting section with practical solutions
  • Next steps for further exploration

Test Plan

  • Review documentation structure and flow
  • Verify all code examples are syntactically correct
  • Check internal links point to correct documentation
  • Ensure consistent formatting and style
  • Validate YAML configuration examples

Fixes #1421

Calm-Rock and others added 3 commits July 15, 2025 17:01
- Add ideal way of sending logs from Python applications section
- Include detailed logs correlation guidance with code examples
- Add Helm chart log collection information with metadata details
- Provide pipeline parsing examples for JSON, trace, and custom attributes
- Add troubleshooting section with common issues and debug steps
- Include prerequisites, best practices, and next steps

Addresses issue #1421 by providing comprehensive guidance on Python logs
auto-instrumentation, correlation techniques, and pipeline configuration.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copy link

vercel bot commented Jul 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
signoz-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2025 6:39am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve docs on logs collection (Python)
1 participant