From 1a9ff12e1dabcb18dec47d1d506bd0bd71572aad Mon Sep 17 00:00:00 2001 From: Brett Langdon Date: Thu, 27 Jun 2019 08:16:20 -0400 Subject: [PATCH] [net/http] Use HTTPPropagator.inject! instead of req.add_field (#768) * [net/http] Use HTTPPropagator.inject! instead of req.add_field * ensure we are comparing strings to strings --- lib/ddtrace/contrib/http/instrumentation.rb | 9 +--- spec/ddtrace/contrib/http/request_spec.rb | 47 ++++++++++++++++++++- 2 files changed, 47 insertions(+), 9 deletions(-) diff --git a/lib/ddtrace/contrib/http/instrumentation.rb b/lib/ddtrace/contrib/http/instrumentation.rb index a8fc90b4811..52c194e2803 100644 --- a/lib/ddtrace/contrib/http/instrumentation.rb +++ b/lib/ddtrace/contrib/http/instrumentation.rb @@ -67,14 +67,7 @@ def request(req, body = nil, &block) # :yield: +response+ span.resource = req.method if pin.tracer.enabled && !Datadog::Contrib::HTTP.should_skip_distributed_tracing?(pin) - req.add_field(Datadog::Ext::DistributedTracing::HTTP_HEADER_TRACE_ID, span.trace_id) - req.add_field(Datadog::Ext::DistributedTracing::HTTP_HEADER_PARENT_ID, span.span_id) - if span.context.sampling_priority - req.add_field( - Datadog::Ext::DistributedTracing::HTTP_HEADER_SAMPLING_PRIORITY, - span.context.sampling_priority - ) - end + Datadog::HTTPPropagator.inject!(span.context, req) end rescue StandardError => e Datadog::Tracer.log.error("error preparing span for http request: #{e}") diff --git a/spec/ddtrace/contrib/http/request_spec.rb b/spec/ddtrace/contrib/http/request_spec.rb index 10338896c74..f622824e70c 100644 --- a/spec/ddtrace/contrib/http/request_spec.rb +++ b/spec/ddtrace/contrib/http/request_spec.rb @@ -250,7 +250,52 @@ def expect_request_without_distributed_headers if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0') expect(WebMock).to(have_requested(:get, "#{uri}#{path}").with { |req| distributed_tracing_headers.all? do |(header, value)| - req.headers[header.split('-').map(&:capitalize).join('-')] == value + req.headers[header.split('-').map(&:capitalize).join('-')] == value.to_s + end + }) + else + expect(WebMock).to have_requested(:get, "#{uri}#{path}").with(headers: distributed_tracing_headers) + end + end + end + + # This can happen if another http client uses net/http (e.g. restclient) + # The goal here is to ensure we do not add multiple values for a given header + context 'with existing distributed tracing headers' do + before(:each) do + tracer.configure(enabled: true) + tracer.trace('foo.bar') do |span| + span.context.sampling_priority = sampling_priority + + req = Net::HTTP::Get.new(path) + req[Datadog::Ext::DistributedTracing::HTTP_HEADER_PARENT_ID] = 100 + req[Datadog::Ext::DistributedTracing::HTTP_HEADER_TRACE_ID] = 100 + req[Datadog::Ext::DistributedTracing::HTTP_HEADER_SAMPLING_PRIORITY] = 0 + + Net::HTTP.start(host, port) do |http| + http.request(req) + end + end + end + + let(:sampling_priority) { 10 } + let(:distributed_tracing_headers) do + { + Datadog::Ext::DistributedTracing::HTTP_HEADER_PARENT_ID => span.span_id, + Datadog::Ext::DistributedTracing::HTTP_HEADER_TRACE_ID => span.trace_id, + Datadog::Ext::DistributedTracing::HTTP_HEADER_SAMPLING_PRIORITY => sampling_priority + } + end + + let(:span) { spans.last } + + it 'adds distributed tracing headers' do + # The block syntax only works with Ruby < 2.3 and the hash syntax + # only works with Ruby >= 2.3, so we need to support both. + if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3.0') + expect(WebMock).to(have_requested(:get, "#{uri}#{path}").with { |req| + distributed_tracing_headers.all? do |(header, value)| + req.headers[header.split('-').map(&:capitalize).join('-')] == value.to_s end }) else