instana 1.192.0 → 1.192.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 424f7ce1ff02d56a5498df4f3f861231c30f5032cf02e8604e008155c389f4b5
-  data.tar.gz: aac1bf703a70d5c7039fbae031846d513a5d3d9d2c5d00630308eacd8b862095
+  metadata.gz: 1671f39523faeeea826d7892820992a88ffbb3f923fb20b3c19c082dc281480a
+  data.tar.gz: a6f70177f02c753830fea6075556a70cd4c3ccd30e083d0e316f638396ea6c44
 SHA512:
-  metadata.gz: c9470f7a3f6e1d7198a99d8017556689b0eaffb3bc22677064cbb1f5552f80c8814d481dc842b8a082e5a9c5a6cb86b0f46d95cbbc8055d56c7b2588277bbdaa
-  data.tar.gz: c9e83f799f6b343e6dd98840fcdc48175cc52d9a876c9421e053909bf0dcbfaaf384669b449ce53edf3bd0478ece21484c01c27fd24b6247efcc86ad0a56b0f0
+  metadata.gz: be7333bc5dab3edff9342fd0f6a311b45df11a2fd58c9f61153e32fa3f638ac359a750365204655b6933dac90259e991fb1bddd9b9214f1d7f3fe62159c0d69b
+  data.tar.gz: bdc9a0ee62692ff327a849732508cf6656b76d24206528d8120830b764b2968bf040a1d93f9735f7004c1e2104c8e394f8c68834a91e1e3eaf3a2861247b295c

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/lib/instana/instrumentation/instrumented_request.rb

@@ -0,0 +1,68 @@
+# Note: We really only need "cgi/util" here but Ruby 2.4.1 has an issue:
+# https://bugs.ruby-lang.org/issues/13539
+require "cgi"
+
+module Instana
+  class InstrumentedRequest < Rack::Request
+    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 = {}
+
+      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
+    end
+
+    def extra_header_tags
+      return nil unless ::Instana.agent.extra_headers
+      headers = {}
+
+      ::Instana.agent.extra_headers.each do |custom_header|
+        # Headers are available in this format: HTTP_X_CAPTURE_THIS
+        rack_header = 'HTTP_' + custom_header.upcase
+        rack_header.tr!('-', '_')
+
+        headers[custom_header.to_sym] = @env[rack_header] if @env.has_key?(rack_header)
+      end
+
+      headers
+    end
+
+    def request_tags
+      {
+        method: request_method,
+        url: CGI.unescape(path_info),
+        host: host_with_port,
+        header: extra_header_tags
+      }.compact
+    end
+
+    def correlation_data
+      @correlation_data ||= parse_correlation_data
+    end
+
+    private
+
+    def parse_correlation_data
+      return {} unless @env.has_key?('HTTP_X_INSTANA_L')
+      _level, *tokens = @env['HTTP_X_INSTANA_L'].split(/[,=;]/)
+      data = tokens
+        .map { |t| t.strip }
+        .each_slice(2)
+        .select { |a| a.length == 2 }.to_h
+
+      {
+        type: data['correlationType'],
+        id: data['correlationId']
+      }.compact
+    end
+  end
+end

data/lib/instana/instrumentation/rack.rb

@@ -1,6 +1,4 @@
-# Note: We really only need "cgi/util" here but Ruby 2.4.1 has an issue:
-# https://bugs.ruby-lang.org/issues/13539
-require "cgi"
+require 'instana/instrumentation/instrumented_request'
 
 module Instana
   class Rack
@@ -8,59 +6,21 @@ module Instana
       @app = app
     end
 
-    def collect_kvs(env)
-      kvs = {}
-      kvs[:http] = {}
-      kvs[:http][:method] = env['REQUEST_METHOD']
-      kvs[:http][:url] = ::CGI.unescape(env['PATH_INFO'])
-
-      if env.key?('HTTP_HOST')
-        kvs[:http][:host] = env['HTTP_HOST']
-      elsif env.key?('SERVER_NAME')
-        kvs[:http][:host] = env['SERVER_NAME']
-      end
-
-      if ENV.key?('INSTANA_SERVICE_NAME')
-        kvs[:service] = ENV['INSTANA_SERVICE_NAME']
-      end
-
-      if ::Instana.agent.extra_headers
-        ::Instana.agent.extra_headers.each { |custom_header|
-          # Headers are available in this format: HTTP_X_CAPTURE_THIS
-          rack_header = 'HTTP_' + custom_header.upcase
-          rack_header.tr!('-', '_')
-
-          if env.key?(rack_header)
-            unless kvs[:http].key?(:header)
-              kvs[:http][:header] = {}
-            end
-            kvs[:http][:header][custom_header.to_sym] = env[rack_header]
-          end
-        }
-      end
-      return kvs
-    end
-
     def call(env)
