instana 1.11.8 → 1.193.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03473a7a2f7e8a5306869674ff671f1d5b66804e41bd1f687c512a33c0b07f3c
-  data.tar.gz: aaf1ada0116589a5d33e1f74558a6c32801971e5f5f4e512be56ff6524ab447b
+  metadata.gz: 26ea11d0efe2f26610441700b71bc9c2abd4192566a86d00089d1e889d8457d3
+  data.tar.gz: 5dde944418b1f34391c08114692b4f34d27acc8328e0d7bd47c7b14834e21d61
 SHA512:
-  metadata.gz: 6993a2dcb47b648445c97fea1017bcc9392f889270613078fd32fb2881365d88260ae0082e23eed6f32f9d111f67021dc9f2485f5cb4777b6317b7541352d40d
-  data.tar.gz: 5c8c34a422def00edda43e613899a59b99bae6c1cf1323d79c135703b1c6ab5d565ece30f8b8f0497e0ea79a7cf1585912c17ddf5e8c363cb33f792e6f7a6903
+  metadata.gz: 11c700d01ab267b978d527dd9fcc993b5ae19bb659074690ced25b12f34d1b58c850c241776b3c8932a274138170d885e7f9a0c28b430bc382a81c0df3b99451
+  data.tar.gz: 8e4dd40a1d9f87e00905eca337189870f3e8237ce33b3be80853d85e7b11667243fe1e5ca7c6e126b492e0c2ba5d404257bfa908e50984f40d184a65f1067239

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/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/abstract_mysql_adapter.rb

@@ -6,10 +6,8 @@ module Instana
 
       # This module supports instrumenting ActiveRecord with the mysql2 adapter.
       #
-      def self.included(klass)
+      def self.prepended(klass)
         if ActiveRecord::VERSION::STRING >= '3.2'
-          Instana::Util.method_alias(klass, :execute)
-
           @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
         end
       end
@@ -40,17 +38,17 @@ module Instana
         IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
       end
 
-      def execute_with_instana(sql, name = nil)
+      def execute(sql, name = nil)
         tracing = ::Instana.tracer.tracing?
         if !tracing || ignore_payload?(name, sql)
-          return execute_without_instana(sql, name)
+          return super(sql, name)
         elsif ::Instana.tracer.current_span[:n] == :activerecord
-          return execute_without_instana(sql, name)
+          return super(sql, name)
         end
 
         kv_payload = collect(sql)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          execute_without_instana(sql, name)
+          super(sql, name)
         end
       end
     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/action_view.rb

@@ -1,18 +1,13 @@
 module Instana
   module Instrumentation
     module ActionViewRenderer
-      def self.included(klass)
-        ::Instana::Util.method_alias(klass, :render_partial)
-        ::Instana::Util.method_alias(klass, :render_collection)
-      end
-
-      def render_partial_with_instana(*args)
+      def render_partial(*args)
         kv_payload = { :render => {} }
         kv_payload[:render][:type] = :partial
         kv_payload[:render][:name] = @options[:partial].to_s if @options.is_a?(Hash)
 
         ::Instana.tracer.log_entry(:render, kv_payload)
-        render_partial_without_instana(*args)
+        super(*args)
       rescue Exception => e
         ::Instana.tracer.log_error(e)
         raise
@@ -20,13 +15,14 @@ module Instana
         ::Instana.tracer.log_exit(:render)
       end
 
-      def render_collection_with_instana(*args)
+      def render_collection(*args)
+        puts 'called'
         kv_payload = { :render => {} }
         kv_payload[:render][:type] = :collection
         kv_payload[:render][:name] = @path.to_s
 
         ::Instana.tracer.log_entry(:render, kv_payload)
-        render_collection_without_instana(*args)
+        super(*args)
       rescue Exception => e
         ::Instana.tracer.log_error(e)
         raise
@@ -39,5 +35,5 @@ end
 
 if defined?(::ActionView) && ::Instana.config[:action_view][:enabled] && ::ActionPack::VERSION::STRING >= '3.1'
   ::Instana.logger.debug "Instrumenting ActionView"
-  ::ActionView::PartialRenderer.send(:include, ::Instana::Instrumentation::ActionViewRenderer)
+  ::ActionView::PartialRenderer.send(:prepend, ::Instana::Instrumentation::ActionViewRenderer)
 end

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

