instana 1.193.3 → 1.195.1

data/lib/instana/tracing/processor.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'thread'
 
 module Instana

data/lib/instana/tracing/span.rb

@@ -1,12 +1,15 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
   class Span
     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
+                         :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb  ].freeze
     ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server' ].freeze
     EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'resque-client',
-                   :'rpc-client', :'sidekiq-client', :redis ].freeze
+                   :'rpc-client', :'sidekiq-client', :redis, :dynamodb ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent
@@ -286,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

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 module Instana
   class SpanContext
     attr_accessor :trace_id
@@ -15,7 +18,7 @@ module Instana
       @trace_id = tid
       @span_id = sid
       @level = level
-      @baggage = baggage
+      @baggage = baggage || {}
     end
 
     def trace_id_header
@@ -26,8 +29,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};#{@span_id}", @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/util.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
   module Util
     class << self

data/lib/instana/version.rb

@@ -1,4 +1,7 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
-  VERSION = "1.193.3"
+  VERSION = "1.195.1"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/lib/oj_check.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2019
+
 begin
   require 'oj'
 rescue LoadError => e

data/lib/opentracing.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 require "instana/opentracing/tracer"
 require "instana/opentracing/carrier"
 

data/test/activator_test.rb

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

data/test/agent/agent_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require './lib/oj_check'
 

data/test/benchmarks/bench_id_generation.rb

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

data/test/benchmarks/bench_opentracing.rb

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

data/test/config_test.rb

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

data/test/frameworks/cuba_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'rack/test'
 

data/test/frameworks/roda_test.rb

@@ -1,4 +1,8 @@
 
+
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'rack/test'
 

data/test/frameworks/sinatra_test.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'test_helper'
 require 'rack/test'
 

data/test/instana_test.rb

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

data/test/instrumentation/aws_test.rb

@@ -0,0 +1,33 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class AwsTest < Minitest::Test
+  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_item, dynamo_span[:data][:op]
+    assert_equal 'sample_table', dynamo_span[:data][:table]
+  end
+end

data/test/instrumentation/dalli_test.rb

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

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'
 

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'
 

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

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