instana 1.193.3.pre1 → 1.195.0

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

@@ -1,56 +0,0 @@
-module Instana
-  module Instrumentation
-    module AbstractMysqlAdapter
-      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE).freeze
-      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i
-
-      # This module supports instrumenting ActiveRecord with the mysql2 adapter.
-      #
-      def self.prepended(klass)
-        if ActiveRecord::VERSION::STRING >= '3.2'
-          @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
-        end
-      end
-
-      # Collect up this DB connection info for reporting.
-      #
-      # @param sql [String]
-      # @return [Hash] Hash of collected KVs
-      #
-      def collect(sql)
-        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]
-        payload
-      end
-
-      # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
-      # only certain calls that we're interested in tracing.  e.g. No use to instrument
-      # framework caches.
-      #
-      # @param payload [String]
-      # @return [Boolean]
-      #
-      def ignore_payload?(name, sql)
-        IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
-      end
-
-      def execute(sql, name = nil)
-        tracing = ::Instana.tracer.tracing?
-        if !tracing || ignore_payload?(name, sql)
-          return super(sql, name)
-        elsif ::Instana.tracer.current_span[:n] == :activerecord
-          return super(sql, name)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name)
-        end
-      end
-    end
-  end
-end

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

@@ -1,194 +0,0 @@
-module Instana
-  module Instrumentation
-
-    # Contains the methods common to both ::Instana::Instrumentation::ActionController
-    # and ::Instana::Instrumentation::ActionControllerLegacy
-    #
-    module ActionControllerCommon
-
-      # Indicates whether a Controller rescue handler is in place.  If so, this affects
-      # error logging and reporting. (Hence the need for this method).
-      #
-      # @return [Boolean]
-      #
-      def has_rails_handler?(exception)
-        found = false
-        rescue_handlers.detect do |klass_name, _handler|
-          # Rescue handlers can be specified as strings or constant names
-          klass = self.class.const_get(klass_name) rescue nil
-          klass ||= klass_name.constantize rescue nil
-          found = exception.is_a?(klass) if klass
-        end
-        found
-      rescue => e
-        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
-        return false
-      end
-
-      # Render can be called with many options across the various supported
-      # versions of Rails.  This method attempts to make sense and provide
-      # insight into what is happening (rendering a layout, file, nothing,
-      # plaintext etc.)
-      def get_render_topic(opts)
-        if opts.key?(:layout)
-          case opts[:layout]
-          when FalseClass
-            name = "Without layout"
-          when String
-            name = opts[:layout]
-          when Proc
-            name = "Proc"
-          else
-            name = "Default"
-          end
-        end
-
-        return name if name
-
-        if opts.key?(:template)
-          name ||= opts[:template]
-        elsif opts.key?(:file)
-          name ||= opts[:file]
-        elsif opts.key?(:nothing)
-          name = "Nothing"
-        elsif opts.key?(:plain)
-          name = "Plaintext"
-        elsif opts.key?(:json)
-          name = "JSON"
-        elsif opts.key?(:xml)
-          name = "XML"
-        elsif opts.key?(:body)
-          name = "Raw"
-        elsif opts.key?(:js)
-          name = "Javascript"
-        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
-    # instrumentation for ActionController (a part of ActionPack)
-    #
-    module ActionController
-      include ::Instana::Instrumentation::ActionControllerCommon
-
-      # This is the Rails 5 version of the process_action method where we use prepend to
-      # instrument the class method instead of using the older alias_method_chain.
-      #
-      def process_action(*args)
-        kv_payload = { :actioncontroller => {} }
-        kv_payload[:actioncontroller][:controller] = self.class.name
-        kv_payload[:actioncontroller][:action] = action_name
-
-        ::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
-      ensure
-        ::Instana.tracer.log_exit(:actioncontroller)
-      end
-
-      # The Instana wrapper method for ActionController::Base.render
-      # for versions 5+.
-      #
-      def render(*args, &blk)
-        # Figure out what's being rendered
-        if args.length > 0 && args[0].is_a?(Hash)
-          name = get_render_topic(args[0])
-        end
-        name ||= "Default"
-
-        ::Instana.tracer.log_entry(:actionview, :actionview => { :name => name })
-
-        super(*args, &blk)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actionview)
-      end
-    end
-
-    # Used in ActionPack versions 4 and earlier, this module provides
-    # instrumentation for ActionController (a part of ActionPack)
-    #
-    module ActionControllerLegacy
-      include ::Instana::Instrumentation::ActionControllerCommon
-
-      def self.included(klass)
-        klass.class_eval do
-          alias_method_chain :process_action, :instana
-          alias_method_chain :render, :instana
-        end
-      end
-
-      # The Instana wrapper method for ActionController::Base.process_action
-      # for versions 3 and 4.
-      #
-      def process_action_with_instana(*args)
-        kv_payload = { :actioncontroller => {} }
-        kv_payload[:actioncontroller][:controller] = self.class.name
-        kv_payload[:actioncontroller][:action] = action_name
-
-        ::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
-      ensure
-        ::Instana.tracer.log_exit(:actioncontroller)
-      end
-
-      # The Instana wrapper method for ActionController::Base.render
-      # for versions 3 and 4.
-      #
-      def render_with_instana(*args, &blk)
-        if args.length > 0 && args[0].is_a?(Hash)
-          name = get_render_topic(args[0])
-        end
-        name ||= "Default"
-        ::Instana.tracer.log_entry(:actionview, :actionview => { :name => name })
-        render_without_instana(*args, &blk)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e) unless has_rails_handler?(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:actionview)
-      end
-    end
-  end
-end
-
-if defined?(::ActionController) && ::Instana.config[:action_controller][:enabled] && ::ActionPack::VERSION::MAJOR >= 2
-  ::Instana.logger.debug "Instrumenting ActionController"
-  if ActionPack::VERSION::MAJOR >= 5
-    ::ActionController::Base.send(:prepend, ::Instana::Instrumentation::ActionController)
-  else
-    ::ActionController::Base.send(:include, ::Instana::Instrumentation::ActionControllerLegacy)
-  end
-end
-
-# ActionController::API was introduced in Ruby on Rails 5 but was originally an independent project before being
-# rolled into the Rails ActionPack.  In case, someone is using the independent project or potentially backported
-# the rails version to and older Ruby on Rails version, we only limit in a minimal way re: version checking.
-#
-# We allow ActionController::API instrumentation in version of Ruby on Rails 3 and higher.
-#
-if defined?(::ActionController::API) && ::Instana.config[:action_controller][:enabled] && ::ActionPack::VERSION::MAJOR >= 3
-  ::Instana.logger.debug "Instrumenting ActionController API"
-  ::ActionController::API.send(:prepend, ::Instana::Instrumentation::ActionController)
-end

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

