instana 1.1.0 → 1.2.0

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

@@ -0,0 +1,105 @@
+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?
+        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
+    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)
+      rescue Exception => e
+        ::Instana.tracer.log_error(e) unless has_rails_handler?
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:actioncontroller)
+      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
+        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)
+      rescue Exception => e
+        ::Instana.tracer.log_error(e) unless has_rails_handler?
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:actioncontroller)
+      end
+    end
+  end
+end
+
+if defined?(::ActionController) && ::Instana.config[:action_controller][:enabled] && ::ActionPack::VERSION::MAJOR >= 2
+  ::Instana.logger.warn "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.warn "Instrumenting ActionController API"
+  ::ActionController::API.send(:prepend, ::Instana::Instrumentation::ActionController)
+end

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

@@ -0,0 +1,22 @@
+
+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]
+  case ActiveRecord::Base.connection.adapter_name.downcase
+  when 'mysql'
+    ::Instana.logger.warn "Instrumenting ActiveRecord (mysql)"
+    ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, ::Instana::Instrumentation::MysqlAdapter)
+    ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.send(:include, ::Instana::Instrumentation::AbstractMysqlAdapter)
+  when 'mysql2'
+    ::Instana.logger.warn "Instrumenting ActiveRecord (mysql2)"
+    ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, ::Instana::Instrumentation::Mysql2Adapter)
+  when 'postgresql'
+    ::Instana.logger.warn "Instrumenting ActiveRecord (postgresql)"
+    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:include, ::Instana::Instrumentation::PostgreSQLAdapter)
+  else
+    ::Instana.logger.warn "Unsupported ActiveRecord adapter: #{ActiveRecord::Base.connection.adapter_name.downcase}"
+  end
+end

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

