instana 1.11.7 → 1.193.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d29c335511f3dec4cac5857ac4d1b84b1b84f70a2f5974ed9b0f20992dc2cb7
-  data.tar.gz: 9560b29a9d7902f0f013a4b586fed564c8eb854a6e700e1798e8c71463dbdf7a
+  metadata.gz: e0c2b0b0e44a5aa72f401d7ab7009125c25d182c01aa01aade80a8ca9f9fc55b
+  data.tar.gz: d147f265753ba3397773197b366f8a24f53a4e928ca8e08a929664c7d5029a1e
 SHA512:
-  metadata.gz: ccd6ac828673bf6f731b0b75d09f4009a6f02e74c80eb2258af40e5993e0dd15c710e4936c2db53691a7a8f43234adbed0bbe45e13d9fe56ce99dbd2491ddf47
-  data.tar.gz: 347b2d4e384e37e74ce51d68bbce5059e4f8de7d1ea0aa7ab6dbb82b7ddc4c67d6b97479f1de8152c9fff988994e3daf0642f34712f0a152eaa3ba80b975de3a
+  metadata.gz: 5bb4b908097b92adf0169f9ca71a43f82df4349b3257cc30cdbc2b8ba3ec13b62171e9c3ed14c1233421801795ebaba4c697c43776e9e31983af900db95d56ff
+  data.tar.gz: f7d415705c052ab4c85d446da325569a9940c1d7bfdeb782f17d263d78152585364203120e50c91737d29e992a146710df434874c46c58ce0107df14b5bc7cab

data/Rakefile

@@ -8,44 +8,33 @@ Rake::TestTask.new(:test) do |t|
 
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-
-  if ENV.key?('BUNDLE_GEMFILE')
-    case File.basename(ENV['BUNDLE_GEMFILE']).split('.').first
-    when /rails6/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview5_test.rb)
-    when /rails5/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview5_test.rb)
-    when /rails42/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview4_test.rb)
-    when /rails32/
-      t.test_files = %w(test/frameworks/rails/activerecord_test.rb
-                        test/frameworks/rails/actioncontroller_test.rb
-                        test/frameworks/rails/actionview3_test.rb)
-    when /libraries/
-      t.test_files = FileList['test/instrumentation/*_test.rb',
-                              'test/frameworks/cuba_test.rb',
-                              'test/frameworks/rack_test.rb',
-                              'test/frameworks/roda_test.rb',
-                              'test/frameworks/sinatra_test.rb']
-    else
-      t.test_files = FileList['test/agent/*_test.rb'] +
-                     FileList['test/tracing/*_test.rb'] +
-                     FileList['test/profiling/*_test.rb'] +
-                     FileList['test/benchmarks/bench_*.rb']
-    end
-  else
-    t.test_files = FileList['test/agent/*_test.rb'] +
-        FileList['test/tracing/*_test.rb'] +
-        FileList['test/profiling/*_test.rb'] +
-        FileList['test/benchmarks/bench_*.rb']
+
+  t.test_files = Dir[
+    'test/*_test.rb',
+    'test/{agent,tracing,profiling,benchmarks}/*_test.rb'
+  ]
+
+  case File.basename(ENV.fetch('BUNDLE_GEMFILE', '')).split('.').first
+  when /rails6/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview5_test.rb)
+  when /rails5/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview5_test.rb)
+  when /rails42/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview4_test.rb)
+  when /rails32/
+    t.test_files = %w(test/frameworks/rails/activerecord_test.rb
+                      test/frameworks/rails/actioncontroller_test.rb
+                      test/frameworks/rails/actionview3_test.rb)
+  when /libraries/
+    t.test_files = Dir['test/{instrumentation,frameworks}/*_test.rb']
   end
+
 end
 
 task :environment do

data/gemfiles/libraries.gemfile

@@ -65,6 +65,8 @@ if RUBY_VERSION < '2.2'
   gem 'rack', '< 2.0'
 end
 
+gem 'graphql'
+
 # Include the Instana Ruby gem's base set of gems
 gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
 

data/lib/instana/agent.rb

@@ -25,6 +25,7 @@ module Instana
     attr_accessor :collect_thread
     attr_accessor :thread_spawn_lock
     attr_accessor :extra_headers
