Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jun 26, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e08f29e
sdk: use context instead of trace_id,span_id for initializing LogRecord
emdneto Jun 23, 2025
b2e0132
fix assert
emdneto Jun 23, 2025
04613fe
add changelog
emdneto Jun 23, 2025
f6bc290
leave the warning as before
emdneto Jun 24, 2025
1deeb38
Merge branch 'main' into fix-logs-warning
lzchen Jun 25, 2025
d569353
Merge branch 'main' into fix-logs-warning
xrmx Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#4637](https://github.com/open-telemetry/opentelemetry-python/pull/4637))
- Logging API accepts optional `context`; deprecates `trace_id`, `span_id`, `trace_flags`.
([#4597](https://github.com/open-telemetry/opentelemetry-python/pull/4597))
- sdk: use context instead of trace_id,span_id for initializing LogRecord
([#4653](https://github.com/open-telemetry/opentelemetry-python/pull/4653))
- Rename LogRecordProcessor.emit to on_emit
([#4648](https://github.com/open-telemetry/opentelemetry-python/pull/4648))
- Logging API hide std_to_otel function to convert python logging severity to otel severity
Expand Down
130 changes: 98 additions & 32 deletions exporter/opentelemetry-exporter-otlp-proto-common/tests/test_log_encoder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,12 @@
from opentelemetry.sdk._logs import LogRecord as SDKLogRecord
from opentelemetry.sdk.resources import Resource as SDKResource
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.trace import TraceFlags
from opentelemetry.trace import (
NonRecordingSpan,
SpanContext,
TraceFlags,
set_span_in_context,
)


class TestOTLPLogEncoder(unittest.TestCase):
Expand Down Expand Up @@ -84,13 +89,21 @@ def test_dropped_attributes_count(self):

@staticmethod
def _get_sdk_log_data() -> List[LogData]:
ctx_log1 = set_span_in_context(
NonRecordingSpan(
SpanContext(
89564621134313219400156819398935297684,
1312458408527513268,
False,
TraceFlags(0x01),
)
)
)
log1 = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786880,
observed_timestamp=1644650195189786881,
trace_id=89564621134313219400156819398935297684,
span_id=1312458408527513268,
trace_flags=TraceFlags(0x01),
context=ctx_log1,
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Do not go gentle into that good night. Rage, rage against the dying of the light",
Expand All @@ -109,9 +122,6 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650249738562048,
observed_timestamp=1644650249738562049,
trace_id=0,
span_id=0,
trace_flags=TraceFlags.DEFAULT,
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Cooper, this is no time for caution!",
Expand All @@ -123,13 +133,21 @@ def _get_sdk_log_data() -> List[LogData]:
),
)

ctx_log3 = set_span_in_context(
NonRecordingSpan(
SpanContext(
271615924622795969659406376515024083555,
4242561578944770265,
False,
TraceFlags(0x01),
)
)
)
log3 = LogData(
log_record=SDKLogRecord(
timestamp=1644650427658989056,
observed_timestamp=1644650427658989057,
trace_id=271615924622795969659406376515024083555,
span_id=4242561578944770265,
trace_flags=TraceFlags(0x01),
context=ctx_log3,
severity_text="DEBUG",
severity_number=SeverityNumber.DEBUG,
body="To our galaxy",
Expand All @@ -139,13 +157,21 @@ def _get_sdk_log_data() -> List[LogData]:
instrumentation_scope=None,
)

ctx_log4 = set_span_in_context(
NonRecordingSpan(
SpanContext(
212592107417388365804938480559624925555,
6077757853989569223,
False,
TraceFlags(0x01),
)
)
)
log4 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683008,
observed_timestamp=1644650584292683009,
trace_id=212592107417388365804938480559624925555,
span_id=6077757853989569223,
trace_flags=TraceFlags(0x01),
context=ctx_log4,
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body="Love is the one thing that transcends time and space",
Expand All @@ -160,13 +186,21 @@ def _get_sdk_log_data() -> List[LogData]:
),
)

ctx_log5 = set_span_in_context(
NonRecordingSpan(
SpanContext(
212592107417388365804938480559624925555,
6077757853989569445,
False,
TraceFlags(0x01),
)
)
)
log5 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683009,
observed_timestamp=1644650584292683010,
trace_id=212592107417388365804938480559624925555,
span_id=6077757853989569445,
trace_flags=TraceFlags(0x01),
context=ctx_log5,
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body={"error": None, "array_with_nones": [1, None, 2]},
Expand All @@ -178,13 +212,21 @@ def _get_sdk_log_data() -> List[LogData]:
),
)

ctx_log6 = set_span_in_context(
NonRecordingSpan(
SpanContext(
212592107417388365804938480559624925522,
6077757853989569222,
False,
TraceFlags(0x01),
)
)
)
log6 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683022,
observed_timestamp=1644650584292683022,
trace_id=212592107417388365804938480559624925522,
span_id=6077757853989569222,
trace_flags=TraceFlags(0x01),
context=ctx_log6,
severity_text="ERROR",
severity_number=SeverityNumber.ERROR,
body="This instrumentation scope has a schema url",
Expand All @@ -201,13 +243,21 @@ def _get_sdk_log_data() -> List[LogData]:
),
)

