Logging API accepts optional Context at LogRecord init else get_current; deprecates trace_id, span_id, trace_flags by tammy-baylis-swi · Pull Request #4597 · open-telemetry/opentelemetry-python

tammy-baylis-swi · 2025-05-22T19:34:36Z

Description

Updates Logging API and SDK to accept an additional, optional otel Context at LogRecord init. If not provided, current context is used.
~~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.~~ Deprecates old LogRecord init and logs a warning (eb28a8d)
~~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.
~~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

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

opentelemetry-sdk/tests/logs/test_handler.py

…e_id etc

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

opentelemetry-sdk/tests/logs/test_handler.py

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py

tammy-baylis-swi · 2025-06-11T17:29:57Z

Not sure why CI is failing; tox -e py313-test-opentelemetry-sdk is ok on my local

EDIT: The custom warning introduced in eb28a8d made tests fail, which I adjusted in 52a5e93

opentelemetry-api/src/opentelemetry/_logs/_internal/__init__.py

emdneto · 2025-06-12T00:43:48Z

Not sure why CI is failing; tox -e py313-test-opentelemetry-sdk is ok on my local

EDIT: The custom warning introduced in eb28a8d made tests fail, which I adjusted in 52a5e93

Facing the same issue in another PR

tammy-baylis-swi · 2025-06-12T15:23:23Z

Facing the same issue in another PR

Ah and this new issue: #4630

Wdyt, shoud I revert 52a5e93 on this one?

CHANGELOG.md

opentelemetry-api/src/opentelemetry/_logs/_internal/__init__.py

opentelemetry-sdk/tests/logs/test_export.py