@@ -9,19 +9,19 @@ if defined?(::ActiveRecord) && ::Instana.config[:active_record][:enabled]
   # Mysql
   if defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
     ::Instana.logger.debug "Instrumenting ActiveRecord (mysql)"
-    ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, ::Instana::Instrumentation::MysqlAdapter)
-    ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.send(:include, ::Instana::Instrumentation::AbstractMysqlAdapter)
+    ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:prepend, ::Instana::Instrumentation::MysqlAdapter)
+    ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.send(:prepend, ::Instana::Instrumentation::AbstractMysqlAdapter)
   end
 
   # Mysql2
   if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
     ::Instana.logger.debug "Instrumenting ActiveRecord (mysql2)"
-    ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, ::Instana::Instrumentation::Mysql2Adapter)
+    ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:prepend, ::Instana::Instrumentation::Mysql2Adapter)
   end
 
   # Postgres
   if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
     ::Instana.logger.debug "Instrumenting ActiveRecord (postgresql)"
-    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:include, ::Instana::Instrumentation::PostgreSQLAdapter)
+    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:prepend, ::Instana::Instrumentation::PostgreSQLAdapter)
   end
 end

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

@@ -6,13 +6,9 @@ module Instana
 
       # This module supports instrumenting ActiveRecord with the mysql2 adapter.
       #
-      def self.included(klass)
+      def self.prepended(klass)
         # ActiveRecord 3.1 and up only (for now possibly)
         if ActiveRecord::VERSION::STRING > '3.0'
-          Instana::Util.method_alias(klass, :exec_delete)
-          Instana::Util.method_alias(klass, :exec_insert)
-          Instana::Util.method_alias(klass, :exec_query)
-
           @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
         end
       end
@@ -24,7 +20,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]
@@ -43,37 +45,37 @@ module Instana
         IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
       end
 
-      def exec_delete_with_instana(sql, name = nil, binds = [])
+      def exec_delete(sql, name = nil, binds = [])
         if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
-          return exec_delete_without_instana(sql, name, binds)
+          return super(sql, name, binds)
         end
 
         kv_payload = collect(sql)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          exec_delete_without_instana(sql, name, binds)
+          super(sql, name, binds)
         end
       end
 
-      def exec_insert_with_instana(sql, name = 'SQL', binds = [], *args)
+      def exec_insert(sql, name = 'SQL', binds = [], *args)
         if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
-          return exec_insert_without_instana(sql, name, binds, *args)
+          return super(sql, name, binds, *args)
         end
 
         kv_payload = collect(sql)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          exec_insert_without_instana(sql, name, binds, *args)
+          super(sql, name, binds, *args)
         end
       end
 
-      def exec_query_with_instana(sql, name = 'SQL', binds = [], *args)
+      def exec_query(sql, name = 'SQL', binds = [], *args)
         if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
             ::Instana.tracer.current_span[:n] == :activerecord
-          return exec_query_without_instana(sql, name, binds, *args)
+          return super(sql, name, binds, *args)
         end
 
         kv_payload = collect(sql)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          exec_query_without_instana(sql, name, binds, *args)
+          super(sql, name, binds, *args)
         end
       end
     end

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

@@ -6,10 +6,8 @@ module Instana
 
       # This module supports instrumenting ActiveRecord with the mysql2 adapter.
       #
-      def self.included(klass)
+      def self.prepended(klass)
         if ActiveRecord::VERSION::STRING >= '3.2'
-          Instana::Util.method_alias(klass, :exec_query)
-
           @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
         end
       end
@@ -21,7 +19,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]
@@ -40,15 +44,15 @@ module Instana
         IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
       end
 
-      def exec_query_with_instana(sql, name = 'SQL', binds = [], *args)
+      def exec_query(sql, name = 'SQL', binds = [], *args)
         if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
             ::Instana.tracer.current_span[:n] == :activerecord
-          return exec_query_without_instana(sql, name, binds, *args)
+          return super(sql, name, binds, *args)
         end
 
         kv_payload = collect(sql)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          exec_query_without_instana(sql, name, binds, *args)
+          super(sql, name, binds, *args)
         end
       end
     end