@@ -1,39 +0,0 @@
-module Instana
-  module Instrumentation
-    module ActionViewRenderer
-      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)
-        super(*args)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:render)
-      end
-
-      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)
-        super(*args)
-      rescue Exception => e
-        ::Instana.tracer.log_error(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:render)
-      end
-    end
-  end
-end
-
-if defined?(::ActionView) && ::Instana.config[:action_view][:enabled] && ::ActionPack::VERSION::STRING >= '3.1'
-  ::Instana.logger.debug "Instrumenting ActionView"
-  ::ActionView::PartialRenderer.send(:prepend, ::Instana::Instrumentation::ActionViewRenderer)
-end

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

@@ -1,27 +0,0 @@
-
-require "instana/frameworks/instrumentation/mysql_adapter"
-require "instana/frameworks/instrumentation/abstract_mysql_adapter"
-require "instana/frameworks/instrumentation/mysql2_adapter"
-require "instana/frameworks/instrumentation/postgresql_adapter"
-
-if defined?(::ActiveRecord) && ::Instana.config[:active_record][:enabled]
-
-  # Mysql
-  if defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
-    ::Instana.logger.debug "Instrumenting ActiveRecord (mysql)"
-    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(:prepend, ::Instana::Instrumentation::Mysql2Adapter)
-  end
-
-  # Postgres
-  if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-    ::Instana.logger.debug "Instrumenting ActiveRecord (postgresql)"
-    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:prepend, ::Instana::Instrumentation::PostgreSQLAdapter)
-  end
-end

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

@@ -1,83 +0,0 @@
-module Instana
-  module Instrumentation
-    module Mysql2Adapter
-      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE).freeze
-      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i
-
-      # This module supports instrumenting ActiveRecord with the mysql2 adapter.
-      #
-      def self.prepended(klass)
-        # ActiveRecord 3.1 and up only (for now possibly)
-        if ActiveRecord::VERSION::STRING > '3.0'
-          @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
-        end
-      end
-
-      # Collect up this DB connection info for reporting.
-      #
-      # @param sql [String]
-      # @return [Hash] Hash of collected KVs
-      #
-      def collect(sql)
-        payload = { :activerecord => {} }
-
-        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]
-        payload[:activerecord][:username] = @config[:username]
-        payload
-      end
-
-      # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
-      # only certain calls that we're interested in tracing.  e.g. No use to instrument
-      # framework caches.
-      #
-      # @param payload [String]
-      # @return [Boolean]
-      #
-      def ignore_payload?(name, sql)
-        IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
-      end
-
-      def exec_delete(sql, name = nil, binds = [])
-        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
-          return super(sql, name, binds)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name, binds)
-        end
-      end
-
-      def exec_insert(sql, name = 'SQL', binds = [], *args)
-        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
-          return super(sql, name, binds, *args)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name, binds, *args)
-        end
-      end
-
-      def exec_query(sql, name = 'SQL', binds = [], *args)
-        if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
-            ::Instana.tracer.current_span[:n] == :activerecord
-          return super(sql, name, binds, *args)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name, binds, *args)
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-module Instana
-  module Instrumentation
-    module MysqlAdapter
-      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE).freeze
-      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i
-
-      # This module supports instrumenting ActiveRecord with the mysql2 adapter.
-      #
-      def self.prepended(klass)
-        if ActiveRecord::VERSION::STRING >= '3.2'
-          @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
-        end
-      end
-
-      # Collect up this DB connection info for reporting.
-      #
-      # @param sql [String]
-      # @return [Hash] Hash of collected KVs
-      #
-      def collect(sql)
-        payload = { :activerecord => {} }
-
-        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]
-        payload[:activerecord][:username] = @config[:username]
-        payload
-      end
-
-      # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
-      # only certain calls that we're interested in tracing.  e.g. No use to instrument
-      # framework caches.
-      #
-      # @param payload [String]
-      # @return [Boolean]
-      #
-      def ignore_payload?(name, sql)
-        IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
-      end
-
-      def exec_query(sql, name = 'SQL', binds = [], *args)
-        if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
-            ::Instana.tracer.current_span[:n] == :activerecord
-          return super(sql, name, binds, *args)
-        end
-
-        kv_payload = collect(sql)
-        ::Instana.tracer.trace(:activerecord, kv_payload) do
-          super(sql, name, binds, *args)
-        end
-      end
-    end
-  end
-end