ctx_log7 = set_span_in_context(
NonRecordingSpan(
SpanContext(
212592107417388365804938480559624925533,
6077757853989569233,
False,
TraceFlags(0x01),
)
)
)
log7 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683033,
observed_timestamp=1644650584292683033,
trace_id=212592107417388365804938480559624925533,
span_id=6077757853989569233,
trace_flags=TraceFlags(0x01),
context=ctx_log7,
severity_text="FATAL",
severity_number=SeverityNumber.FATAL,
body="This instrumentation scope has a schema url and attributes",
Expand All @@ -225,13 +275,21 @@ def _get_sdk_log_data() -> List[LogData]:
),
)

ctx_log8 = set_span_in_context(
NonRecordingSpan(
SpanContext(
212592107417388365804938480559624925566,
6077757853989569466,
False,
TraceFlags(0x01),
)
)
)
log8 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683044,
observed_timestamp=1644650584292683044,
trace_id=212592107417388365804938480559624925566,
span_id=6077757853989569466,
trace_flags=TraceFlags(0x01),
context=ctx_log8,
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body="Test export of extended attributes",
Expand Down Expand Up @@ -544,12 +602,20 @@ def get_test_logs(

@staticmethod
def _get_test_logs_dropped_attributes() -> List[LogData]:
ctx_log1 = set_span_in_context(
NonRecordingSpan(
SpanContext(
89564621134313219400156819398935297684,
1312458408527513268,
False,
TraceFlags(0x01),
)
)
)
log1 = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786880,
trace_id=89564621134313219400156819398935297684,
span_id=1312458408527513268,
trace_flags=TraceFlags(0x01),
context=ctx_log1,
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Do not go gentle into that good night. Rage, rage against the dying of the light",
Expand All @@ -561,13 +627,13 @@ def _get_test_logs_dropped_attributes() -> List[LogData]:
"first_name", "first_version"
),
)

ctx_log2 = set_span_in_context(
NonRecordingSpan(SpanContext(0, 0, False))
)
log2 = LogData(
log_record=SDKLogRecord(
timestamp=1644650249738562048,
trace_id=0,
span_id=0,
trace_flags=TraceFlags.DEFAULT,
context=ctx_log2,
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Cooper, this is no time for caution!",
Expand Down
72 changes: 56 additions & 16 deletions exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,33 @@
)
from opentelemetry.sdk.resources import Resource as SDKResource
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.trace import TraceFlags
from opentelemetry.trace import (
NonRecordingSpan,
SpanContext,
TraceFlags,
set_span_in_context,
)

THIS_DIR = dirname(__file__)


class TestOTLPLogExporter(TestCase):
def setUp(self):
self.exporter = OTLPLogExporter()
ctx_log_data_1 = set_span_in_context(
NonRecordingSpan(
SpanContext(
2604504634922341076776623263868986797,
5213367945872657620,
False,
TraceFlags(0x01),
)
)
)
self.log_data_1 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986797,
span_id=5213367945872657620,
trace_flags=TraceFlags(0x01),
context=ctx_log_data_1,
severity_text="WARNING",
severity_number=SeverityNumber.WARN,
body="Zhengzhou, We have a heaviest rains in 1000 years",
Expand All @@ -75,12 +88,20 @@ def setUp(self):
"first_name", "first_version"
),
)
ctx_log_data_2 = set_span_in_context(
NonRecordingSpan(
SpanContext(
2604504634922341076776623263868986799,
5213367945872657623,
False,
TraceFlags(0x01),
)
)
)
self.log_data_2 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986799,
span_id=5213367945872657623,
trace_flags=TraceFlags(0x01),
context=ctx_log_data_2,
severity_text="INFO",
severity_number=SeverityNumber.INFO2,
body="Sydney, Opera House is closed",
Expand All @@ -91,12 +112,20 @@ def setUp(self):
"second_name", "second_version"
),
)
ctx_log_data_3 = set_span_in_context(
NonRecordingSpan(
SpanContext(
2604504634922341076776623263868986800,
5213367945872657628,
False,
TraceFlags(0x01),
)
)
)
self.log_data_3 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986800,
span_id=5213367945872657628,
trace_flags=TraceFlags(0x01),
context=ctx_log_data_3,
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Mumbai, Boil water before drinking",
Expand All @@ -106,12 +135,15 @@ def setUp(self):
"third_name", "third_version"
),
)
ctx_log_data_4 = set_span_in_context(
NonRecordingSpan(
SpanContext(0, 5213367945872657629, False, TraceFlags(0x01))
)
)
self.log_data_4 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=0,
span_id=5213367945872657629,
trace_flags=TraceFlags(0x01),
context=ctx_log_data_4,
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Invalid trace id check",
Expand All @@ -121,12 +153,20 @@ def setUp(self):
"fourth_name", "fourth_version"
),
)
ctx_log_data_5 = set_span_in_context(
NonRecordingSpan(
SpanContext(
2604504634922341076776623263868986801,
0,
False,
TraceFlags(0x01),
)
)
)
self.log_data_5 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986801,
span_id=0,
trace_flags=TraceFlags(0x01),
context=ctx_log_data_5,
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Invalid span id check",
Expand Down
Loading