instana 1.193.6 → 1.195.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db77f1675976effa012f80a5d583f271b99e82db24e288a5af82eae4fa423cf1
-  data.tar.gz: 9fe2b02c6f58355876c91d8954d3039a14b948f67b7a5730319579fb5d405a9f
+  metadata.gz: c2d6ab5606ce437d1b56cac7e9db7170085b5ba5603c4c0056b5c9529264c24e
+  data.tar.gz: dd0c1163a6f6c8ccb66025d83a18b0f89a02208b423ee17ab771c0e30db45f6d
 SHA512:
-  metadata.gz: e00009c32acb5e684ee6c2dea9c7a7d4a40133f14ff8ec5929e39e97622b6daf8c5a027ad6cfdf9c3ace7e27f7accb9f1fff25f954e51eab11854ffb7f0f5e9b
-  data.tar.gz: 7b8f0c486ab5deaa118debcedc1bf43b6164832cde533d52cb99fe8ac44c76ffe9c555101331ed7cff4b7e421fa321898ff3cf195af80d3a4cda4ed2b5c19db9
+  metadata.gz: '0792a8df1fb233c29f99f0004cba3551ec08720eab3128b8f956fb3c161a2469b970b2ec9272799a8fb2f65114be4fae252cf81fa48ef3eb1f5e31c596f9a73c'
+  data.tar.gz: 2856142ade217e7ccd90301d2f90d1127f005e290ca4fa6924b4604c91d11983353089e4862935e1a0be107ee45ecb240608cbc7abc33c08bf6df1a4f9f72db9

data/lib/instana/config.rb

@@ -55,6 +55,9 @@ module Instana
       # ::Instana.config[:sanitize_sql] = false
       @config[:sanitize_sql] = true
 
+      # W3 Trace Context Support
+      @config[:w3_trace_correlation] = ENV.fetch('INSTANA_W3C_TRACE_CORRELATION', 'true').eql?('true')
+
       @config[:action_controller]  = { :enabled => true }
       @config[:action_view]        = { :enabled => true }
       @config[:active_record]      = { :enabled => true }

data/lib/instana/instrumentation/excon.rb

@@ -26,6 +26,11 @@ module Instana
         datum[:headers]['X-Instana-T'] = t_context.trace_id_header
         datum[:headers]['X-Instana-S'] = t_context.span_id_header
 
+        if ::Instana.config[:w3_trace_correlation]
+          datum[:headers]['Traceparent'] = t_context.trace_parent_header
+          datum[:headers]['Tracestate'] = t_context.trace_state_header
+        end
+
         @stack.request_call(datum)
       end
 

data/lib/instana/instrumentation/instrumented_request.rb

@@ -9,19 +9,24 @@ require 'rack/request'
 
 module Instana
   class InstrumentedRequest < Rack::Request
+    W3_TRACE_PARENT_FORMAT = /00-(?<trace>[0-9a-f]+)-(?<parent>[0-9a-f]+)-(?<flags>[0-9a-f]+)/.freeze
+    INSTANA_TRACE_STATE = /in=(?<trace>[0-9a-f]+);(?<span>[0-9a-f]+)/.freeze
+
     def skip_trace?
       # Honor X-Instana-L
       @env.has_key?('HTTP_X_INSTANA_L') && @env['HTTP_X_INSTANA_L'].start_with?('0')
     end
 
     def incoming_context
-      context = {}
+      context = if @env['HTTP_X_INSTANA_T']
+                  context_from_instana_headers
+                elsif @env['HTTP_TRACEPARENT'] && ::Instana.config[:w3_trace_correlation]
+                  context_from_trace_parent
+                else
+                  {}
+                end
 
-      if @env['HTTP_X_INSTANA_T']
-        context[:trace_id] = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T'])
-        context[:span_id] = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S']) if @env['HTTP_X_INSTANA_S']
-        context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
-      end
+      context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
 
       context
     end
@@ -54,8 +59,55 @@ module Instana
       @correlation_data ||= parse_correlation_data
     end
 
+    def instana_ancestor
+      @instana_ancestor ||= parse_trace_state
+    end
+
+    def continuing_from_trace_parent?
+      incoming_context.include?(:external_trace_id)
+    end
+
+    def synthetic?
+      @env.has_key?('HTTP_X_INSTANA_SYNTHETIC') && @env['HTTP_X_INSTANA_SYNTHETIC'].eql?('1')
+    end
+
     private
 
+    def context_from_instana_headers
+      {
+        trace_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T']),
+        span_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S'])
+      }.compact
+    end
+
+    def context_from_trace_parent
+      return {} unless @env.has_key?('HTTP_TRACEPARENT')
+      matches = @env['HTTP_TRACEPARENT'].match(W3_TRACE_PARENT_FORMAT)
+      return {} unless matches
+
+      {
+        external_trace_id: matches['trace'],
+        external_state: @env['HTTP_TRACESTATE'],
+        trace_id: ::Instana::Util.header_to_id(matches['trace'][16..-1]),
+        span_id: ::Instana::Util.header_to_id(matches['parent'])
+      }
+    end
+
+    def parse_trace_state
+      return {} unless @env.has_key?('HTTP_TRACESTATE')
+      token = @env['HTTP_TRACESTATE']
+        .split(/,/)
+        .map { |t| t.match(INSTANA_TRACE_STATE) }
+        .reject { |t| t.nil? }
+        .first
+      return {} unless token
+
+      {
+        t: token['trace'],
+        p: token['span']
+      }
+    end
+
     def parse_correlation_data
       return {} unless @env.has_key?('HTTP_X_INSTANA_L')
       _level, *tokens = @env['HTTP_X_INSTANA_L'].split(/[,=;]/)

