docs(logging): document log record enrichment#4652
Open
popsiclelmlm wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #2642.
Documents the logging instrumentation behavior in the package README, including:
logging.LogRecordattributesLoggingInstrumentor().instrument(...)argumentsReproduction
The logging instrumentation README currently only covers installation and references. It does not explain the log record enrichment behavior requested in #2642.
Root cause
The enrichment and configuration details are implemented in the instrumentation, but the package README did not describe the behavior or fields added to log records.
Changes
LoggingInstrumentor.otelSpanID,otelTraceID,otelServiceName, andotelTraceSampled.Tests
git diff --check/tmp/otel-rstcheck-venv/bin/rstcheck instrumentation/opentelemetry-instrumentation-logging/README.rstScreenshots/Logs
N/A. Documentation-only change.