instana 1.11.8 → 1.193.2

data/lib/instana/instrumentation/rest-client.rb

@@ -1,34 +1,24 @@
 module Instana
   module Instrumentation
     module RestClientRequest
-      def self.included(klass)
-        if klass.method_defined?(:execute)
-          klass.class_eval do
-            alias execute_without_instana execute
-            alias execute execute_with_instana
-          end
-        end
-      end
-
-      def execute_with_instana & block
+      def execute(&block)
         # Since RestClient uses net/http under the covers, we just
         # provide span visibility here.  HTTP related KVs are reported
         # in the Net::HTTP instrumentation
         ::Instana.tracer.log_entry(:'rest-client')
 
-        execute_without_instana(&block)
+        super(&block)
       rescue => e
         ::Instana.tracer.log_error(e)
         raise
       ensure
         ::Instana.tracer.log_exit(:'rest-client')
       end
-
     end
   end
 end
 
 if defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
   ::Instana.logger.debug "Instrumenting RestClient"
-  ::RestClient::Request.send(:include, ::Instana::Instrumentation::RestClientRequest)
+  ::RestClient::Request.send(:prepend, ::Instana::Instrumentation::RestClientRequest)
 end

data/lib/instana/secrets.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'cgi'
+
+module Instana
+  class Secrets
+    def remove_from_query(str, secret_values = Instana.agent.secret_values)
+      return str unless secret_values
+
+      url = URI(str)
+      params = CGI.parse(url.query || '')
+
+      redacted = params.map do |k, v|
+        needs_redaction = secret_values['list']
+          .any? { |t| matcher(secret_values['matcher']).(t,k) }
+        [k, needs_redaction ? '<redacted>' : v]
+      end
+
+      url.query = URI.encode_www_form(redacted)
+      CGI.unescape(url.to_s)
+    end
+
+    private
+
+    def matcher(name)
+      case name
+      when 'equals-ignore-case'
+        ->(expected, actual) { expected.casecmp(actual) == 0 }
+      when 'equals'
+        ->(expected, actual) { (expected <=> actual) == 0 }
+      when 'contains-ignore-case'
+        ->(expected, actual) { actual.downcase.include?(expected) }
+      when 'contains'
+        ->(expected, actual) { actual.include?(expected) }
+      when 'regex'
+        ->(expected, actual) { !Regexp.new(expected).match(actual).nil? }
+      else
+        ::Instana.logger.warn("Matcher #{name} is not supported.")
+        lambda { false }
+      end
+    end
+  end
+end

data/lib/instana/setup.rb

@@ -4,6 +4,7 @@ require "instana/base"
 require "instana/config"
 require "instana/agent"
 require "instana/collector"
+require "instana/secrets"
 require "instana/tracer"
 require "instana/tracing/processor"
 require "instana/instrumentation"

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/tracing/span.rb

@@ -3,8 +3,8 @@ 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' ].freeze
-    ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker' ].freeze
+                         :redis, :'resque-client', :'resque-worker', :'graphql.server'  ].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
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
@@ -57,9 +57,6 @@ module Instana
       end
 
       if ::Instana.config[:collect_backtraces]
-        # For entry spans, add a backtrace fingerprint
-        add_stack(limit: 2) if ENTRY_SPANS.include?(name)
-
         # Attach a backtrace to all exit spans
         add_stack if EXIT_SPANS.include?(name)
       end
@@ -76,9 +73,11 @@ module Instana
     #
     # @param limit [Integer] Limit the backtrace to the top <limit> frames
     #
-    def add_stack(limit: nil, stack: Kernel.caller)
+    def add_stack(limit: 30, stack: Kernel.caller)
       frame_count = 0
+      sanitized_stack = []
       @data[:stack] = []
+      limit = 40 if limit > 40
 
       stack.each do |i|
         # If the stack has the full instana gem version in it's path
@@ -86,18 +85,23 @@ module Instana
         if !i.match(/instana\/instrumentation\/rack.rb/).nil? ||
           (i.match(::Instana::VERSION_FULL).nil? && i.match('lib/instana/').nil?)
 
-          break if limit && frame_count >= limit
-
           x = i.split(':')
 