data/lib/instana/instrumentation/net-http.rb

@@ -22,6 +22,11 @@ module Instana
         request['X-Instana-T'] = t_context.trace_id_header
         request['X-Instana-S'] = t_context.span_id_header
 
+        if ::Instana.config[:w3_trace_correlation]
+          request['Traceparent'] = t_context.trace_parent_header
+          request['Tracestate'] = t_context.trace_state_header
+        end
+
         # Collect up KV info now in case any exception is raised
         kv_payload = { :http => {} }
         kv_payload[:http][:method] = request.method

data/lib/instana/instrumentation/rack.rb

@@ -20,14 +20,26 @@ module Instana
 
       current_span = ::Instana.tracer.log_start_or_continue(:rack, {}, req.incoming_context)
 
-      unless req.correlation_data.empty?
-        current_span[:crid] = req.correlation_data[:id]
-        current_span[:crtp] = req.correlation_data[:type]
-      end
-
       status, headers, response = @app.call(env)
 
       if ::Instana.tracer.tracing?
+        unless req.correlation_data.empty?
+          current_span[:crid] = req.correlation_data[:id]
+          current_span[:crtp] = req.correlation_data[:type]
+        end
+
+        if !req.instana_ancestor.empty? && req.continuing_from_trace_parent?
+          current_span[:ia] = req.instana_ancestor
+        end
+
+        if req.continuing_from_trace_parent?
+          current_span[:tp] = true
+          current_span[:lt] = req.incoming_context[:external_trace_id]
+        end
+
+        if req.synthetic?
+          current_span[:sy] = true
+        end
         # In case some previous middleware returned a string status, make sure that we're dealing with
         # an integer.  In Ruby nil.to_i, "asdfasdf".to_i will always return 0 from Ruby versions 1.8.7 and newer.
         # So if an 0 status is reported here, it indicates some other issue (e.g. no status from previous middleware)
@@ -45,23 +57,31 @@ module Instana
         # See: https://www.instana.com/docs/tracing/custom-best-practices/#path-templates-visual-grouping-of-http-endpoints
         kvs[:http][:path_tpl] = env['INSTANA_HTTP_PATH_TEMPLATE'] if env['INSTANA_HTTP_PATH_TEMPLATE']
 
-        # Save the IDs before the trace ends so we can place
+        # Save the span context before the trace ends so we can place
         # them in the response headers in the ensure block
-        trace_id = ::Instana.tracer.current_span.trace_id
-        span_id = ::Instana.tracer.current_span.id
+        trace_context = ::Instana.tracer.current_span.context
       end
 
       [status, headers, response]
     rescue Exception => e
-      ::Instana.tracer.log_error(e)
+      ::Instana.tracer.log_error(e) if ::Instana.tracer.tracing?
       raise
     ensure
-      if headers && ::Instana.tracer.tracing?
-        # Set reponse headers; encode as hex string
-        headers['X-Instana-T'] = ::Instana::Util.id_to_header(trace_id)
-        headers['X-Instana-S'] = ::Instana::Util.id_to_header(span_id)
-        headers['X-Instana-L'] = '1'
-        headers['Server-Timing'] = "intid;desc=#{::Instana::Util.id_to_header(trace_id)}"
+      if ::Instana.tracer.tracing?
+        if headers
+          # Set response headers; encode as hex string
+          headers['X-Instana-T'] = trace_context.trace_id_header
+          headers['X-Instana-S'] = trace_context.span_id_header
+          headers['X-Instana-L'] = '1'
+
+          if ::Instana.config[:w3_trace_correlation]
+            headers['Traceparent'] = trace_context.trace_parent_header
+            headers['Tracestate'] = trace_context.trace_state_header
+          end
+
+          headers['Server-Timing'] = "intid;desc=#{trace_context.trace_id_header}"
+        end
+
         ::Instana.tracer.log_end(:rack, kvs)
       end
     end

data/lib/instana/tracer.rb

@@ -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_context.rb

@@ -18,7 +18,7 @@ module Instana
       @trace_id = tid
       @span_id = sid
       @level = level
-      @baggage = baggage
+      @baggage = baggage || {}
     end
 
     def trace_id_header
@@ -29,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/version.rb

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

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

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

data/test/tracing/opentracing_test.rb

@@ -304,7 +304,7 @@ class OpenTracerTest < Minitest::Test
     assert_equal second_span[:s], third_span[:p]
 
     # Every span should have baggage
-    assert_equal(nil, entry_span.context.baggage)
+    assert_equal({}, entry_span.context.baggage)
     assert_equal({:my_bag=>1}, ac_span.context.baggage)
     assert_equal({:my_bag=>1}, av_span.context.baggage)
   end
@@ -331,9 +331,9 @@ class OpenTracerTest < Minitest::Test
     spans = ::Instana.processor.queued_spans
     assert_equal 3, spans.length
 
-    assert_equal(nil, entry_span.context.baggage)
+    assert_equal({}, entry_span.context.baggage)
     assert_equal({:my_bag=>1}, ac_span.context.baggage)
-    assert_equal(nil, av_span.context.baggage)
+    assert_equal({}, av_span.context.baggage)
   end
 
   def test_start_active_span

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.193.6
+  version: 1.195.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler