docs: document log record enrichment behavior of logging instrumentation#4753
Open
krrishapatel wants to merge 1 commit into
Open
docs: document log record enrichment behavior of logging instrumentation#4753krrishapatel wants to merge 1 commit into
krrishapatel wants to merge 1 commit into
Conversation
Expand the logging instrumentation README to explain: - What the instrumentation does (enriches log records with trace context) - Which attributes are injected (otelTraceID, otelSpanID, etc.) - Configuration via environment variables - The log_hook callback mechanism - Usage examples for both inject_trace_context and set_logging_format Assisted-by: Claude Opus 4.6
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
1 participant
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.
Description
Expands the logging instrumentation README to document what the instrumentation actually does — enriching log records with trace context for log correlation.
Fixes #2642
Type of change
What's documented
otelTraceID,otelSpanID,otelTraceSampled,otelServiceNameinject_trace_context=True(attributes only) andset_logging_format=True(attributes + format)log_hookcallback mechanism with exampleHow Has This Been Tested?
Documentation-only change. Verified RST structure is consistent with other instrumentation READMEs in the repo.
Does This PR Require a Core Repo Change?
Assisted-by: Claude Opus 4.6