-          @data[:stack] << {
+          sanitized_stack << {
             :c => x[0],
             :n => x[1],
             :m => x[2]
           }
-         frame_count = frame_count + 1 if limit
         end
       end
+
+      if sanitized_stack.length > limit
+        # (limit * -1) gives us negative form of <limit> used for
+        # slicing from the end of the list. e.g. stack[-30, 30]
+        @data[:stack] = sanitized_stack[limit*-1, limit]
+      else
+        @data[:stack] = sanitized_stack
+      end
     end
 
     # Log an error into the span

data/lib/instana/util.rb

@@ -2,46 +2,6 @@ module Instana
   module Util
     class << self
       ID_RANGE = -2**63..2**63-1
-
-      # An agnostic approach to method aliasing.
-      #
-      # @param klass [Object] The class or module that holds the method to be alias'd.
-      # @param method [Symbol] The name of the method to be aliased.
-      #
-      def method_alias(klass, method)
-        if klass.method_defined?(method.to_sym) ||
-            klass.private_method_defined?(method.to_sym)
-
-          with = "#{method}_with_instana"
-          without = "#{method}_without_instana"
-
-          klass.class_eval do
-            alias_method without, method.to_s
-            alias_method method.to_s, with
-          end
-        else
-          ::Instana.logger.debug "No such method (#{method}) to alias on #{klass}"
-        end
-      end
-
-      # Calls on target_class to 'extend' cls
-      #
-      # @param target_cls [Object] the class/module to do the 'extending'
-      # @param cls [Object] the class/module to be 'extended'
-      #
-      def send_extend(target_cls, cls)
-        target_cls.send(:extend, cls) if defined?(target_cls)
-      end
-
-      # Calls on <target_cls> to include <cls> into itself.
-      #
-      # @param target_cls [Object] the class/module to do the 'including'
-      # @param cls [Object] the class/module to be 'included'
-      #
-      def send_include(target_cls, cls)
-        target_cls.send(:include, cls) if defined?(target_cls)
-      end
-
       # Debugging helper method
       #
       def pry!
@@ -225,53 +185,39 @@ module Instana
         (time.to_f * 1000).floor
       end
 
-      # Generate a random 64bit ID
+      # Generate a random 64bit/128bit ID
+      #
+      # @param size [Integer] Number of 64 bit integers used to generate the id
       #
-      # @return [Integer] a random 64bit integer
+      # @return [String] a random 64bit/128bit hex encoded string
       #
-      def generate_id
-        # Max value is 9223372036854775807 (signed long in Java)
-        rand(ID_RANGE)
+      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.11.8"
+  VERSION = "1.193.2"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/apps/cuba.rb

@@ -7,6 +7,10 @@ Cuba.define do
     on "hello" do
       res.write "Hello Instana!"
     end
+    
+    on "greet/:name" do |name|
+      res.write "Hello, #{name}"
+    end
 
     on root do
       res.redirect '/hello'

data/test/apps/roda.rb

@@ -6,5 +6,8 @@ class InstanaRodaApp < Roda
     r.get "hello" do
       "Hello Roda + Instana"
     end
+    r.get "greet", String do |name|
+      "Hello, #{name}!"
+    end
   end
 end

data/test/apps/sinatra.rb

@@ -2,4 +2,8 @@ class InstanaSinatraApp < ::Sinatra::Base
   get '/' do
     "Hello Sinatra!"
   end
+  
+  get '/greet/:name' do
+    "Hello, #{params[:name]}!"
+  end
 end

data/test/config_test.rb

@@ -10,28 +10,12 @@ class ConfigTest < Minitest::Test
     assert_equal '127.0.0.1', ::Instana.config[:agent_host]
     assert_equal 42699, ::Instana.config[:agent_port]
 
-    assert ::Instana.config[:enabled]
     assert ::Instana.config[:tracing][:enabled]
     assert ::Instana.config[:metrics][:enabled]
 
     ::Instana.config[:metrics].each do |k, v|
+      next unless v.is_a? Hash
       assert_equal true, ::Instana.config[:metrics][k].key?(:enabled)
     end
   end
-
-  def test_that_global_affects_children
-    # Disabling the gem should explicitly disable
-    # metrics and tracing flags
-    ::Instana.config[:enabled] = false
-
-    assert_equal false, ::Instana.config[:tracing][:enabled]
-    assert_equal false, ::Instana.config[:metrics][:enabled]
-
-    # Enabling the gem should explicitly enable
-    # metrics and tracing flags
-    ::Instana.config[:enabled] = true
-
-    assert_equal ::Instana.config[:tracing][:enabled]
-    assert_equal ::Instana.config[:metrics][:enabled]
-  end
 end

data/test/frameworks/cuba_test.rb

@@ -1,4 +1,3 @@
-
 if defined?(::Cuba)
   require 'test_helper'
   require File.expand_path(File.dirname(__FILE__) + '/../apps/cuba')
@@ -40,5 +39,19 @@ if defined?(::Cuba)
       assert first_span[:data][:http].key?(:host)
       assert_equal "example.org", first_span[:data][:http][:host]
     end
+
+    def test_path_template
+      clear_all!
+
+      r = get '/greet/instana'
+      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 '/greet/{name}', first_span[:data][:http][:path_tpl]
+    end
   end
 end

data/test/frameworks/rack_test.rb

@@ -6,15 +6,21 @@ require "instana/rack"
 class RackTest < Minitest::Test
   include Rack::Test::Methods
 
+  class PathTemplateApp
+    def call(env)
+      env['INSTANA_HTTP_PATH_TEMPLATE'] = 'sample_template'
+      [200, {}, ['Ok']]
+    end
+  end
+
   def app
-    @app = Rack::Builder.new {
+    @app = Rack::Builder.new do
       use Rack::CommonLogger
       use Rack::ShowExceptions
       use Instana::Rack
-      map "/mrlobster" do
-        run Rack::Lobster.new
-      end
-    }
+      map("/mrlobster") { run Rack::Lobster.new }
+      map("/path_tpl") { run PathTemplateApp.new }
+    end
   end
 
   def test_basic_get
@@ -51,11 +57,7 @@ class RackTest < Minitest::Test
     assert rack_span[:f].key?(:e)
     assert rack_span[:f].key?(:h)
     assert_equal ::Instana.agent.agent_uuid, rack_span[:f][:h]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::Instana.config[:collect_backtraces] = false
@@ -145,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?
@@ -180,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'
@@ -227,14 +250,24 @@ class RackTest < Minitest::Test
     assert rack_span[:data][:http][:header].key?(:"X-Capture-This")
     assert !rack_span[:data][:http][:header].key?(:"X-Capture-That")
     assert_equal "ThereYouGo", rack_span[:data][:http][:header][:"X-Capture-This"]
-
-    # Backtrace fingerprint validation
-    assert rack_span.key?(:stack)
-    assert_equal 2, rack_span[:stack].count
-    refute_nil rack_span[:stack].first[:c].match(/instana\/instrumentation\/rack.rb/)
+    assert !rack_span.key?(:stack)
 
     # Restore to default
     ::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]
+  end
 end