+    attr_reader :secret_values
 
     attr_accessor :testmode
 
@@ -83,6 +84,10 @@ module Instana
 
       # The agent may pass down custom headers for this sensor to capture
       @extra_headers = nil
+      
+      # The values considered sensitive and removed from http query parameters
+      # and database connection strings 
+      @secret_values = nil
     end
 
     # Spawns the background thread and calls start.  This method is separated
@@ -278,6 +283,7 @@ module Instana
         data = Oj.load(response.body, OJ_OPTIONS)
         @process[:report_pid] = data['pid']
         @agent_uuid = data['agentUuid']
+        @secret_values = data['secrets']
 
         if data.key?('extraHeaders')
           @extra_headers = data['extraHeaders']

data/lib/instana/base.rb

@@ -12,6 +12,7 @@ module Instana
     attr_accessor :config
     attr_accessor :logger
     attr_accessor :pid
+    attr_reader :secrets
 
     ##
     # setup
@@ -24,6 +25,7 @@ module Instana
       @tracer = ::Instana::Tracer.new
       @processor = ::Instana::Processor.new
       @collector = ::Instana::Collector.new
+      @secrets = ::Instana::Secrets.new
     end
   end
 end

data/lib/instana/config.rb

@@ -42,12 +42,23 @@ module Instana
       # ::Instana.config[:collect_backtraces] = true
       @config[:collect_backtraces] = false
 
+      # By default, collected SQL will be sanitized to remove potentially sensitive bind params such as:
+      #   > SELECT  "blocks".* FROM "blocks"  WHERE "blocks"."name" = "Mr. Smith"
+      #
+      # ...would be sanitized to be:
+      #   > SELECT  "blocks".* FROM "blocks"  WHERE "blocks"."name" = ?
+      #
+      # This sanitization step can be disabled by setting the following value to false.
+      # ::Instana.config[:sanitize_sql] = false
+      @config[:sanitize_sql] = true
+
       @config[:action_controller]  = { :enabled => true }
       @config[:action_view]        = { :enabled => true }
       @config[:active_record]      = { :enabled => true }
       @config[:dalli]              = { :enabled => true }
       @config[:excon]              = { :enabled => true }
       @config[:grpc]               = { :enabled => true }
+      @config[:graphql]            = { :enabled => true }
       @config[:nethttp]            = { :enabled => true }
       @config[:redis]              = { :enabled => true }
       @config[:'resque-client']    = { :enabled => true }

data/lib/instana/frameworks/cuba.rb

@@ -1,6 +1,39 @@
 require "instana/rack"
 
+module Instana
+  module CubaPathTemplateExtractor
+    REPLACE_TARGET = /:(?<term>[^\/]+)/i
+    
+    def self.prepended(base)
+      ::Instana.logger.debug "#{base} prepended #{self}"
+    end
+    
+    def on(*args, &blk) 
+      wrapper = lambda do |*caputres|
+        env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] << args
+          .select { |a| a.is_a?(String) }
+          .join('/')
+      
+        blk.call(*captures)
+      end
+      
+      super(*args, &wrapper)
+    end
+    
+    def call!(env)
+      env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] = []
+      response = super(env)
+      env['INSTANA_HTTP_PATH_TEMPLATE'] = env['INSTANA_PATH_TEMPLATE_FRAGMENTS']
+        .join('/')
+        .gsub(REPLACE_TARGET, '{\k<term>}')
+      response
+    end
+  end
+end
+
+
 if defined?(::Cuba)
   ::Instana.logger.debug "Instrumenting Cuba"
   Cuba.use ::Instana::Rack
+  Cuba.prepend ::Instana::CubaPathTemplateExtractor
 end

data/lib/instana/frameworks/instrumentation/action_controller.rb

@@ -64,6 +64,15 @@ module Instana
         end
         name
       end
+      
+      def matched_path_template
+        Rails.application.routes.router.recognize(request) do |route, _, _|
+          path = route.path
+          return path.spec.to_s
+        end
+        
+        nil
+      end
     end
 
     # Used in ActionPack versions 5 and beyond, this module provides
@@ -83,6 +92,7 @@ module Instana
         ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
 
         super(*args)