-      # Check incoming context
-      incoming_context = {}
-      if env.key?('HTTP_X_INSTANA_T')
-        incoming_context[:trace_id]  = ::Instana::Util.header_to_id(env['HTTP_X_INSTANA_T'])
-        incoming_context[:span_id]   = ::Instana::Util.header_to_id(env['HTTP_X_INSTANA_S']) if env.key?('HTTP_X_INSTANA_S')
-        incoming_context[:level]     = env['HTTP_X_INSTANA_L'] if env.key?('HTTP_X_INSTANA_L')
-
-        # Honor X-Instana-L
-        if incoming_context[:level] and incoming_context[:level].length > 0
-          if incoming_context[:level][0] == "0"
-            return @app.call(env)
-          end
-        end
+      req = InstrumentedRequest.new(env)
+      return @app.call(env) if req.skip_trace?
+      kvs = {
+        http: req.request_tags,
+        service: ENV['INSTANA_SERVICE_NAME']
+      }.compact
+
+      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
 
-      kvs = collect_kvs(env)
-
-      ::Instana.tracer.log_start_or_continue(:rack, {}, incoming_context)
-
       status, headers, response = @app.call(env)
 
       if ::Instana.tracer.tracing?

data/lib/instana/tracer.rb

@@ -100,6 +100,12 @@ 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/util.rb

@@ -225,53 +225,39 @@ module Instana
         (time.to_f * 1000).floor
       end
 
-      # Generate a random 64bit ID
+      # Generate a random 64bit/128bit ID
       #
-      # @return [Integer] a random 64bit integer
+      # @param size [Integer] Number of 64 bit integers used to generate the id
       #
-      def generate_id
-        # Max value is 9223372036854775807 (signed long in Java)
-        rand(ID_RANGE)
+      # @return [String] a random 64bit/128bit hex encoded string
+      #
+      def generate_id(size = 1)
+        Array.new(size) { rand(ID_RANGE) }
+          .pack('q>*')
+          .unpack('H*')
+          .first
       end
 
       # Convert an ID to a value appropriate to pass in a header.
       #
-      # @param id [Integer] the id to be converted
+      # @param id [String] the id to be converted
       #
       # @return [String]
       #
       def id_to_header(id)
-        unless id.is_a?(Integer) || id.is_a?(String)
-          Instana.logger.debug "id_to_header received a #{id.class}: returning empty string"
-          return String.new
-        end
-        [id.to_i].pack('q>').unpack('H*')[0].gsub(/^0+/, '')
-      rescue => e
-        Instana.logger.info "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-        Instana.logger.debug { e.backtrace.join("\r\n") }
+        return '' unless id.is_a?(String)
+        # Only send 64bit IDs downstream for now 
+        id.length == 32 ? id[16..-1] : id
       end
 
       # Convert a received header value into a valid ID
       #
       # @param header_id [String] the header value to be converted
       #
-      # @return [Integer]
+      # @return [String]
       #
       def header_to_id(header_id)
-        if !header_id.is_a?(String)
-          Instana.logger.debug "header_to_id received a #{header_id.class}: returning 0"
-          return 0
-        end
-        if header_id.length < 16
-          # The header is less than 16 chars.  Prepend
-          # zeros so we can convert correctly
-          missing = 16 - header_id.length
-          header_id = ("0" * missing) + header_id
-        end
-        [header_id].pack("H*").unpack("q>")[0]
-      rescue => e
-        Instana.logger.info "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-        Instana.logger.debug { e.backtrace.join("\r\n") }
+        header_id.is_a?(String) && header_id.match(/\A[a-z\d]{16,32}\z/i) ? header_id : ''
       end
     end
   end

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "1.192.0"
+  VERSION = "1.192.1"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/frameworks/rack_test.rb

@@ -5,7 +5,7 @@ require "instana/rack"
 
 class RackTest < Minitest::Test
   include Rack::Test::Methods
-  
+
   class PathTemplateApp
     def call(env)
       env['INSTANA_HTTP_PATH_TEMPLATE'] = 'sample_template'
@@ -147,8 +147,9 @@ class RackTest < Minitest::Test
 
   def test_context_continuation
     clear_all!
-    header 'X-INSTANA-T', Instana::Util.id_to_header(1234)
-    header 'X-INSTANA-S', Instana::Util.id_to_header(4321)
+    continuation_id = Instana::Util.generate_id
+    header 'X-INSTANA-T', continuation_id
+    header 'X-INSTANA-S', continuation_id
 
     get '/mrlobster'
     assert last_response.ok?
@@ -182,10 +183,30 @@ class RackTest < Minitest::Test
     # 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 1234, rack_span[:t]
-    assert_equal 4321, rack_span[:p]
+    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'
@@ -235,16 +256,16 @@ class RackTest < Minitest::Test
     ::Instana.config[:collect_backtraces] = false
     ::Instana.agent.extra_headers = nil
   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]

