instana 1.11.6 → 1.209.2

data/test/instrumentation/{net-http_test.rb → net_http_test.rb}

@@ -1,4 +1,8 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
+require 'support/apps/http_endpoint/boot'
 
 class NetHTTPTest < Minitest::Test
   def test_config_defaults
@@ -7,6 +11,42 @@ class NetHTTPTest < Minitest::Test
     assert_equal true, ::Instana.config[:nethttp][:enabled]
   end
 
+  def test_get_with_query
+    clear_all!
+    WebMock.allow_net_connect!
+
+    Instana.tracer.start_or_continue_trace(:"net-http-test") do
+      Net::HTTP.get(URI('http://127.0.0.1:6511/?query_value=true'))
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 3, spans.length
+
+    http_span = find_first_span_by_name(spans, :'net-http')
+    assert_equal "http://127.0.0.1:6511/", http_span[:data][:http][:url]
+    assert_equal "query_value=true", http_span[:data][:http][:params]
+
+    WebMock.disable_net_connect!
+  end
+
+  def test_get_without_query
+    clear_all!
+    WebMock.allow_net_connect!
+
+    Instana.tracer.start_or_continue_trace(:"net-http-test") do
+      Net::HTTP.get(URI('http://127.0.0.1:6511/'))
+    end
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 3, spans.length
+
+    http_span = find_first_span_by_name(spans, :'net-http')
+    assert_equal "http://127.0.0.1:6511/", http_span[:data][:http][:url]
+    assert_equal "200", http_span[:data][:http][:status]
+
+    WebMock.disable_net_connect!
+  end
+
   def test_block_request
     clear_all!
     WebMock.allow_net_connect!

data/test/instrumentation/rack_instrumented_request_test.rb

@@ -0,0 +1,151 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class RackInstrumentedRequestTest < Minitest::Test
+  def test_skip_trace_with_header
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '0;sample-data'
+    )
+
+    assert req.skip_trace?
+  end
+
+  def test_skip_trace_without_header
+    req = Instana::InstrumentedRequest.new({})
+
+    refute req.skip_trace?
+  end
+
+  def test_incoming_context
+    id = Instana::Util.generate_id
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1',
+      'HTTP_X_INSTANA_T' => id,
+      'HTTP_X_INSTANA_S' => id
+    )
+
+    expected = {
+      trace_id: id,
+      span_id: id,
+      from_w3: false,
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+    refute req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_w3_content
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1',
+      'HTTP_TRACEPARENT' => '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
+    )
+
+    expected = {
+      external_trace_id: '4bf92f3577b34da6a3ce929d0e0e4736',
+      external_state: nil,
+      trace_id: 'a3ce929d0e0e4736',
+      span_id: '00f067aa0ba902b7',
+      from_w3: true,
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+    assert req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_w3_content_invalid_id
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1',
+      'HTTP_TRACEPARENT' => '00-00000000000000000000000000000000-0000000000000000-01'
+    )
+
+    expected = {
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+    refute req.continuing_from_trace_parent?
+  end
+
+  def test_incoming_invalid_w3_content
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1',
+      'HTTP_TRACEPARENT' => '00-XXa3ce929d0e0e4736-00f67aa0ba902b7-01'
+    )
+
+    expected = {
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+  end
+
+  def test_incoming_w3_state
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_TRACESTATE' => 'a=12345,in=123;abe,c=[+]'
+    )
+
+    expected = {
+      t: '123',
+      p: 'abe'
+    }
+
+    assert_equal expected, req.instana_ancestor
+  end
+
+  def test_request_tags
+    ::Instana.agent.define_singleton_method(:extra_headers) { %w[X-Capture-This] }
+
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_HOST' => 'example.com',
+      'REQUEST_METHOD' => 'GET',
+      'HTTP_X_CAPTURE_THIS' => 'that',
+      'PATH_INFO' => '/',
+      'QUERY_STRING' => 'test=true'
+    )
+
+    expected = {
+      method: 'GET',
+      url: '/',
+      host: 'example.com',
+      header: {
+        "X-Capture-This": 'that'
+      },
+      params: 'test=true'
+    }
+
+    assert_equal expected, req.request_tags
+    ::Instana.agent.singleton_class.send(:remove_method, :extra_headers)
+  end
+
+  def test_correlation_data_valid
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1,correlationType=web ;correlationId=1234567890abcdef'
+    )
+    expected = {
+      type: 'web',
+      id: '1234567890abcdef'
+    }
+
+    assert_equal expected, req.correlation_data
+  end
+
+  def test_correlation_data_invalid
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '0;sample-data'
+    )
+
+    assert_equal({}, req.correlation_data)
+  end
+
+  def test_correlation_data_legacy
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_X_INSTANA_L' => '1'
+    )
+
+    assert_equal({}, req.correlation_data)
+  end
+end

