open-telemetry / open-telemetry/opentelemetry-python
Update Logging API/SDK end use documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Is your feature request related to a problem?
As part of Logging API/SDK becoming stable, it would help to update the documentation around end use and expectations. Concerns in Sept 2025 with current state were:
- only the root logger is instrumented, so seen loggers must have propagate set to True
- the root logger is instrumented, so handlers on it must not be cleared and if you are loading logging settings with logging/.config.dictConfig, you must save the root loggers before applying dictConfig, then re-apply missing handlers
Describe the solution you'd like
Update the Logging API/SDK documentation, for example at the readthedocs and at otel.io auto-instrumentation example:
- https://opentelemetry-python.readthedocs.io/en/stable/examples/logs/README.html
- https://opentelemetry.io/docs/zero-code/python/logs-example/
Describe alternatives you've considered
No response
Additional Context
CNCF Slack thread: https://cloud-native.slack.com/archives/C01PD4HUVBL/p1757081385395979
Would you like to implement a fix?
None
Tip
React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked readthedocs logs example and the OpenTelemetry auto-instrumentation logs example. Review the documented expectations for root logger instrumentation, propagation, handlers, and dictConfig, then update both documentation locations so the stable Logging API/SDK behavior and configuration steps are accurate and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100