Skip to content
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

feat: remove tracestate, add lineage support to X-Ray propagator #1380

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat: remove tracestate, add lineage support to X-Ray propagator #1380

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
3ca9678
remove trace state propagation and add lineage validation
ezhang6811 Jan 28, 2025
f2731ac
add lineage injection to trace header
ezhang6811 Jan 28, 2025
328f1f1
add unit tests
ezhang6811 Jan 29, 2025
f2731f2
change lineage variable names
ezhang6811 Jan 30, 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
27 changes: 22 additions & 5 deletions propagator/xray/lib/opentelemetry/propagator/xray/text_map_propagator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ module XRay
# Propagates context in carriers in the xray single header format
class TextMapPropagator
XRAY_CONTEXT_KEY = 'X-Amzn-Trace-Id'
XRAY_CONTEXT_REGEX = /\ARoot=(?<trace_id>([a-z0-9\-]{35}))(?:;Parent=(?<span_id>([a-z0-9]{16})))?(?:;Sampled=(?<sampling_state>[01d](?![0-9a-f])))?(?:;(?<trace_state>.*))?\Z/ # rubocop:disable Lint/MixedRegexpCaptureTypes
XRAY_CONTEXT_REGEX = /\A(?:(?:Root=(?<trace_id>[a-z0-9\-]{35})|Parent=(?<span_id>[a-z0-9]{16})|Sampled=(?<sampling_state>[01d](?![0-9a-f]))|Lineage=(?<lineage>[^;]+))(?:;|$)){1,4}\Z/ # rubocop:disable Lint/MixedRegexpCaptureTypes
SAMPLED_VALUES = %w[1 d].freeze
FIELDS = [XRAY_CONTEXT_KEY].freeze

Expand Down Expand Up @@ -47,12 +47,14 @@ def extract(carrier, context: Context.current, getter: Context::Propagation.text
trace_id: to_trace_id(match['trace_id']),
span_id: to_span_id(match['span_id']),
trace_flags: to_trace_flags(match['sampling_state']),
tracestate: to_trace_state(match['trace_state']),
remote: true
)

span = OpenTelemetry::Trace.non_recording_span(span_context)
context = XRay.context_with_debug(context) if match['sampling_state'] == 'd'
if match['lineage'] && is_valid_lineage?(match['lineage'])
context = OpenTelemetry::Baggage.set_value('Lineage', match['lineage'])
end
Trace.context_with_span(span, parent_context: context)
rescue OpenTelemetry::Error
context
Expand Down Expand Up @@ -83,6 +85,12 @@ def inject(carrier, context: Context.current, setter: Context::Propagation.text_

xray_value = "Root=#{xray_trace_id};Parent=#{parent_id};Sampled=#{sampling_state}"

# Add lineage to xray_value if present in baggage
baggage = OpenTelemetry::Baggage.values(context: context)
if baggage.key?('Lineage')
xray_value += ";Lineage=#{baggage['Lineage']}"
end

setter.set(carrier, XRAY_CONTEXT_KEY, xray_value)
nil
end
Expand Down Expand Up @@ -116,10 +124,19 @@ def to_trace_flags(sampling_state)
end
end

def to_trace_state(trace_state)
return nil unless trace_state
def is_valid_lineage?(lineage)
lineageSubstrings = lineage.split(':')
return false unless lineageSubstrings.length == 3

lineageCounter1 = lineageSubstrings[0].to_i
hashedString = lineageSubstrings[1]
lineageCounter2 = lineageSubstrings[2].to_i

Trace::Tracestate.from_string(trace_state.tr(';', ','))
hashedString.match?(/\A[a-zA-Z0-9]{8}\z/) &&
lineageCounter1 >= 0 &&
lineageCounter1 <= 32767 &&
lineageCounter2 >= 0 &&
lineageCounter2 <= 255
end
end
end
Expand Down
58 changes: 47 additions & 11 deletions propagator/xray/test/text_map_propagator_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,42 @@
let(:propagator) { OpenTelemetry::Propagator::XRay::TextMapPropagator.new }

describe('#extract') do
it 'extracts context with trace id, span id, sampling flag, trace state' do
it 'extracts context with trace id, span id, sampling flag' do
parent_context = OpenTelemetry::Context.empty
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=1;Foo=Bar;Fizz=Buzz' }
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=1' }

context = propagator.extract(carrier, context: parent_context)
extracted_context = OpenTelemetry::Trace.current_span(context).context

_(extracted_context.hex_trace_id).must_equal('80f198eae56343ba864fe8b2a57d3eff')
_(extracted_context.hex_span_id).must_equal('e457b5a2e4d86bd1')
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED)
_(extracted_context.tracestate.to_s).must_equal(OpenTelemetry::Trace::Tracestate.from_string('Foo=Bar,Fizz=Buzz').to_s)
_(extracted_context).must_be(:remote?)
end