data/test/instrumentation/rack_test.rb

@@ -0,0 +1,404 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
+require 'test_helper'
+require 'rack/test'
+require 'rack/lobster'
+
+class RackTest < Minitest::Test
+  include Rack::Test::Methods
+
+  class PathTemplateApp
+    def call(env)
+      env['INSTANA_HTTP_PATH_TEMPLATE'] = 'sample_template'
+      [200, {}, ['Ok']]
+    end
+  end
+
+  class ErrorApp
+    def call(_env)
+      raise 'An Error'
+    end
+  end
+
+  class FiveZeroOneApp
+    def call(_env)
+      [501, {}, ['No']]
+    end
+  end
+
+  class NoHeadersApp
+    def call(_env)
+      [501, nil, ['No']]
+    end
+  end
+
+  def app
+    @app = Rack::Builder.new do
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use Instana::Rack
+      map("/mrlobster") { run Rack::Lobster.new }
+      map("/path_tpl") { run PathTemplateApp.new }
+      map("/error") { run ErrorApp.new }
+      map("/five_zero_one") { run FiveZeroOneApp.new }
+    end
+  end
+
+  def test_basic_get
+    clear_all!
+    ::Instana.config[:collect_backtraces] = true
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    # W3 Trace Context
+    assert_equal "00-#{rack_span[:t].rjust(32, '0')}-#{rack_span[:s]}-01", last_response.headers["Traceparent"]
+    assert_equal "in=#{rack_span[:t]};#{rack_span[:s]}", last_response.headers["Tracestate"]
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "GET", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert_equal 'example.org', rack_span[:data][:http][:host]
+    assert rack_span.key?(:f)
+    assert !rack_span.key?(:stack)
+
+    # Restore to default
+    ::Instana.config[:collect_backtraces] = false
+  end
+
+  def test_basic_get_with_custom_service_name
+    ENV['INSTANA_SERVICE_NAME'] = 'WalterBishop'
+
+    clear_all!
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+
+    rack_span = spans.first
+    assert_equal 'WalterBishop', rack_span[:data][:service]
+
+    ENV.delete('INSTANA_SERVICE_NAME')
+  end
+
+  def test_basic_post
+    clear_all!
+    post '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "POST", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+  end
+
+  def test_basic_put
+    clear_all!
+    put '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "PUT", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+  end
+
+  def test_context_continuation
+    clear_all!
+    continuation_id = Instana::Util.generate_id
+    header 'X-INSTANA-T', continuation_id
+    header 'X-INSTANA-S', continuation_id
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert last_response.headers.key?("X-Instana-T")
+    assert last_response.headers["X-Instana-T"] == ::Instana::Util.id_to_header(rack_span[:t])
+    assert last_response.headers.key?("X-Instana-S")
+    assert last_response.headers["X-Instana-S"] == ::Instana::Util.id_to_header(rack_span[:s])
+    assert last_response.headers.key?("X-Instana-L")
+    assert last_response.headers["X-Instana-L"] == '1'
+    assert last_response.headers.key?("Server-Timing")
+    assert last_response.headers["Server-Timing"] == "intid;desc=#{::Instana::Util.id_to_header(rack_span[:t])}"
+
+    assert rack_span.key?(:data)
+    assert rack_span[:data].key?(:http)
+    assert_equal "GET", rack_span[:data][:http][:method]
+    assert_equal "/mrlobster", rack_span[:data][:http][:url]
+    assert_equal 200, rack_span[:data][:http][:status]
+    assert rack_span.key?(:f)
+
+    # Context validation
+    # The first span should have the passed in trace ID
+    # and specify the passed in span ID as it's parent.
+    assert_equal continuation_id, rack_span[:t]
+    assert_equal continuation_id, rack_span[:p]
+  end
+
+  def test_correlation_information
+    clear_all!
+
+    header 'X-INSTANA-L', '1,correlationType=test;correlationId=abcdefh123'
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+
+    assert_equal 'abcdefh123', rack_span[:crid]
+    assert_equal 'test', rack_span[:crtp]
+  end
+
+
+  def test_instana_response_headers
+    clear_all!
+    get '/mrlobster'
+    assert last_response.ok?
+
+    refute_nil last_response.headers.key?("X-Instana-T")
+    refute_nil last_response.headers.key?("X-Instana-S")
+  end
+
+  def test_that_url_params_not_logged
+    clear_all!
+    get '/mrlobster?blah=2&wilma=1&betty=2;fred=3'
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.length
+
+    refute_nil spans.first.key?(:data)
+    refute_nil spans.first[:data].key?(:http)
+    refute_nil spans.first[:data][:http].key?(:url)
+    assert_equal '/mrlobster', spans.first[:data][:http][:url]
+
+    assert last_response.ok?
+  end
+
+  def test_custom_headers_capture
+    clear_all!
+    ::Instana.config[:collect_backtraces] = true
+    ::Instana.agent.define_singleton_method(:extra_headers) { %w(X-Capture-This X-Capture-That) }
+
+    get '/mrlobster', {}, { "HTTP_X_CAPTURE_THIS" => "ThereYouGo" }
+    assert last_response.ok?
+    assert_equal "ThereYouGo", last_request.env["HTTP_X_CAPTURE_THIS"]
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    rack_span = spans.first
+
+    assert rack_span[:data][:http].key?(:header)
+    assert rack_span[:data][:http][:header].key?(:"X-Capture-This")
+    assert !rack_span[:data][:http][:header].key?(:"X-Capture-That")
+    assert_equal "ThereYouGo", rack_span[:data][:http][:header][:"X-Capture-This"]
+    assert !rack_span.key?(:stack)
+
+    # Restore to default
+    ::Instana.config[:collect_backtraces] = false
+    ::Instana.agent.singleton_class.send(:remove_method, :extra_headers)
+  end
+
+  def test_capture_http_path_template
+    clear_all!
+
+    get '/path_tpl'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.length
+
+    rack_span = spans.first
+    assert_equal :rack, rack_span[:n]
+    assert_equal 'sample_template', rack_span[:data][:http][:path_tpl]
+  end
+
+  def test_basic_get_with_x_instana_synthetic
+    header 'X-INSTANA-SYNTHETIC', '1'
+
+    clear_all!
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal true, first_span[:sy]
+  end
+
+  def test_basic_get_with_w3_trace
+    clear_all!
+
+    header 'TRACEPARENT', '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal 'a3ce929d0e0e4736', first_span[:t]
+    assert_equal '00f067aa0ba902b7', first_span[:p]
+    assert_equal '4bf92f3577b34da6a3ce929d0e0e4736', first_span[:lt]
+    assert_nil first_span[:ia]
+    assert first_span[:tp]
+  end
+
+  def test_basic_get_with_w3_disabled
+    clear_all!
+    ::Instana.config[:w3_trace_correlation] = false
+
+    header 'TRACEPARENT', '00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01'
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    refute first_span[:tp]
+    ::Instana.config[:w3_trace_correlation] = true
+  end
+
+  def test_skip_trace
+    clear_all!
+    header 'X_INSTANA_L', '0;junk'
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 0, spans.count
+  end
+
+  def test_disable_trace
+    clear_all!
+    ::Instana.config[:tracing][:enabled] = false
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 0, spans.count
+    ::Instana.config[:tracing][:enabled] = true
+  end
+
+  def test_error_trace
+    clear_all!
+
+    get '/error'
+    refute last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal 1, first_span[:ec]
+  end
+
+  def test_disable_trace_with_error
+    clear_all!
+    ::Instana.config[:tracing][:enabled] = false
+
+    get '/error'
+    refute last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 0, spans.count
+    ::Instana.config[:tracing][:enabled] = true
+  end
+
+  def test_five_zero_x_trace
+    clear_all!
+
+    get '/five_zero_one'
+    refute last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal 1, first_span[:ec]
+  end
+end