instana 1.193.4 → 1.195.2

data/test/instrumentation/excon_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'support/apps/http_endpoint/boot'
 
@@ -37,6 +40,7 @@ class ExconTest < Minitest::Test
     refute_nil excon_span[:data].key?(:http)
     assert_equal "http://127.0.0.1:6511/", excon_span[:data][:http][:url]
     assert_equal 200, excon_span[:data][:http][:status]
+    assert_equal 'basic_get', excon_span[:data][:http][:params]
 
     # excon backtrace not included by default check
     assert !excon_span.key?(:stack)

data/test/instrumentation/graphql_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
 require 'test_helper'
 
 class GraphqlTest < Minitest::Test

data/test/instrumentation/grpc_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require 'test_helper'
 require 'support/apps/grpc/boot'
 

data/test/instrumentation/net_http_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'support/apps/http_endpoint/boot'
 
@@ -8,6 +11,24 @@ 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_block_request
     clear_all!
     WebMock.allow_net_connect!

data/test/instrumentation/rack_instrumented_request_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
 require 'test_helper'
 
 class RackInstrumentedRequestTest < Minitest::Test
@@ -15,7 +18,7 @@ class RackInstrumentedRequestTest < Minitest::Test
     refute req.skip_trace?
   end
 
-  def test_incomming_context
+  def test_incoming_context
     id = Instana::Util.generate_id
     req = Instana::InstrumentedRequest.new(
       'HTTP_X_INSTANA_L' => '1',
@@ -30,6 +33,51 @@ class RackInstrumentedRequestTest < Minitest::Test
     }
 
     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',
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+    assert 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
@@ -38,7 +86,8 @@ class RackInstrumentedRequestTest < Minitest::Test
       'HTTP_HOST' => 'example.com',
       'REQUEST_METHOD' => 'GET',
       'HTTP_X_CAPTURE_THIS' => 'that',
-      'PATH_INFO' => '/'
+      'PATH_INFO' => '/',
+      'QUERY_STRING' => 'test=true'
     )
 
     expected = {
@@ -47,7 +96,8 @@ class RackInstrumentedRequestTest < Minitest::Test
       host: 'example.com',
       header: {
         "X-Capture-This": 'that'
-      }
+      },
+      params: 'test=true'
     }
 
     assert_equal expected, req.request_tags

data/test/instrumentation/rack_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'rack/test'
 require 'rack/lobster'
@@ -12,6 +15,24 @@ class RackTest < Minitest::Test
     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
@@ -19,6 +40,8 @@ class RackTest < Minitest::Test
       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
 
@@ -46,6 +69,10 @@ class RackTest < Minitest::Test
     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]
@@ -269,4 +296,121 @@ class RackTest < Minitest::Test
     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

data/test/instrumentation/rails_action_cable_test.rb

@@ -0,0 +1,131 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+require 'rails'
+require 'action_cable'
+
+require 'ostruct'
+require 'logger'
+
+class RailsActionCableTest < Minitest::Test
+  def setup
+    skip unless defined?(::ActionCable::Connection::Base)
+  end
+
+  def test_transmit_no_parent
+    clear_all!
+
+    connection = mock_connection
+    channel_klass = Class.new(ActionCable::Channel::Base)
+
+    channel_klass
+      .new(connection, :test)
+      .send(:transmit, 'action' => 'sample')
+
+    span, rest = Instana.processor.queued_spans
+    data = span[:data]
+
+    assert_nil rest
+    assert :"rpc-server", span[:n]
+    assert :actioncable, data[:rpc][:flavor]
+    assert channel_klass.to_s, data[:rpc][:call]
+    assert :transmit, data[:rpc][:call_type]
+    assert Socket.gethostname, data[:rpc][:host]
+  end
+
+  def test_transmit_parent
+    clear_all!
+
+    connection = mock_connection
+    connection.instance_variable_set(
+      :@instana_trace_context,
+      Instana::SpanContext.new('ABC', 'ABC')
+    )
+    channel_klass = Class.new(ActionCable::Channel::Base)
+
+    channel_klass
+      .new(connection, :test)
+      .send(:transmit, 'action' => 'sample')
+
+    span, rest = Instana.processor.queued_spans
+    data = span[:data]
+
+    assert_nil rest
+    assert 'ABC', span[:t]
+    assert :"rpc-server", span[:n]
+    assert :actioncable, data[:rpc][:flavor]
+    assert channel_klass.to_s, data[:rpc][:call]
+    assert :transmit, data[:rpc][:call_type]
+    assert Socket.gethostname, data[:rpc][:host]
+  end
+
+  def test_action_no_parent
+    clear_all!
+
+    connection = mock_connection
+    channel_klass = Class.new(ActionCable::Channel::Base) do
+      def sample
+        raise unless Instana.tracer.tracing?
+      end
+    end
+
+    channel_klass
+      .new(connection, :test)
+      .perform_action('action' => 'sample')
+
+    span, rest = Instana.processor.queued_spans
+    data = span[:data]
+
+    assert_nil rest
+    assert :"rpc-server", span[:n]
+    assert :actioncable, data[:rpc][:flavor]
+    assert "#{channel_klass}#sample", data[:rpc][:call]
+    assert :action, data[:rpc][:call_type]
+    assert Socket.gethostname, data[:rpc][:host]
+  end
+
+  def test_action_parent
+    clear_all!
+
+    connection = mock_connection
+    connection.instance_variable_set(
+      :@instana_trace_context,
+      Instana::SpanContext.new('ABC', 'ABC')
+    )
+    channel_klass = Class.new(ActionCable::Channel::Base) do
+      def sample
+        raise unless Instana.tracer.tracing?
+      end
+    end
+
+    channel_klass
+      .new(connection, :test)
+      .perform_action('action' => 'sample')
+
+    span, rest = Instana.processor.queued_spans
+    data = span[:data]
+
+    assert_nil rest
+    assert 'ABC', span[:t]
+    assert :"rpc-server", span[:n]
+    assert :actioncable, data[:rpc][:flavor]
+    assert "#{channel_klass}#sample", data[:rpc][:call]
+    assert :action, data[:rpc][:call_type]
+    assert Socket.gethostname, data[:rpc][:host]
+  end
+
+  private
+
+  def mock_connection
+    server = OpenStruct.new(
+      logger: Logger.new('/dev/null'),
+      worker_pool: nil,
+      config: OpenStruct.new(log_tags: [])
+    )
+    connection = ActionCable::Connection::Base.new(server, {})
+    connection.define_singleton_method(:transmit) { |*_args| true }
+    connection
+  end
+end