appoptics_apm_mnfst 4.5.2

data/lib/appoptics_apm/frameworks/rails/inst/action_controller4.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v4
+    #
+    module ActionController
+      include AppOpticsAPM::Inst::RailsBase
+
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :process_action, :appoptics
+          alias_method_chain :render, :appoptics
+        end
+      end
+
+      def process_action_with_appoptics(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name,
+        }
+        request.env['appoptics_apm.controller'] = kvs[:Controller]
+        request.env['appoptics_apm.action'] = kvs[:Action]
+
+        return process_action_without_appoptics(method_name, *args) unless AppOpticsAPM.tracing?
+        begin
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_controller][:collect_backtraces]
+
+          AppOpticsAPM::API.log_entry('rails', kvs)
+
+          process_action_without_appoptics(method_name, *args)
+
+        rescue Exception => e
+          AppOpticsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          AppOpticsAPM::API.log_exit('rails')
+        end
+      end
+    end
+  end
+end
+

data/lib/appoptics_apm/frameworks/rails/inst/action_controller5.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v5
+    #
+    module ActionController
+      include AppOpticsAPM::Inst::RailsBase
+
+      def process_action(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name,
+        }
+        request.env['appoptics_apm.controller'] = kvs[:Controller]
+        request.env['appoptics_apm.action'] = kvs[:Action]
+
+        return super(method_name, *args) unless AppOpticsAPM.tracing?
+        begin
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_controller][:collect_backtraces]
+
+          AppOpticsAPM::API.log_entry('rails', kvs)
+          super(method_name, *args)
+
+        rescue Exception => e
+          AppOpticsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          AppOpticsAPM::API.log_exit('rails')
+        end
+      end
+
+      #
+      # render
+      #
+      # Our render wrapper that calls 'trace', which will log if we are tracing
+      #
+      def render(*args, &blk)
+        trace('actionview') do
+          super(*args, &blk)
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/frameworks/rails/inst/action_controller_api.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v5.
+    #
+    module ActionControllerAPI
+      include AppOpticsAPM::Inst::RailsBase
+
+      def process_action(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name
+        }
+        request.env['appoptics_apm.controller'] = kvs[:Controller]
+        request.env['appoptics_apm.action'] = kvs[:Action]
+
+        return super(method_name, *args) unless AppOpticsAPM.tracing?
+        begin
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_controller_api][:collect_backtraces]
+
+          AppOpticsAPM::API.log_entry('rails-api', kvs)
+          super(method_name, *args)
+
+        rescue Exception => e
+          AppOpticsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          AppOpticsAPM::API.log_exit('rails-api')
+        end
+      end
+
+      #
+      # render
+      #
+      # Our render wrapper that calls 'trace', which will log if we are tracing
+      #
+      def render(*args, &blk)
+        trace('actionview') do
+          super(*args, &blk)
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/frameworks/rails/inst/action_view.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+if defined?(ActionView::Base) && AppOpticsAPM::Config[:action_view][:enabled]
+
+  ##
+  # ActionView Instrumentation is version dependent.  ActionView 2.x is separate
+  # and ActionView 3.0 is a special case.
+  # Everything else goes here. (ActionView 3.1 - 4.0 as of this writing)
+  #
+  if (Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR > 0) || Rails::VERSION::MAJOR >= 4
+
+    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting actionview' if AppOpticsAPM::Config[:verbose]
+
+    ActionView::PartialRenderer.class_eval do
+      alias :render_partial_without_appoptics :render_partial
+      def render_partial
+        entry_kvs = {}
+        begin
+          name = AppOpticsAPM::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
+          entry_kvs[:FunctionName] = :render_partial
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = :ActionView
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.profile(name, entry_kvs, AppOpticsAPM::Config[:action_view][:collect_backtraces]) do
+          render_partial_without_appoptics
+        end
+      end
+
+      alias :render_collection_without_appoptics :render_collection
+      def render_collection
+        entry_kvs = {}
+        begin
+          name = AppOpticsAPM::Util.prettify(@path)
+          entry_kvs[:FunctionName] = :render_collection
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = :ActionView
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.profile(name, entry_kvs, AppOpticsAPM::Config[:action_view][:collect_backtraces]) do
+          render_collection_without_appoptics
+        end
+      end
+
+    end
+  end
+end
+
+# vim:set expandtab:tabstop=2