+        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
       rescue Exception => e
         ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
         raise
@@ -135,6 +145,7 @@ module Instana
         ::Instana.tracer.log_entry(:actioncontroller, kv_payload)
 
         process_action_without_instana(*args)
+        request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
       rescue Exception => e
         ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
         raise

data/lib/instana/frameworks/instrumentation/mysql2_adapter.rb

@@ -24,7 +24,13 @@ module Instana
       #
       def collect(sql)
         payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          payload[:activerecord][:sql] = sql
+        end
+
         payload[:activerecord][:adapter] = @config[:adapter]
         payload[:activerecord][:host] = @config[:host]
         payload[:activerecord][:db] = @config[:database]

data/lib/instana/frameworks/instrumentation/mysql_adapter.rb

@@ -21,7 +21,13 @@ module Instana
       #
       def collect(sql)
         payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          payload[:activerecord][:sql] = sql
+        end
+
         payload[:activerecord][:adapter] = @config[:adapter]
         payload[:activerecord][:host] = @config[:host]
         payload[:activerecord][:db] = @config[:database]

data/lib/instana/frameworks/instrumentation/postgresql_adapter.rb

@@ -17,7 +17,6 @@ module Instana
           Instana::Util.method_alias(klass, :exec_delete)
           Instana::Util.method_alias(klass, :execute)
 
-
           @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
         end
       end
@@ -27,14 +26,33 @@ module Instana
       # @param sql [String]
       # @return [Hash] Hash of collected KVs
       #
-      def collect(sql)
+      def collect(sql, binds = nil)
         payload = { :activerecord => {} }
-        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+
         payload[:activerecord][:adapter] = @config[:adapter]
         payload[:activerecord][:host] = @config[:host]
         payload[:activerecord][:db] = @config[:database]
         payload[:activerecord][:username] = @config[:username]
+
+        if ::Instana.config[:sanitize_sql]
+          payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        else
+          # No sanitization so raw SQL and collect up binds
+          payload[:activerecord][:sql] = sql
+
+          # FIXME: Only works on Rails 5 as the bind format varied in previous versions of Rails
+          if binds.is_a?(Array)
+            raw_binds = []
+            binds.each { |x| raw_binds << x.value_before_type_cast }
+            payload[:activerecord][:binds] = raw_binds
+          end
+        end
+
         payload
+      rescue Exception => e
+        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
+      ensure
+        return payload
       end
 
       # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
@@ -53,7 +71,7 @@ module Instana
           return exec_query_without_instana(sql, name, binds, *args)
         end
 
-        kv_payload = collect(sql)
+        kv_payload = collect(sql, binds)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
           exec_query_without_instana(sql, name, binds, *args)
         end
@@ -64,7 +82,7 @@ module Instana
           return exec_delete_without_instana(sql, name, binds)
         end
 
-        kv_payload = collect(sql)
+        kv_payload = collect(sql, binds)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
           exec_delete_without_instana(sql, name, binds)
         end

data/lib/instana/frameworks/roda.rb

@@ -1,6 +1,47 @@
 require "instana/rack"
 
+module Instana
+  module RodaPathTemplateExtractor
+    module RequestMethods
+      TERM = defined?(::Roda) ? ::Roda::RodaPlugins::Base::RequestMethods::TERM : Object
+      
+      def if_match(args, &blk)
+        path = @remaining_path
+        captures = @captures.clear
+  
+        if match_all(args)
+          (env['INSTANA_PATH_TEMPLATE_FRAGMENTS'] ||= []).concat(named_args(args, blk))
+          block_result(blk.(*captures))
+          env['INSTANA_HTTP_PATH_TEMPLATE'] = env['INSTANA_PATH_TEMPLATE_FRAGMENTS']
+            .join('/')
+            .prepend('/')
+          throw :halt, response.finish
+        else
+          @remaining_path = path
+          false
+        end
+      end
+      
+      def named_args(args, blk)  
+        parameters = blk.parameters      
+        args.map do |a| 
+          case a
+          when String
+            a
+          when TERM
+            nil
+          else
+            _, name = parameters.pop
+            "{#{name}}"
+          end
+        end.compact
+      end  
+    end
+  end
+end
+
 if defined?(::Roda)
   ::Instana.logger.debug "Instrumenting Roda"
   Roda.use ::Instana::Rack
