open-telemetry / open-telemetry/opentelemetry-python-contrib
Document log record enrichment behavior of logging instrumentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
What problem do you want to solve?
From this comment, it is not super clear how the logging instrumentation enriches log records that are produced from the opentelemetry apis. It would be good to get some documentation on what the purpose of the logging instrumentation is (to not confuse users with simply setting up logging telemetry), configuration as well as which fields are added to log records.
Describe the solution you'd like
Doc sections created.
Describe alternatives you've considered
No response
Additional Context
No response
Would you like to implement a fix?
None
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 logging instrumentation source at instrumentation/opentelemetry-instrumentation-logging/src/opentelemetry/instrumentation/logging/init.py, especially the configuration near line 63 and added fields near line 95. Find the appropriate documentation location, then explain the instrumentation purpose, configuration, and log-record enrichment behavior; done means the requested sections are available and understandable to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100