it 'extracts context with trace id, span id, sampling flag' do
it 'extracts context with trace id, span id' do
parent_context = OpenTelemetry::Context.empty
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=1' }
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1' }

context = propagator.extract(carrier, context: parent_context)
extracted_context = OpenTelemetry::Trace.current_span(context).context

_(extracted_context.hex_trace_id).must_equal('80f198eae56343ba864fe8b2a57d3eff')
_(extracted_context.hex_span_id).must_equal('e457b5a2e4d86bd1')
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED)
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::DEFAULT)
_(extracted_context).must_be(:remote?)
end

it 'extracts context with trace id, span id' do
it 'extracts context with lineage in header' do
parent_context = OpenTelemetry::Context.empty
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1' }
carrier = { 'X-Amzn-Trace-Id' => 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=1;Lineage=100:e3b0c442:11' }

context = propagator.extract(carrier, context: parent_context)
extracted_context = OpenTelemetry::Trace.current_span(context).context

_(extracted_context.hex_trace_id).must_equal('80f198eae56343ba864fe8b2a57d3eff')
_(extracted_context.hex_span_id).must_equal('e457b5a2e4d86bd1')
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::DEFAULT)
_(extracted_context).must_be(:remote?)
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED)
_(OpenTelemetry::Baggage.value('Lineage', context: context)).must_equal('100:e3b0c442:11')
end

it 'converts debug flag to sampled' do
Expand Down Expand Up @@ -89,6 +87,29 @@

_(context).must_equal(parent_context)
end
it 'handles invalid lineage' do
invalid_lineages = [
"",
"::",
"1::",
"1::1",
"1:badc0de:13",
":fbadc0de:13",
"65535:fbadc0de:255",
]

invalid_lineages.each do |lineage|
parent_context = OpenTelemetry::Context.empty
carrier = { 'X-Amzn-Trace-Id' => "Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=1;Lineage=65535:fbadc0de:255" }

context = propagator.extract(carrier, context: parent_context)
extracted_context = OpenTelemetry::Trace.current_span(context).context
_(extracted_context.hex_trace_id).must_equal('80f198eae56343ba864fe8b2a57d3eff')
_(extracted_context.hex_span_id).must_equal('e457b5a2e4d86bd1')
_(extracted_context.trace_flags).must_equal(OpenTelemetry::Trace::TraceFlags::SAMPLED)
_(OpenTelemetry::Baggage.value('Lineage', context: context)).must_be_nil
end
end
end

describe '#inject' do
Expand Down Expand Up @@ -134,6 +155,21 @@
_(carrier['X-Amzn-Trace-Id']).must_equal(expected_xray)
end

it 'injects lineage from baggage' do
context = create_context(
trace_id: '80f198eae56343ba864fe8b2a57d3eff',
span_id: 'e457b5a2e4d86bd1',
trace_flags: TraceFlags::DEFAULT
)
context = OpenTelemetry::Baggage.set_value('Lineage', '100:e3b0c442:11', context: context)

carrier = {}
propagator.inject(carrier, context: context)

expected_xray = 'Root=1-80f198ea-e56343ba864fe8b2a57d3eff;Parent=e457b5a2e4d86bd1;Sampled=0;Lineage=100:e3b0c442:11'
_(carrier['X-Amzn-Trace-Id']).must_equal(expected_xray)
end

it 'no-ops if trace id invalid' do
context = create_context(
trace_id: '0' * 32,
Expand Down