Skip to content

[WIP/Draft] Change Logs API (and Events API) to accept whole SpanContext #4584

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

Closed
wants to merge 4 commits into from
Closed

[WIP/Draft] Change Logs API (and Events API) to accept whole SpanContext #4584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f30c75
Logs API accepts whole context
tammy-baylis-swi May 15, 2025
aaea217
Changelog
tammy-baylis-swi May 15, 2025
4ae3e2c
Merge branch 'main' into logs-api-accept-whole-context
tammy-baylis-swi May 21, 2025
ea07244
Update exporter tests
tammy-baylis-swi May 21, 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
([#4593](https://github.com/open-telemetry/opentelemetry-python/pull/4593))
- opentelemetry-test-utils: assert explicit bucket boundaries in histogram metrics
([#4595](https://github.com/open-telemetry/opentelemetry-python/pull/4595))
- Logging API and Events API accept SpanContext instead of trace_id, span_id, trace_flags
([#4584](https://github.com/open-telemetry/opentelemetry-python/pull/4584))

## Version 1.33.0/0.54b0 (2025-05-09)

Expand Down
91 changes: 61 additions & 30 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 @@ -50,6 +50,7 @@
from opentelemetry.sdk.resources import Resource as SDKResource
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.trace import TraceFlags
from opentelemetry.trace.span import SpanContext


class TestOTLPLogEncoder(unittest.TestCase):
Expand Down Expand Up @@ -88,9 +89,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650195189786880,
observed_timestamp=1644650195189786881,
trace_id=89564621134313219400156819398935297684,
span_id=1312458408527513268,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
89564621134313219400156819398935297684,
1312458408527513268,
True,
TraceFlags(0x01),
),
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 +113,12 @@ 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,
span_context=SpanContext(
0,
0,
True,
TraceFlags.DEFAULT,
),
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Cooper, this is no time for caution!",
Expand All @@ -127,9 +134,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650427658989056,
observed_timestamp=1644650427658989057,
trace_id=271615924622795969659406376515024083555,
span_id=4242561578944770265,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
271615924622795969659406376515024083555,
4242561578944770265,
True,
TraceFlags(0x01),
),
severity_text="DEBUG",
severity_number=SeverityNumber.DEBUG,
body="To our galaxy",
Expand All @@ -143,9 +153,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650584292683008,
observed_timestamp=1644650584292683009,
trace_id=212592107417388365804938480559624925555,
span_id=6077757853989569223,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925555,
6077757853989569223,
True,
TraceFlags(0x01),
),
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body="Love is the one thing that transcends time and space",
Expand All @@ -164,9 +177,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650584292683009,
observed_timestamp=1644650584292683010,
trace_id=212592107417388365804938480559624925555,
span_id=6077757853989569445,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925555,
6077757853989569445,
True,
TraceFlags(0x01),
),
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body={"error": None, "array_with_nones": [1, None, 2]},
Expand All @@ -182,9 +198,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650584292683022,
observed_timestamp=1644650584292683022,
trace_id=212592107417388365804938480559624925522,
span_id=6077757853989569222,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925522,
6077757853989569222,
True,
TraceFlags(0x01),
),
severity_text="ERROR",
severity_number=SeverityNumber.ERROR,
body="This instrumentation scope has a schema url",
Expand All @@ -205,9 +224,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650584292683033,
observed_timestamp=1644650584292683033,
trace_id=212592107417388365804938480559624925533,
span_id=6077757853989569233,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925533,
6077757853989569233,
True,
TraceFlags(0x01),
),
severity_text="FATAL",
severity_number=SeverityNumber.FATAL,
body="This instrumentation scope has a schema url and attributes",
Expand All @@ -229,9 +251,12 @@ def _get_sdk_log_data() -> List[LogData]:
log_record=SDKLogRecord(
timestamp=1644650584292683044,
observed_timestamp=1644650584292683044,
trace_id=212592107417388365804938480559624925566,
span_id=6077757853989569466,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925566,
6077757853989569466,
True,
TraceFlags(0x01),
),
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body="Test export of extended attributes",
Expand Down Expand Up @@ -547,9 +572,12 @@ def _get_test_logs_dropped_attributes() -> List[LogData]:
log1 = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786880,
trace_id=89564621134313219400156819398935297684,
span_id=1312458408527513268,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
89564621134313219400156819398935297684,
1312458408527513268,
True,
TraceFlags(0x01),
),
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 @@ -565,9 +593,12 @@ def _get_test_logs_dropped_attributes() -> List[LogData]:
log2 = LogData(
log_record=SDKLogRecord(
timestamp=1644650249738562048,
trace_id=0,
span_id=0,
trace_flags=TraceFlags.DEFAULT,
span_context=SpanContext(
0,
0,
True,
TraceFlags.DEFAULT,
),
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Cooper, this is no time for caution!",
Expand Down
46 changes: 31 additions & 15 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 @@ -52,6 +52,7 @@
from opentelemetry.sdk.resources import Resource as SDKResource
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.trace import TraceFlags
from opentelemetry.trace.span import SpanContext

THIS_DIR = dirname(__file__)

Expand All @@ -62,9 +63,12 @@ def setUp(self):
self.log_data_1 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986797,
span_id=5213367945872657620,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
2604504634922341076776623263868986797,
5213367945872657620,
True,
TraceFlags(0x01),
),
severity_text="WARNING",
severity_number=SeverityNumber.WARN,
body="Zhengzhou, We have a heaviest rains in 1000 years",
Expand All @@ -78,9 +82,12 @@ def setUp(self):
self.log_data_2 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986799,
span_id=5213367945872657623,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
2604504634922341076776623263868986799,
5213367945872657623,
True,
TraceFlags(0x01),
),
severity_text="INFO",
severity_number=SeverityNumber.INFO2,
body="Sydney, Opera House is closed",
Expand All @@ -94,9 +101,12 @@ def setUp(self):
self.log_data_3 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986800,
span_id=5213367945872657628,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
2604504634922341076776623263868986800,
5213367945872657628,
True,
TraceFlags(0x01),
),
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Mumbai, Boil water before drinking",
Expand All @@ -109,9 +119,12 @@ def setUp(self):
self.log_data_4 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=0,
span_id=5213367945872657629,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
0,
213367945872657629,
True,
TraceFlags(0x01),
),
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Invalid trace id check",
Expand All @@ -124,9 +137,12 @@ def setUp(self):
self.log_data_5 = LogData(
log_record=LogRecord(
timestamp=int(time.time() * 1e9),
trace_id=2604504634922341076776623263868986801,
span_id=0,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
2604504634922341076776623263868986801,
0,
True,
TraceFlags(0x01),
),
severity_text="ERROR",
severity_number=SeverityNumber.WARN,
body="Invalid span id check",
Expand Down
55 changes: 37 additions & 18 deletions exporter/opentelemetry-exporter-otlp-proto-http/tests/test_proto_log_exporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
from opentelemetry.sdk.resources import Resource as SDKResource
from opentelemetry.sdk.util.instrumentation import InstrumentationScope
from opentelemetry.trace import TraceFlags
from opentelemetry.trace.span import SpanContext

ENV_ENDPOINT = "http://localhost.env:8080/"
ENV_CERTIFICATE = "/etc/base.crt"
Expand Down Expand Up @@ -217,9 +218,12 @@ def test_exported_log_without_trace_id(self):
log = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786182,
trace_id=0,
span_id=1312458408527513292,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
0,
1312458408527513292,
True,
TraceFlags(0x01),
),
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Invalid trace id check",
Expand All @@ -244,9 +248,12 @@ def test_exported_log_without_span_id(self):
log = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786360,
trace_id=89564621134313219400156819398935297696,
span_id=0,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
89564621134313219400156819398935297696,
0,
True,
TraceFlags(0x01),
),
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Invalid span id check",
Expand Down Expand Up @@ -291,9 +298,12 @@ def _get_sdk_log_data() -> List[LogData]:
log1 = LogData(
log_record=SDKLogRecord(
timestamp=1644650195189786880,
trace_id=89564621134313219400156819398935297684,
span_id=1312458408527513268,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
89564621134313219400156819398935297684,
1312458408527513268,
True,
TraceFlags(0x01),
),
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 @@ -308,9 +318,12 @@ def _get_sdk_log_data() -> List[LogData]:
log2 = LogData(
log_record=SDKLogRecord(
timestamp=1644650249738562048,
trace_id=0,
span_id=0,
trace_flags=TraceFlags.DEFAULT,
span_context=SpanContext(
0,
0,
True,
TraceFlags.DEFAULT,
),
severity_text="WARN",
severity_number=SeverityNumber.WARN,
body="Cooper, this is no time for caution!",
Expand All @@ -325,9 +338,12 @@ def _get_sdk_log_data() -> List[LogData]:
log3 = LogData(
log_record=SDKLogRecord(
timestamp=1644650427658989056,
trace_id=271615924622795969659406376515024083555,
span_id=4242561578944770265,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
271615924622795969659406376515024083555,
4242561578944770265,
True,
TraceFlags(0x01),
),
severity_text="DEBUG",
severity_number=SeverityNumber.DEBUG,
body="To our galaxy",
Expand All @@ -340,9 +356,12 @@ def _get_sdk_log_data() -> List[LogData]:
log4 = LogData(
log_record=SDKLogRecord(
timestamp=1644650584292683008,
trace_id=212592107417388365804938480559624925555,
span_id=6077757853989569223,
trace_flags=TraceFlags(0x01),
span_context=SpanContext(
212592107417388365804938480559624925555,
6077757853989569223,
True,
TraceFlags(0x01),
),
severity_text="INFO",
severity_number=SeverityNumber.INFO,
body="Love is the one thing that transcends time and space",
Expand Down
10 changes: 3 additions & 7 deletions opentelemetry-api/src/opentelemetry/_events/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from opentelemetry.environment_variables import (
_OTEL_PYTHON_EVENT_LOGGER_PROVIDER,
)
from opentelemetry.trace.span import TraceFlags
from opentelemetry.trace.span import SpanContext
from opentelemetry.util._once import Once
from opentelemetry.util._providers import _load_provider
from opentelemetry.util.types import AnyValue, _ExtendedAttributes
Expand All @@ -35,9 +35,7 @@ def __init__(
self,
name: str,
timestamp: Optional[int] = None,
trace_id: Optional[int] = None,
span_id: Optional[int] = None,
trace_flags: Optional["TraceFlags"] = None,
span_context: Optional[SpanContext] = None,
body: Optional[AnyValue] = None,
severity_number: Optional[SeverityNumber] = None,
attributes: Optional[_ExtendedAttributes] = None,
Expand All @@ -49,9 +47,7 @@ def __init__(
}
super().__init__(
timestamp=timestamp,
trace_id=trace_id,
span_id=span_id,
trace_flags=trace_flags,
span_context=span_context,
body=body,
severity_number=severity_number,
attributes=event_attributes,
Expand Down
Loading
Loading