8000 Logging API accepts optional Context with priority over trace_id etc, and LoggingHandler passes current Context by tammy-baylis-swi · Pull Request #4597 · open-telemetry/opentelemetry-python · GitHub
[go: up one dir, main page]

Skip to content

Logging API accepts optional Context with priority over trace_id etc, and LoggingHandler passes current Context #4597

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 19 commits into
base: main
Choose a base branch
from

Conversation

tammy-baylis-swi
Copy link
Contributor
@tammy-baylis-swi tammy-baylis-swi commented May 22, 2025

Description

  1. Updates Logging API and SDK to accept an additional, optional otel Context at LogRecord init.
  2. Adds order-of-precedence so that, if provided Context includes a valid current span, its span information will be used instead of any trace_id, span_id, trace_flags provided at init.
  3. LogRecord's to_json does a serialization of what it can in Context (e.g. string, int) then casts to string for other values (e.g. Span). Removed in 73e7b39 as discussed with Python SIG.
  4. LoggingHandler's _translate inits LogRecord with current context. Logging SDK (LogRecord init) defaults to current context in 676d9ff, as discussed with Python SIG.

Let me know if too many changes for one PR and I can break it up or remove anything out of scope.

Fixes #4328

Replaces #4584

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Added unit test coverage
  • Installed SDK changes into my vendor's distro and logs export ok

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@tammy-baylis-swi tammy-baylis-swi changed the title Logs API/SDK accepts additional, optional Context Logging API accepts optional Context with priority over trace_id etc, and LoggingHandler passes current Context May 24, 2025
): ...

@overload
@deprecated(
Copy link
Member
@aabmass aabmass Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I think we want to make the same change in the API LogRecord

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you're right. Updated in 172f1c5 but pyright typecheck fails. Will have a look

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed the typecheck fail by forcing kwargs-only init of LogRecord (API) in 84c6b33 -- what do we think? Is this breaking?

The code that does init of LogRecord is SDK's LoggingHandler._translate and Event SDK, which use kwargs. Grep of LogRecord suggests the other inits are in the unit tests, and all tests pass.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also installed this change into my vendor's setup and Log signals are still exporting.

Comment on lines 304 to 311
mock_context = Context() # no span in context

tracer = trace.TracerProvider().get_tracer(__name__)
< 8000 /td> with tracer.start_as_current_span("test") as span:
with patch(
"opentelemetry.sdk._logs._internal.get_current",
return_value=mock_context,
):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the mocking shouldn't be necessary since we are using the real context with start_as_current_span()

Suggested change
mock_context = Context() # no span in context
tracer = trace.TracerProvider().get_tracer(__name__)
with tracer.start_as_current_span("test") as span:
with patch(
"opentelemetry.sdk._logs._internal.get_current",
return_value=mock_context,
):
tracer = trace.TracerProvider().get_tracer(__name__)
with tracer.start_as_current_span("test") as span:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Updated in 172f1c5 and still passes.

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.

Event API should accept Context instead of specific trace_id, span_id, trace_flags
3 participants
0