data/test/instrumentation/instrumented_request_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class InstrumentedRequestTest < 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_incomming_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,
+      level: '1'
+    }
+
+    assert_equal expected, req.incoming_context
+  end
+
+  def test_request_tags
+    ::Instana.agent.extra_headers = %w[X-Capture-This]
+    req = Instana::InstrumentedRequest.new(
+      'HTTP_HOST' => 'example.com',
+      'REQUEST_METHOD' => 'GET',
+      'HTTP_X_CAPTURE_THIS' => 'that',
+      'PATH_INFO' => '/'
+    )
+
+    expected = {
+      method: 'GET',
+      url: '/',
+      host: 'example.com',
+      header: {
+        "X-Capture-This": 'that'
+      }
+    }
+
+    assert_equal expected, req.request_tags
+    ::Instana.agent.extra_headers = nil
+  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/tracing/id_management_test.rb

@@ -49,82 +49,20 @@ class TracerIDMgmtTest < Minitest::Test
     converted_id = Instana::Util.header_to_id(header_id)
 
     # Assert that it is an Integer
-    assert converted_id.is_a?(Integer)
+    assert converted_id.is_a?(String)
   end
 
   def test_header_to_id_conversion_with_bogus_header
     # Bogus nil arg
     bogus_result = Instana::Util.header_to_id(nil)
-    assert_equal 0, bogus_result
+    assert_equal '', bogus_result
 
     # Bogus Integer arg
     bogus_result = Instana::Util.header_to_id(1234)
-    assert_equal 0, bogus_result
+    assert_equal '', bogus_result
 
     # Bogus Array arg
     bogus_result = Instana::Util.header_to_id([1234])
-    assert_equal 0, bogus_result
-  end
-
-  def test_id_conversion_back_and_forth
-    # id --> header --> id
-    original_id = ::Instana::Util.generate_id
-    header_id = Instana::Util.id_to_header(original_id)
-    converted_back_id = Instana::Util.header_to_id(header_id)
-    assert original_id == converted_back_id
-
-    # header --> id --> header
-    original_header_id = "c025ee93b1aeda7b"
-    id = Instana::Util.header_to_id(original_header_id)
-    converted_back_header_id = Instana::Util.id_to_header(id)
-    assert_equal original_header_id, converted_back_header_id
-
-    # Test a random value
-    id = -7815363404733516491
-    header = "938a406416457535"
-
-    result = Instana::Util.header_to_id(header)
-    assert_equal id, result
-
-    result = Instana::Util.id_to_header(id)
-    assert_equal header, result
-
-    10000.times do
-      original_id = ::Instana::Util.generate_id
-      header_id = Instana::Util.id_to_header(original_id)
-      converted_back_id = Instana::Util.header_to_id(header_id)
-      assert original_id == converted_back_id
-    end
-  end
-
-  def test_id_max_value_and_conversion
-    max_id = 9223372036854775807
-    min_id = -9223372036854775808
-    max_hex = "7fffffffffffffff"
-    min_hex = "8000000000000000"
-
-    assert_equal max_hex, Instana::Util.id_to_header(max_id)
-    assert_equal min_hex, Instana::Util.id_to_header(min_id)
-
-    assert_equal max_id, Instana::Util.header_to_id(max_hex)
-    assert_equal min_id, Instana::Util.header_to_id(min_hex)
-  end
-
-  def test_that_leading_zeros_handled_correctly
-
-    header = ::Instana::Util.id_to_header(16)
-    assert_equal "10", header
-
-    id = ::Instana::Util.header_to_id("10")
-    assert_equal 16, id
-
-    id = ::Instana::Util.header_to_id("0000000000000010")
-    assert_equal 16, id
-
-    id = ::Instana::Util.header_to_id("88b6c735206ca42")
-    assert_equal 615705016619420226, id
-
-    id = ::Instana::Util.header_to_id("088b6c735206ca42")
-    assert_equal 615705016619420226, id
+    assert_equal '', bogus_result
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.192.0
+  version: 1.192.1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,6 +175,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".codeclimate.yml"
+- ".editorconfig"
 - ".fasterer.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -233,6 +234,7 @@ files:
 - lib/instana/instrumentation/excon.rb
 - lib/instana/instrumentation/graphql.rb
 - lib/instana/instrumentation/grpc.rb
+- lib/instana/instrumentation/instrumented_request.rb
 - lib/instana/instrumentation/net-http.rb
 - lib/instana/instrumentation/rack.rb
 - lib/instana/instrumentation/redis.rb
@@ -278,6 +280,7 @@ files:
 - test/instrumentation/excon_test.rb
 - test/instrumentation/graphql_test.rb
 - test/instrumentation/grpc_test.rb
+- test/instrumentation/instrumented_request_test.rb
 - test/instrumentation/net-http_test.rb
 - test/instrumentation/redis_test.rb
 - test/instrumentation/resque_test.rb
@@ -325,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana
@@ -348,6 +351,7 @@ test_files:
 - test/instrumentation/rest-client_test.rb
 - test/instrumentation/dalli_test.rb
 - test/instrumentation/excon_test.rb
+- test/instrumentation/instrumented_request_test.rb
 - test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
 - test/benchmarks/bench_opentracing.rb