@@ -0,0 +1,81 @@
+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.included(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
+
+      # 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 exec_delete_with_instana(sql, name = nil, binds = [])
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
+          return exec_delete_without_instana(sql, name, binds)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_delete_without_instana(sql, name, binds)
+        end
+      end
+
+      def exec_insert_with_instana(sql, name = 'SQL', binds = [], *args)
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
+          return exec_insert_without_instana(sql, name, binds, *args)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_insert_without_instana(sql, name, binds, *args)
+        end
+      end
+
+      def exec_query_with_instana(sql, name = 'SQL', binds = [], *args)
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
+            ::Instana.tracer.current_span_name?(:activerecord)
+          return exec_query_without_instana(sql, name, binds, *args)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_query_without_instana(sql, name, binds, *args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+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.included(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
+
+      # 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 exec_query_with_instana(sql, name = 'SQL', binds = [], *args)
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql) ||
+            ::Instana.tracer.current_span_name?(:activerecord)
+          return exec_query_without_instana(sql, name, binds, *args)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_query_without_instana(sql, name, binds, *args)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Instana
+  module Instrumentation
+    module PostgreSQLAdapter
+      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 postgresql adapter.  Only
+      # versions >= 3.1 are supported.
+      #
+      def self.included(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)
+
+          @@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 exec_query_with_instana(sql, name = 'SQL', binds = [], *args)
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
+          return exec_query_without_instana(sql, name, binds, *args)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_query_without_instana(sql, name, binds, *args)
+        end
+      end
+
+      def exec_delete_with_instana(sql, name = nil, binds = [])
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
+          return exec_delete_without_instana(sql, name, binds)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          exec_delete_without_instana(sql, name, binds)
+        end
+      end
+    end
+  end
+end

data/lib/instana/frameworks/rails.rb

@@ -16,6 +16,11 @@ if defined?(::Rails)
           ::Instana.logger.warn "Instrumenting Rack"
           app.config.middleware.insert 0, ::Instana::Rack
         end
+
+        config.after_initialize do
+          require "instana/frameworks/instrumentation/active_record"
+          require "instana/frameworks/instrumentation/action_controller"
+        end
       end
     end
   end

data/lib/instana/test.rb

@@ -0,0 +1,40 @@
+module Instana
+  class Test
+    class << self
+      # Used at the start of the test suite to configure required environment
+      # variables (if missing)
+      #
+      def setup_environment
+        # Set defaults if not set
+        ENV['MEMCACHED_HOST']     ||= '127.0.0.1:11211'
+        ENV['TRAVIS_PSQL_HOST']   ||= "127.0.0.1"
+        ENV['TRAVIS_PSQL_USER']   ||= "postgres"
+        ENV['TRAVIS_MYSQL_HOST']  ||= "127.0.0.1"
+        ENV['TRAVIS_MYSQL_USER']  ||= "root"
+
+        if ENV['DB_FLAVOR'] == 'mysql2'
+          ENV['DATABASE_URL'] = "mysql2://#{ENV['TRAVIS_MYSQL_USER']}:#{ENV['TRAVIS_MYSQL_PASS']}@#{ENV['TRAVIS_MYSQL_HOST']}:3306/travis_ci_test"
+        elsif ENV['DB_FLAVOR'] == 'mysql'
+          ENV['DATABASE_URL'] = "mysql://#{ENV['TRAVIS_MYSQL_USER']}:#{ENV['TRAVIS_MYSQL_PASS']}@#{ENV['TRAVIS_MYSQL_HOST']}:3306/travis_ci_test"
+        else
+          ENV['DB_FLAVOR'] ||= 'postgresql'
+          ENV['DATABASE_URL'] = "postgresql://#{ENV['TRAVIS_PSQL_USER']}:#{ENV['TRAVIS_PSQL_PASS']}@#{ENV['TRAVIS_PSQL_HOST']}:5432/travis_ci_test"
+        end
+
+        Instana.logger.warn "Database connect string configured to: #{ENV['DATABASE_URL']}"
+      end
+
+      def postgresql?
+        ENV['DB_FLAVOR'] == 'postgresql'
+      end
+
+      def mysql2?
+        ENV['DB_FLAVOR'] == 'mysql2'
+      end
+
+      def mysql?
+        ENV['DB_FLAVOR'] == 'mysql'
+      end
+    end
+  end
+end

data/lib/instana/tracer.rb

@@ -116,6 +116,13 @@ module Instana
     #
     def log_exit(name, kvs = {})
       return unless tracing?
+
+      if ::Instana.debug? || ::Instana.test?
+        unless current_span_name?(name)
+          ::Instana.logger.debug "Span mismatch: Attempt to exit #{name} span but #{current_span.name} is active."
+        end
+      end
+
       self.current_trace.end_span(kvs)
     end
 
@@ -131,6 +138,12 @@ module Instana
     def log_end(name, kvs = {}, end_time = Time.now)
       return unless tracing?
 
+      if ::Instana.debug? || ::Instana.test?
+        unless current_span_name?(name)
+          ::Instana.logger.debug "Span mismatch: Attempt to end #{name} span but #{current_span.name} is active."
+        end
+      end
+
       self.current_trace.finish(kvs, end_time)
 
       if !self.current_trace.has_async? ||
@@ -369,6 +382,12 @@ module Instana
       self.current_trace ? self.current_trace.current_span : nil
     end
 
+    # Indicates if the name of the current span matches <candidate>
+    #
+    def current_span_name?(candidate)
+      self.current_trace &&  self.current_trace.current_span.name == candidate
+    end
+
     # Used in the test suite, this resets the tracer to non-tracing state.
     #
     def clear!

data/lib/instana/tracing/span.rb

@@ -1,8 +1,8 @@
 module Instana
   class Span
-    REGISTERED_SPANS = [ :rack, :'net-http', :excon, :memcache ].freeze
+    REGISTERED_SPANS = [ :actioncontroller, :activerecord, :excon, :memcache, :'net-http', :rack ].freeze
     ENTRY_SPANS = [ :rack ].freeze
-    EXIT_SPANS = [ :'net-http', :excon ].freeze
+    EXIT_SPANS = [ :'net-http', :excon, :activerecord ].freeze
     HTTP_SPANS = ENTRY_SPANS + EXIT_SPANS
 
     attr_accessor :parent
@@ -90,7 +90,7 @@ module Instana
         if HTTP_SPANS.include?(@data[:n])
           set_tags(:http => { :error => "#{e.class}: #{e.message}" })
         else
-          set_tags(:log => { :message => e.message, :parameters => e.class })
+          set_tags(:log => { :message => e.message, :parameters => e.class.to_s })
         end
         e.instance_variable_set(:@instana_logged, true)
       end