instana 1.193.5 → 1.195.3

data/lib/instana/secrets.rb

@@ -10,7 +10,7 @@ module Instana
       return str unless secret_values
 
       url = URI(str)
-      params = CGI.parse(url.query || '')
+      params = url.scheme ? CGI.parse(url.query || '') : CGI.parse(url.to_s)
 
       redacted = params.map do |k, v|
         needs_redaction = secret_values['list']
@@ -19,7 +19,7 @@ module Instana
       end
 
       url.query = URI.encode_www_form(redacted)
-      CGI.unescape(url.to_s)
+      url.scheme ? CGI.unescape(url.to_s) : CGI.unescape(url.query)
     end
 
     private

data/lib/instana/tracer.rb

@@ -38,8 +38,8 @@ module Instana
     #     :level specifies data collection level (optional)
     #
     def start_or_continue_trace(name, kvs = {}, incoming_context = nil, &block)
-      log_start_or_continue(name, kvs, incoming_context)
-      yield
+      span = log_start_or_continue(name, kvs, incoming_context)
+      yield(span)
     rescue Exception => e
       log_error(e)
       raise
@@ -59,8 +59,8 @@ module Instana
     # @param kvs [Hash] list of key values to be reported in this new span
     #
     def trace(name, kvs = {}, &block)
-      log_entry(name, kvs)
-      yield
+      span = log_entry(name, kvs)
+      yield(span)
     rescue Exception => e
       log_error(e)
       raise
@@ -91,7 +91,15 @@ module Instana
       if incoming_context
         if incoming_context.is_a?(Hash)
           if !incoming_context.empty?
-            parent_context = SpanContext.new(incoming_context[:trace_id], incoming_context[:span_id], incoming_context[:level])
+            parent_context = SpanContext.new(
+              incoming_context[:trace_id],
+              incoming_context[:span_id],
+              incoming_context[:level],
+              {
+                external_trace_id: incoming_context[:external_trace_id],
+                external_state: incoming_context[:external_state]
+              }
+            )
           end
         else
           parent_context = incoming_context
@@ -103,12 +111,7 @@ module Instana
       else
         self.current_span = Span.new(name)
       end
-      
-      if incoming_context.is_a?(Hash) && incoming_context[:correlation] && !incoming_context[:correlation].empty?
-        self.current_span[:crid] = incoming_context[:correlation][:id]
-        self.current_span[:crtp] = incoming_context[:correlation][:type]
-      end
-      
+
       self.current_span.set_tags(kvs) unless kvs.empty?
       self.current_span
     end

data/lib/instana/tracing/span.rb

@@ -6,10 +6,10 @@ module Instana
     REGISTERED_SPANS = [ :actioncontroller, :actionview, :activerecord, :excon,
                          :memcache, :'net-http', :rack, :render, :'rpc-client',
                          :'rpc-server', :'sidekiq-client', :'sidekiq-worker',
-                         :redis, :'resque-client', :'resque-worker', :'graphql.server'  ].freeze
-    ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server' ].freeze
+                         :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb, :s3, :sns, :sqs  ].freeze
+    ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server', :sqs ].freeze
     EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'resque-client',
-                   :'rpc-client', :'sidekiq-client', :redis ].freeze
+                   :'rpc-client', :'sidekiq-client', :redis, :dynamodb, :s3, :sns, :sqs ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent
@@ -289,6 +289,12 @@ module Instana
       @data.inspect
     end
 
+    # Check to see if the current span indicates an exit from application
+    # code and into an external service
+    def exit_span?
+      EXIT_SPANS.include?(@data[:n])
+    end
+
     #############################################################
     # OpenTracing Compatibility Methods
     #############################################################

data/lib/instana/tracing/span_context.rb

@@ -6,6 +6,7 @@ module Instana
     attr_accessor :trace_id
     attr_accessor :span_id
     attr_accessor :baggage
+    attr_reader :level
 
     # Create a new SpanContext
     #
@@ -18,7 +19,7 @@ module Instana
       @trace_id = tid
       @span_id = sid
       @level = level
-      @baggage = baggage
+      @baggage = baggage || {}
     end
 
     def trace_id_header
@@ -29,8 +30,31 @@ module Instana
       ::Instana::Util.id_to_header(@span_id)
     end
 
+    def trace_parent_header
+      return '' unless valid?
+
+      trace = (@baggage[:external_trace_id] || @trace_id).rjust(32, '0')
+      parent = @span_id.rjust(16, '0')
+      flags = @level == 1 ? "01" : "00"
+
+      "00-#{trace}-#{parent}-#{flags}"
+    end
+
+    def trace_state_header
+      return '' unless valid?
+
+      state = ["in=#{trace_id_header};#{span_id_header}", @baggage[:external_state]]
+      state.compact.join(',')
+    end
+
     def to_hash
       { :trace_id => @trace_id, :span_id => @span_id }
     end
+
+    private
+
+    def valid?
+      @baggage && @trace_id && @span_id
+    end
   end
 end

data/lib/instana/version.rb

@@ -2,6 +2,6 @@
 # (c) Copyright Instana Inc. 2016
 
 module Instana
-  VERSION = "1.193.5"
+  VERSION = "1.195.3"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/instrumentation/aws_test.rb