data/lib/appoptics_apm/frameworks/rails/inst/action_view_30.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+if defined?(ActionView::Base) && AppOpticsAPM::Config[:action_view][:enabled]
+
+  if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
+
+    ActionView::Partials::PartialRenderer.class_eval do
+      alias :render_partial_without_appoptics :render_partial
+      def render_partial(object = @object)
+        entry_kvs = {}
+        begin
+          name  = AppOpticsAPM::Util.prettify(@options[:partial]) if @options.is_a?(Hash)
+          entry_kvs[:FunctionName] = :render_partial
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = 'ActionView::Partials'
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.profile(name, entry_kvs, AppOpticsAPM::Config[:action_view][:collect_backtraces]) do
+          render_partial_without_appoptics(object)
+        end
+      end
+
+      alias :render_collection_without_appoptics :render_collection
+      def render_collection
+        entry_kvs = {}
+        begin
+          name  = AppOpticsAPM::Util.prettify(@path)
+          entry_kvs[:FunctionName] = :render_collection
+          entry_kvs[:Class]        = :PartialRenderer
+          entry_kvs[:Module]       = 'ActionView::Partials'
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.profile(name, entry_kvs, AppOpticsAPM::Config[:action_view][:collect_backtraces]) do
+          render_collection_without_appoptics
+        end
+      end
+    end
+  end
+end
+
+# vim:set expandtab:tabstop=2

data/lib/appoptics_apm/frameworks/rails/inst/active_record.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'appoptics_apm/frameworks/rails/inst/connection_adapters/mysql'
+require 'appoptics_apm/frameworks/rails/inst/connection_adapters/mysql2'
+require 'appoptics_apm/frameworks/rails/inst/connection_adapters/postgresql'
+
+if AppOpticsAPM::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION)
+  begin
+    adapter = ActiveRecord::Base.connection_config[:adapter]
+
+    if Rails::VERSION::MAJOR < 5
+      require 'appoptics_apm/frameworks/rails/inst/connection_adapters/utils'
+    else
+      require 'appoptics_apm/frameworks/rails/inst/connection_adapters/utils5x'
+    end
+
+    AppOpticsAPM::Inst::ConnectionAdapters::FlavorInitializers.mysql      if adapter == 'mysql'
+    AppOpticsAPM::Inst::ConnectionAdapters::FlavorInitializers.mysql2     if adapter == 'mysql2'
+    AppOpticsAPM::Inst::ConnectionAdapters::FlavorInitializers.postgresql if adapter == 'postgresql'
+
+  rescue StandardError => e
+    AppOpticsAPM.logger.error "[appoptics_apm/error] AppOpticsAPM/ActiveRecord error: #{e.inspect}"
+    AppOpticsAPM.logger.debug e.backtrace.join("\n")
+  end
+end
+# vim:set expandtab:tabstop=2

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.mysql
+          AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting activerecord mysqladapter' if AppOpticsAPM::Config[:verbose]
+
+          # ActiveRecord 3.2 and higher
+          if (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 2) ||
+              ActiveRecord::VERSION::MAJOR == 4
+
+            # AbstractMysqlAdapter
+            AppOpticsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter,
+                                    AppOpticsAPM::Inst::ConnectionAdapters::Utils)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter, :execute)
+
+            # MysqlAdapter
+            AppOpticsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::MysqlAdapter,
+                                    AppOpticsAPM::Inst::ConnectionAdapters::Utils)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::MysqlAdapter, :exec_query)
+
+          else
+            # ActiveRecord 3.1 and below
+
+            # MysqlAdapter
+            AppOpticsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::MysqlAdapter,
+                                    AppOpticsAPM::Inst::ConnectionAdapters::Utils)
+
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::MysqlAdapter, :execute)
+
+            if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 1
+              AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::MysqlAdapter, :begin_db_transaction)
+              AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::MysqlAdapter, :exec_delete)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql2.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.mysql2
+          AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting activerecord mysql2adapter' if AppOpticsAPM::Config[:verbose]
+
+          AppOpticsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::Mysql2Adapter,
+                                  AppOpticsAPM::Inst::ConnectionAdapters::Utils)
+
+          if (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0) ||
+              ActiveRecord::VERSION::MAJOR == 2
+            # ActiveRecord 3.0 and prior
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::Mysql2Adapter, :execute)
+          else
+            # ActiveRecord 3.1 and above
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_insert)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_query)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_update)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::Mysql2Adapter, :exec_delete)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/postgresql.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module ConnectionAdapters
+      module FlavorInitializers
+        def self.postgresql
+
+          AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting activerecord postgresqladapter' if AppOpticsAPM::Config[:verbose]
+
+          AppOpticsAPM::Util.send_include(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter,
+                                  AppOpticsAPM::Inst::ConnectionAdapters::Utils)
+
+          if (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR > 0) ||
+                ActiveRecord::VERSION::MAJOR >= 4
+
+            # ActiveRecord 3.1 and up
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_query)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_update)
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :exec_delete)
+
+          else
+            # ActiveRecord 3.0 and prior
+            AppOpticsAPM::Util.method_alias(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter, :execute)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/utils.rb

