instana 1.12.0 → 1.193.3.pre1

data/lib/instana/activators/rest_client.rb

@@ -0,0 +1,17 @@
+module Instana
+  module Activators
+    class RestClient < Activator
+      def can_instrument?
+        defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/rest-client'
+
+        ::RestClient::Request.prepend ::Instana::Instrumentation::RestClientRequest
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/roda.rb

@@ -0,0 +1,18 @@
+module Instana
+  module Activators
+    class Roda < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Roda)
+      end
+
+      def instrument
+        require 'instana/frameworks/roda'
+
+        ::Roda.use ::Instana::Rack
+        ::Roda.plugin ::Instana::RodaPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_client.rb

@@ -0,0 +1,21 @@
+module Instana
+  module Activators
+    class SidekiqClient < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Instana.config[:'sidekiq-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-client'
+
+        ::Sidekiq.configure_client do |cfg|
+          cfg.client_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqClient
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_worker.rb

@@ -0,0 +1,21 @@
+module Instana
+  module Activators
+    class SidekiqWorker < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Instana.config[:'sidekiq-worker'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-worker'
+
+        ::Sidekiq.configure_server do |cfg|
+          cfg.server_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqWorker
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sinatra.rb

@@ -0,0 +1,18 @@
+module Instana
+  module Activators
+    class Sinatra < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Sinatra)
+      end
+
+      def instrument
+        require 'instana/frameworks/sinatra'
+
+        ::Sinatra::Base.use ::Instana::Rack
+        ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

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

@@ -3,23 +3,23 @@ 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) 
+
+    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)
@@ -30,10 +30,3 @@ module Instana
     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_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

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

@@ -8,16 +8,11 @@ module Instana
       # This module supports instrumenting ActiveRecord with the postgresql adapter.  Only
       # versions >= 3.1 are supported.
       #
-      def self.included(klass)
+      def self.prepended(klass)
         if (::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR > 0) ||
              ::ActiveRecord::VERSION::MAJOR >= 4
 
           # ActiveRecord 3.1 and up
-          Instana::Util.method_alias(klass, :exec_query)
-          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 +22,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
@@ -48,36 +62,36 @@ module Instana
         IGNORED_PAYLOADS.include?(name) || IGNORED_SQL.include?(sql)
       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)
-          return exec_query_without_instana(sql, name, binds, *args)
+          return super(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)
+          super(sql, name, binds, *args)
         end
       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)
+        kv_payload = collect(sql, binds)
         ::Instana.tracer.trace(:activerecord, kv_payload) do
-          exec_delete_without_instana(sql, name, binds)
+          super(sql, name, binds)
         end
       end
 
-      def execute_with_instana(sql, name = nil)
+      def execute(sql, name = nil)
         if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
-          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