…nt; deprecates trace_id, span_id, trace_flags (open-telemetry#4597) * Logs API/SDK accepts additional otel context * Changelog * LoggingHandler translates to LogRecord with current Otel context * Add LogRecord init priority for context's span over old span info * Add LogRecord serialized_context for to_json of arbitrary objects * Add test coverage * Changelog * lint * Fix tests * Changelog * Rm Context inclusion from to_json of LogRecord * Revision: logs SDK does get_current, overload init and deprecate trace_id etc * Simplify test * Changelog * Use typing_extensions deprecated, not custom * Update LogRecord API; simplify test * Force logrecord api kwarg-only to avoid param order issues * Add special LogDeprecatedInitWarning that logs once * Rm deprecated decorator * api too * catch_warnings instead of assertLogs in test * changelog * Rm with assertLogs for py3.13 ubuntu test --------- Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com>

tammy-baylis-swi added 9 commits May 22, 2025 12:33

Logs API/SDK accepts additional otel context

816ce49

Changelog

4783932

LoggingHandler translates to LogRecord with current Otel context

5308eee

Add LogRecord init priority for context's span over old span info

a45694c

Add LogRecord serialized_context for to_json of arbitrary objects

f8c56d3

Add test coverage

fa5ec39

Changelog

56172fa

lint

4b38118

Fix tests

ded31f6

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

Changelog

bce5a7e

tammy-baylis-swi mentioned this pull request May 24, 2025

Logging API should accept Context instead of specific trace_id, span_id, trace_flags #4328

Closed

tammy-baylis-swi marked this pull request as ready for review May 24, 2025 00:49

tammy-baylis-swi requested a review from a team as a code owner May 24, 2025 00:49

tammy-baylis-swi moved this to Ready for review in Python PR digest May 24, 2025

tammy-baylis-swi added this to Python PR digest May 24, 2025

tammy-baylis-swi and others added 2 commits May 27, 2025 12:22

Merge branch 'main' into logs-api-accept-otel-context

9ff670e

Rm Context inclusion from to_json of LogRecord

73e7b39

aabmass reviewed May 29, 2025

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py Outdated Show resolved Hide resolved

opentelemetry-sdk/tests/logs/test_handler.py Outdated Show resolved Hide resolved

tammy-baylis-swi added 3 commits May 29, 2025 15:23

Revision: logs SDK does get_current, overload init and deprecate trac…

676d9ff

…e_id etc

Simplify test

a0c817c

Changelog

111d8d8

tammy-baylis-swi requested review from aabmass and emdneto May 29, 2025 22:39

Use typing_extensions deprecated, not custom

bb92b7e

aabmass approved these changes Jun 4, 2025

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py Outdated Show resolved Hide resolved

opentelemetry-sdk/tests/logs/test_handler.py Outdated Show resolved Hide resolved

emdneto and others added 3 commits June 4, 2025 15:37

Merge branch 'main' into logs-api-accept-otel-context

0aad430

Update LogRecord API; simplify test

172f1c5

Force logrecord api kwarg-only to avoid param order issues

84c6b33

aabmass approved these changes Jun 5, 2025

View reviewed changes

opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py Outdated Show resolved Hide resolved

tammy-baylis-swi requested a review from emdneto June 11, 2025 16:38

Rm deprecated decorator

04f5da7

tammy-baylis-swi changed the title ~~Logging API accepts optional Context with priority over trace_id etc, and LoggingHandler passes current Context~~ Logging API accepts optional Context at LogRecord init else get_current; deprecates trace_id, span_id, trace_flags Jun 11, 2025

tammy-baylis-swi added 2 commits June 11, 2025 12:31

api too

dca0d41

catch_warnings instead of assertLogs in test

52a5e93

emdneto reviewed Jun 12, 2025

View reviewed changes

opentelemetry-api/src/opentelemetry/_logs/_internal/__init__.py Show resolved Hide resolved

tammy-baylis-swi requested a review from emdneto June 12, 2025 15:23

xrmx reviewed Jun 13, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

opentelemetry-api/src/opentelemetry/_logs/_internal/__init__.py Show resolved Hide resolved

opentelemetry-sdk/tests/logs/test_export.py Outdated Show resolved Hide resolved

tammy-baylis-swi and others added 3 commits June 13, 2025 09:52

changelog

069c2f8

Rm with assertLogs for py3.13 ubuntu test

fa6111e

Merge branch 'main' into logs-api-accept-otel-context

f709952

tammy-baylis-swi requested a review from xrmx June 13, 2025 16:59

xrmx approved these changes Jun 16, 2025

View reviewed changes

emdneto approved these changes Jun 17, 2025

View reviewed changes

Merge branch 'main' into logs-api-accept-otel-context

87b300c

emdneto mentioned this pull request Jun 17, 2025

Fix flaking test #4640

Closed

4 tasks

xrmx merged commit 9a68c94 into open-telemetry:main Jun 17, 2025
353 checks passed

github-project-automation bot moved this from Ready for review to Done in Python PR digest Jun 17, 2025

This was referenced Jun 19, 2025

SimpleLogRecordProcessor shutdown test failure #4630

Closed

sdk: use context instead of trace_id,span_id for initializing LogRecord #4653

Merged

tammy-baylis-swi mentioned this pull request Jun 24, 2025

Add event_name as a top level field in the LogRecord. #4652

Merged

1 task

lzchen mentioned this pull request Jun 25, 2025

Mark events API/SDK as deprecated #4654

Merged

7 tasks

emdneto mentioned this pull request Jul 1, 2025

update: use context instead of trace_id, span_id, trace_flags at eventsAPI #4344

Closed

10 tasks

DylanRussell mentioned this pull request Jul 7, 2025

Update LogRecord API to set and make use of context to set trace id / span id / trace flags, #4668

Merged

2 tasks

medaminezghal mentioned this pull request Jul 17, 2025

LogDeprecatedInitWarning #4687

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logging API accepts optional Context at LogRecord init else get_current; deprecates trace_id, span_id, trace_flags#4597

Logging API accepts optional Context at LogRecord init else get_current; deprecates trace_id, span_id, trace_flags#4597
xrmx merged 28 commits intoopen-telemetry:mainfrom
tammy-baylis-swi:logs-api-accept-otel-context

tammy-baylis-swi commented May 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi commented Jun 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

emdneto commented Jun 12, 2025

Uh oh!

tammy-baylis-swi commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

tammy-baylis-swi commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tammy-baylis-swi commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

emdneto commented Jun 12, 2025

Uh oh!

tammy-baylis-swi commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tammy-baylis-swi commented May 22, 2025 •

edited

Loading

tammy-baylis-swi commented Jun 11, 2025 •

edited

Loading