@@ -0,0 +1,119 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module ConnectionAdapters
+      module Utils
+
+        def extract_trace_details(sql, name = nil, binds = [])
+          opts = {}
+          if AppOpticsAPM::Config[:sanitize_sql]
+            # Sanitize SQL and don't report binds
+            opts[:Query] = AppOpticsAPM::Util.sanitize_sql(sql)
+          else
+            # Report raw SQL and any binds if they exist
+            opts[:Query] = sql.to_s
+            opts[:QueryArgs] = binds.map { |col, val| [col.name, val.to_s] } unless binds.empty?
+          end
+
+          opts[:Name] = name.to_s if name
+          opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:active_record][:collect_backtraces]
+
+          config = ActiveRecord::Base.connection_config
+          if config
+            opts[:Database]   = config[:database] if config.key?(:database)
+            opts[:RemoteHost] = config[:host]     if config.key?(:host)
+            adapter_name = config[:adapter]
+
+            case adapter_name
+            when /mysql/i
+              opts[:Flavor] = 'mysql'
+            when /postgres/i
+              opts[:Flavor] = 'postgresql'
+            end
+          end
+        rescue StandardError => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/rails] Exception raised capturing ActiveRecord KVs: #{e.inspect}"
+          AppOpticsAPM.logger.debug e.backtrace.join('\n')
+        ensure
+          return opts
+        end
+
+        # We don't want to trace framework caches.  Only instrument SQL that
+        # directly hits the database.
+        def ignore_payload?(name)
+          %w(SCHEMA EXPLAIN CACHE).include?(name.to_s) ||
+            (name && name.to_sym == :skip_logging) ||
+            name == 'ActiveRecord::SchemaMigration Load'
+        end
+
+        def execute_with_appoptics(sql, name = nil)
+          if AppOpticsAPM.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name)
+            AppOpticsAPM::API.trace('activerecord', opts, :ar_started) do
+              execute_without_appoptics(sql, name)
+            end
+          else
+            execute_without_appoptics(sql, name)
+          end
+        end
+
+        def exec_query_with_appoptics(sql, name = nil, binds = [])
+          if AppOpticsAPM.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            AppOpticsAPM::API.trace('activerecord', opts, :ar_started) do
+              exec_query_without_appoptics(sql, name, binds)
+            end
+          else
+            exec_query_without_appoptics(sql, name, binds)
+          end
+        end
+
+        def exec_delete_with_appoptics(sql, name = nil, binds = [])
+          if AppOpticsAPM.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            AppOpticsAPM::API.trace('activerecord', opts, :ar_started) do
+              exec_delete_without_appoptics(sql, name, binds)
+            end
+          else
+            exec_delete_without_appoptics(sql, name, binds)
+          end
+        end
+
+        def exec_update_with_appoptics(sql, name = nil, binds = [])
+          if AppOpticsAPM.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            AppOpticsAPM::API.trace('activerecord', opts, :ar_started) do
+              exec_update_without_appoptics(sql, name, binds)
+            end
+          else
+            exec_update_without_appoptics(sql, name, binds)
+          end
+        end
+
+        def exec_insert_with_appoptics(sql, name = nil, binds = [], *args)
+          if AppOpticsAPM.tracing? && !ignore_payload?(name)
+
+            opts = extract_trace_details(sql, name, binds)
+            AppOpticsAPM::API.trace('activerecord', opts, :ar_started) do
+              exec_insert_without_appoptics(sql, name, binds, *args)
+            end
+          else
+            exec_insert_without_appoptics(sql, name, binds, *args)
+          end
+        end
+
+        def begin_db_transaction_with_appoptics
+          AppOpticsAPM::API.trace('activerecord', { :Query => 'BEGIN', :Flavor => :mysql }, :ar_started) do
+            begin_db_transaction_without_appoptics
+          end
+        end
+      end # Utils
+    end
+  end
+end