Skip to content

aws-xray-propagator: ensure trace state is not overwritten #3774

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

aws-xray-propagator: ensure trace state is not overwritten #3774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 propagator/opentelemetry-propagator-aws-xray/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Update `opentelemetry-api` version to 1.16
([#2961](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2961))
- aws-xray-propagator: ensure trace state is not overwritten
([#3774](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3774))

## Version 1.0.2 (2024-08-05)

Expand Down
7 changes: 6 additions & 1 deletion ...pentelemetry-propagator-aws-xray/src/opentelemetry/propagators/aws/aws_xray_propagator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,17 @@ def extract(
if sampled:
options |= trace.TraceFlags.SAMPLED

try:
tracestate = trace.get_current_span(context=context).get_span_context().trace_state
except AttributeError:
tracestate = trace.TraceState()
Comment on lines +147 to +150
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of letting this code trigger AttributeError, can you check if trace.get_current_span(context=context) and trace.get_current_span(context=context).get_span_context() and trace.get_current_span(context=context).get_span_context().trace_state are not none to set trace_state?


span_context = trace.SpanContext(
trace_id=trace_id,
span_id=span_id,
is_remote=True,
trace_flags=trace.TraceFlags(options),
trace_state=trace.TraceState(),
trace_state=tracestate,
)

if not span_context.is_valid:
Expand Down
39 changes: 39 additions & 0 deletions propagator/opentelemetry-propagator-aws-xray/tests/test_aws_xray_propagator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,3 +335,42 @@ def test_fields(self, mock_trace):
self.assertEqual(
AwsXRayPropagatorTest.XRAY_PROPAGATOR.fields, inject_fields
)

def test_extract_trace_state_from_context(self):
"""Test that extract properly propagates the trace state extracted by other propagators."""
context_with_extracted = AwsXRayPropagatorTest.XRAY_PROPAGATOR.extract(
CaseInsensitiveDict(
{
TRACE_HEADER_KEY: "Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=0",
}
),
context=set_span_in_context(
trace_api.NonRecordingSpan(
SpanContext(
int(TRACE_ID_BASE16, 16),
int(SPAN_ID_BASE16, 16),
True,
DEFAULT_TRACE_OPTIONS,
TraceState([("foo", "bar"), ("baz", "qux")])
)
)
)
)

extracted_span_context = get_nested_span_context(context_with_extracted)
expected_trace_state = TraceState([("foo", "bar"), ("baz", "qux")])

self.assertEqual(extracted_span_context.trace_state, expected_trace_state)

def test_extract_no_trace_state_from_context(self):
"""Test that extract defaults to an empty trace state correctly."""
context_with_extracted = AwsXRayPropagatorTest.XRAY_PROPAGATOR.extract(
CaseInsensitiveDict(
{
TRACE_HEADER_KEY: "Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=0",
}
)
)

extracted_span_context = get_nested_span_context(context_with_extracted)
self.assertEqual(extracted_span_context.trace_state, TraceState([]))