@@ -0,0 +1,161 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class AwsTest < Minitest::Test
+  def setup
+    clear_all!
+  end
+
+  def test_dynamo_db
+    dynamo = Aws::DynamoDB::Client.new(
+      region: "local",
+      access_key_id: "placeholder",
+      secret_access_key: "placeholder",
+      endpoint: "http://localhost:8000"
+    )
+
+    assert_raises Aws::DynamoDB::Errors::ResourceNotFoundException do
+      Instana::Tracer.start_or_continue_trace(:dynamo_test, {}) do
+        dynamo.get_item(
+          table_name: 'sample_table',
+          key: { s: 'sample_item' }
+        )
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    dynamo_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], dynamo_span[:p]
+    assert_equal :dynamodb, dynamo_span[:n]
+    assert_equal 'get', dynamo_span[:data][:dynamodb][:op]
+    assert_equal 'sample_table', dynamo_span[:data][:dynamodb][:table]
+  end
+
+  def test_s3
+    dynamo = Aws::S3::Client.new(
+      region: "local",
+      access_key_id: "minioadmin",
+      secret_access_key: "minioadmin",
+      endpoint: "http://localhost:9000"
+    )
+
+    assert_raises Aws::S3::Errors::NoSuchBucket do
+      Instana::Tracer.start_or_continue_trace(:s3_test, {}) do
+        dynamo.get_object(
+          bucket: 'sample_bucket',
+          key: 'sample_key'
+        )
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    s3_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], s3_span[:p]
+    assert_equal :s3, s3_span[:n]
+    assert_equal 'get', s3_span[:data][:s3][:op]
+    assert_equal 'sample_bucket', s3_span[:data][:s3][:bucket]
+    assert_equal 'sample_key', s3_span[:data][:s3][:key]
+  end
+
+  def test_sns_publish
+    sns = Aws::SNS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9911"
+    )
+
+    assert_raises Aws::SNS::Errors::NotFound do
+      Instana::Tracer.start_or_continue_trace(:sns_test, {}) do
+        sns.publish(
+          topic_arn: 'topic:arn',
+          target_arn: 'target:arn',
+          phone_number: '555-0100',
+          subject: 'Test Subject',
+          message: 'Test Message'
+        )
+      end
+    end
+
+    spans = ::Instana.processor.queued_spans
+    aws_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], aws_span[:p]
+    assert_equal :sns, aws_span[:n]
+    assert_equal 'topic:arn', aws_span[:data][:sns][:topic]
+    assert_equal 'target:arn', aws_span[:data][:sns][:target]
+    assert_equal '555-0100', aws_span[:data][:sns][:phone]
+    assert_equal 'Test Subject', aws_span[:data][:sns][:subject]
+  end
+
+  def test_sns_other
+    sns = Aws::SNS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9911"
+    )
+
+    Instana::Tracer.start_or_continue_trace(:sns_test, {}) do
+      sns.list_subscriptions
+    end
+
+    spans = ::Instana.processor.queued_spans
+    aws_span, entry_span, *rest = spans
+
+    assert rest.empty?
+    assert_equal entry_span[:s], aws_span[:p]
+    assert_equal :"net-http", aws_span[:n]
+  end
+
+  def test_sqs
+    sqs = Aws::SQS::Client.new(
+      region: "local",
+      access_key_id: "test",
+      secret_access_key: "test",
+      endpoint: "http://localhost:9324"
+    )
+
+    create_response = nil
+    get_url_response = nil
+
+    Instana::Tracer.start_or_continue_trace(:sqs_test, {}) do
+      create_response = sqs.create_queue(queue_name: 'test')
+      get_url_response = sqs.get_queue_url(queue_name: 'test')
+      sqs.send_message(queue_url: create_response.queue_url, message_body: 'Sample')
+    end
+
+    received = sqs.receive_message(
+      queue_url: create_response.queue_url,
+      message_attribute_names: ['All']
+    )
+    sqs.delete_queue(queue_url: create_response.queue_url)
+    message = received.messages.first
+    create_span, get_span, send_span, _root = ::Instana.processor.queued_spans
+
+    assert_equal :sqs, create_span[:n]
+    assert_equal create_response.queue_url, create_span[:data][:sqs][:queue]
+    assert_equal 'exit', create_span[:data][:sqs][:sort]
+    assert_equal 'create.queue', create_span[:data][:sqs][:type]
+
+    assert_equal :sqs, get_span[:n]
+    assert_equal get_url_response.queue_url, get_span[:data][:sqs][:queue]
+    assert_equal 'exit', get_span[:data][:sqs][:sort]
+    assert_equal 'get.queue', get_span[:data][:sqs][:type]
+
+    assert_equal :sqs, send_span[:n]
+    assert_equal get_url_response.queue_url, send_span[:data][:sqs][:queue]
+    assert_equal 'exit', send_span[:data][:sqs][:sort]
+    assert_equal 'single.sync', send_span[:data][:sqs][:type]
+    assert_equal send_span[:t], message.message_attributes['X_INSTANA_T'].string_value
+    assert_equal send_span[:s], message.message_attributes['X_INSTANA_S'].string_value
+    assert_equal 'Sample', message.body
+  end
+end

data/test/instrumentation/excon_test.rb

@@ -40,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/net_http_test.rb

@@ -11,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

@@ -18,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',
@@ -33,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
@@ -41,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 = {
@@ -50,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

@@ -15,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
@@ -22,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
 
@@ -49,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]
@@ -272,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