+  Roda.plugin ::Instana::RodaPathTemplateExtractor
 end

data/lib/instana/frameworks/sinatra.rb

@@ -3,7 +3,24 @@ require "instana/rack"
 # This instrumentation will insert Rack into Sinatra _and_ Padrino since
 # the latter is based on Sinatra
 
+module Instana
+  module SinatraPathTemplateExtractor
+    def self.extended(base)
+      ::Instana.logger.debug "#{base} extended #{self}"
+      base.store_path_template
+    end
+    
+    def store_path_template
+      after do
+        @env["INSTANA_HTTP_PATH_TEMPLATE"] = @env["sinatra.route"]
+          .sub("#{@request.request_method} ", '')
+      end
+    end
+  end
+end
+
 if defined?(::Sinatra)
   ::Instana.logger.debug "Instrumenting Sinatra"
   ::Sinatra::Base.use ::Instana::Rack
+  ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
 end

data/lib/instana/instrumentation/excon.rb

@@ -7,7 +7,7 @@ if defined?(::Excon) && ::Instana.config[:excon][:enabled]
 
           payload = { :http => {} }
           path = datum[:path].split('?').first
-          payload[:http][:url] = "#{datum[:connection].instance_variable_get(:@socket_key)}#{path}"
+          payload[:http][:url] = ::Instana.secrets.remove_from_query("#{datum[:connection].instance_variable_get(:@socket_key)}#{path}")
           payload[:http][:method] = datum[:method] if datum.key?(:method)
 
           if datum[:pipeline] == true

data/lib/instana/instrumentation/graphql.rb

@@ -0,0 +1,77 @@
+if defined?(GraphQL::Schema) && defined?(GraphQL::Tracing::PlatformTracing) && ::Instana.config[:graphql][:enabled]
+  module Instana
+    class GraphqlTracing < GraphQL::Tracing::PlatformTracing
+      self.platform_keys = {
+        'lex' => 'lex.graphql',
+        'parse' => 'parse.graphql',
+        'validate' => 'validate.graphql',
+        'analyze_query' => 'analyze.graphql',
+        'analyze_multiplex' => 'analyze.graphql',
+        'execute_multiplex' => 'execute.graphql',
+        'execute_query' => 'execute.graphql',
+        'execute_query_lazy' => 'execute.graphql',
+      }
+      
+      def platform_trace(platform_key, key, data) 
+        return yield unless key == 'execute_query'    
+        operation = data[:query].selected_operation
+            
+        arguments = []
+        fields = []
+        
+        operation.selections.each do |field|
+          arguments.concat(walk_fields(field, :arguments))
+          fields.concat(walk_fields(field, :selections))    
+        end
+            
+        payload = {
+          operationName: data[:query].operation_name || 'anonymous',
+          operationType: operation.operation_type,
+          arguments: grouped_fields(arguments),
+          fields: grouped_fields(fields),
+        }
+                
+        begin
+          ::Instana.tracer.log_entry(:'graphql.server')
+          yield
+        rescue Exception => e
+          ::Instana.tracer.log_error(e)
+          raise e
+        ensure
+          ::Instana.tracer.log_exit(:'graphql.server', {graphql: payload})
+        end
+      end
+    
+      def platform_field_key(type, field)
+        "#{type.graphql_name}.#{field.graphql_name}"
+      end
+      
+      def platform_authorized_key(type)
+        "#{type.graphql_name}.authorized.graphql"
+      end
+
+      def platform_resolve_type_key(type)
+        "#{type.graphql_name}.resolve_type.graphql"
+      end
+      
+      private
+      
+      def walk_fields(parent, method)
+        return [] unless parent.respond_to?(method)
+        
+        parent.send(method).map do |field|
+          [{object: parent.name, field: field.name}] + walk_fields(field, method)
+        end.flatten
+      end
+      
+      def grouped_fields(fields)
+        fields
+          .group_by { |p| p[:object] }
+          .map { |name, p| [name, p.map { |f| f[:field] }] }
+          .to_h
+      end
+    end
+  end
+  
+  ::GraphQL::Schema.use(::Instana::GraphqlTracing)
+end