scout_apm 3.0.0.pre10 → 3.0.0.pre11

data/lib/scout_apm/background_recorder.rb

@@ -0,0 +1,43 @@
+# Provide a background thread queue to do the processing of
+# TrackedRequest objects, to remove it from the hot-path of returning a
+# web response
+
+module ScoutApm
+  class BackgroundRecorder
+    attr_reader :queue
+    attr_reader :thread
+    attr_reader :logger
+
+    def initialize(logger)
+      @logger = logger
+      @queue = Queue.new
+    end
+
+    def start
+      logger.info("Starting BackgroundRecorder")
+      @thread = Thread.new(&method(:thread_func))
+      self
+    end
+
+    def stop
+      @thread.kill
+    end
+
+    def record!(request)
+      start unless @thread.alive?
+      @queue.push(request)
+    end
+
+    def thread_func
+      while req = queue.pop
+        begin
+          logger.debug("recording in thread. Queue size: #{queue.size}")
+          # For now, just proxy right back into the TrackedRequest object's record function
+          req.record!
+        rescue => e
+          logger.warn("Error in BackgroundRecorder - #{e.message} : #{e.backtrace}")
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/background_worker.rb

@@ -36,12 +36,6 @@ module ScoutApm
 
       loop do
         begin
-          # Bail out if @keep_running is false
-          unless @keep_running
-            ScoutApm::Agent.instance.logger.debug "Background Worker: breaking from loop"
-            break
-          end
-
           now = Time.now
 
           # Sleep the correct amount of time to reach next_time
@@ -51,6 +45,12 @@ module ScoutApm
             now = Time.now
           end
 
+          # Bail out if @keep_running is false
+          unless @keep_running
+            ScoutApm::Agent.instance.logger.debug "Background Worker: breaking from loop"
+            break
+          end
+
           @task.call
 
           # Adjust the next time to run forward by @periods until it is in the future

data/lib/scout_apm/config.rb

@@ -25,7 +25,10 @@ require 'scout_apm/environment'
 # profile          - turn on/off scoutprof (only applicable in Gem versions including scoutprof)
 # proxy            - an http proxy
 # report_format    - 'json' or 'marshal'. Marshal is legacy and will be removed.
+# scm_subdirectory - if the app root lives in source management in a subdirectory. E.g. #{SCM_ROOT}/src
 # uri_reporting    - 'path' or 'full_path' default is 'full_path', which reports URL params as well as the path.
+# remote_agent_host - Internal: What host to bind to, and also send messages to for remote. Default: 127.0.0.1.
+# remote_agent_port - What port to bind the remote webserver to
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -34,6 +37,7 @@ module ScoutApm
   class Config
     KNOWN_CONFIG_OPTIONS = [
         'application_root',
+        'async_recording',
         'compress_payload',
         'config_file',
         'data_file',
@@ -52,7 +56,10 @@ module ScoutApm
         'name',
         'profile',
         'proxy',
+        'remote_agent_host',
+        'remote_agent_port',
         'report_format',
+        'scm_subdirectory',
         'uri_reporting',
     ]
 
@@ -127,11 +134,12 @@ module ScoutApm
 
 
     SETTING_COERCIONS = {
-      "monitor"                => BooleanCoercion.new,
-      "enable_background_jobs" => BooleanCoercion.new,
-      "dev_trace"              => BooleanCoercion.new,
+      "async_recording"        => BooleanCoercion.new,
       "detailed_middleware"    => BooleanCoercion.new,
+      "dev_trace"              => BooleanCoercion.new,
+      "enable_background_jobs" => BooleanCoercion.new,
       "ignore"                 => JsonCoercion.new,
+      "monitor"                => BooleanCoercion.new,
     }
 
 
@@ -215,7 +223,10 @@ module ScoutApm
         'log_level'              => 'info',
         'profile'                => true, # for scoutprof
         'report_format'          => 'json',
+        'scm_subdirectory'       => '',
         'uri_reporting'          => 'full_path',
+        'remote_agent_host'      => '127.0.0.1',
+        'remote_agent_port'      => 7721, # picked at random
       }.freeze
 
       def value(key)

data/lib/scout_apm/environment.rb

@@ -24,6 +24,7 @@ module ScoutApm
     ]
 
     BACKGROUND_JOB_INTEGRATIONS = [
+      ScoutApm::BackgroundJobIntegrations::Resque.new,
       ScoutApm::BackgroundJobIntegrations::Sidekiq.new,
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
     ]
@@ -84,6 +85,14 @@ module ScoutApm
                       end
     end
 
+    def scm_subdirectory
+      @scm_subdirectory ||= if Agent.instance.config.value('scm_subdirectory').empty?
+        ''
+      else
+        Agent.instance.config.value('scm_subdirectory').sub(/^\//, '') # Trim any leading slash
+      end
+    end
+
     def root
       @root ||= framework_root
     end
@@ -144,6 +153,11 @@ module ScoutApm
       background_job_integration && background_job_integration.name
     end
 
+    # If both stdin & stdout are interactive and the Rails::Console constant is defined
+    def interactive?
+      defined?(::Rails::Console) && $stdout.isatty && $stdin.isatty
+    end
+
     ### ruby checks
 
     def rubinius?

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -1,6 +1,6 @@
 module ScoutApm
   module Instruments
-    # instrumentation for Rails 3 and Rails 4 is the same.
+    # instrumentation for Rails 3, 4, and 5 is the same.
     class ActionControllerRails3Rails4
       attr_reader :logger
 
@@ -20,86 +20,89 @@ module ScoutApm
         # before and after filter timing. Instrumenting Base includes those
         # filters, at the expense of missing out on controllers that don't use
         # the full Rails stack.
-        if defined?(::ActionController) && defined?(::ActionController::Base)
-          ScoutApm::Agent.instance.logger.info "Instrumenting ActionController::Base"
-          ::ActionController::Base.class_eval do
-            # include ScoutApm::Tracer
-            include ScoutApm::Instruments::ActionControllerRails3Rails4Instruments
+        if defined?(::ActionController)
+          if defined?(::ActionController::Base)
+            ScoutApm::Agent.instance.logger.info "Instrumenting ActionController::Base"
+            ::ActionController::Base.class_eval do
+              # include ScoutApm::Tracer
+              include ScoutApm::Instruments::ActionControllerBaseInstruments
+            end
           end
-          ScoutApm::Agent.instance.logger.info "Installing ScoutProf profiling" if ScoutApm::Agent.instance.config.value('profile')
-        end
-
-        if defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
-          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::PartialRenderer"
-          ::ActionView::PartialRenderer.class_eval do
-            include ScoutApm::Tracer
-
-            instrument_method :render_partial,
-              :type => "View",
-              :name => '#{@template.virtual_path rescue "Unknown Partial"}/Rendering',
-              :scope => true
 
-            instrument_method :collection_with_template,
-              :type => "View",
-              :name => '#{@template.virtual_path rescue "Unknown Collection"}/Rendering',
-              :scope => true
+          if defined?(::ActionController::Metal)
+            ScoutApm::Agent.instance.logger.info "Instrumenting ActionController::Metal"
+            ::ActionController::Metal.class_eval do
+              include ScoutApm::Instruments::ActionControllerMetalInstruments
+            end
           end
 
-          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::TemplateRenderer"
-          ::ActionView::TemplateRenderer.class_eval do
-            include ScoutApm::Tracer
-            instrument_method :render_template,
-              :type => "View",
-              :name => '#{args[0].virtual_path rescue "Unknown"}/Rendering',
-              :scope => true
+          if defined?(::ActionController::API)
+            ScoutApm::Agent.instance.logger.info "Instrumenting ActionController::Api"
+            ::ActionController::API.class_eval do
+              include ScoutApm::Instruments::ActionControllerAPIInstruments
+            end
           end
         end
-      end
-    end
 
-    module ActionControllerRails3Rails4Instruments
-      def process_action(*args)
-        req = ScoutApm::RequestManager.lookup
-        req.annotate_request(:uri => scout_transaction_uri(request))
-
-        # IP Spoofing Protection can throw an exception, just move on w/o remote ip
-        req.context.add_user(:ip => request.remote_ip) rescue nil
-
-        req.set_headers(request.headers)
-
-        # Check if this this request is to be reported instantly
-        if instant_key = request.cookies['scoutapminstant']
-          Agent.instance.logger.info "Instant trace request with key=#{instant_key} for path=#{path}"
-          req.instant_key = instant_key
-        end
-
-        req.web!
-
-        layer = ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}")
+      end
 
-        if ScoutApm::Agent.instance.config.value('profile') && ScoutApm::Instruments::Stacks::ENABLED
-          if defined?(ScoutApm::Instruments::Stacks::INSTALLED) && ScoutApm::Instruments::Stacks::INSTALLED
-            # Capture ScoutProf if we can
-            req.enable_profiled_thread!
-            layer.set_root_class(self.class)
-            layer.traced!
+      # Returns a new anonymous module each time it is called. So
+      # we can insert this multiple times into the ancestors
+      # stack. Otherwise it only exists the first time you include it
+      # (under Metal, instead of under API) and we miss instrumenting
+      # before_action callbacks
+      def self.build_instrument_module
+        Module.new do
+          def process_action(*args)
+            req = ScoutApm::RequestManager.lookup
+            current_layer = req.current_layer
+
+            # Check if this this request is to be reported instantly
+            if instant_key = request.cookies['scoutapminstant']
+              Agent.instance.logger.info "Instant trace request with key=#{instant_key} for path=#{path}"
+              req.instant_key = instant_key
+            end
+
+            if current_layer && current_layer.type == "Controller"
+              # Don't start a new layer if ActionController::API or ActionController::Base handled it already.
+              super
+            else
+              req.annotate_request(:uri => ScoutApm::Instruments::ActionControllerRails3Rails4.scout_transaction_uri(request))
+
+              # IP Spoofing Protection can throw an exception, just move on w/o remote ip
+              req.context.add_user(:ip => request.remote_ip) rescue nil
+              req.set_headers(request.headers)
+
+              req.web!
+
+              resolved_name = scout_action_name(*args)
+              layer = ScoutApm::Layer.new("Controller", "#{controller_path}/#{resolved_name}")
+
+              if enable_scoutprof? && ScoutApm::Agent.instance.config.value('profile') && ScoutApm::Instruments::Stacks::ENABLED
+                if defined?(ScoutApm::Instruments::Stacks::INSTALLED) && ScoutApm::Instruments::Stacks::INSTALLED
+                  # Capture ScoutProf if we can
+                  req.enable_profiled_thread!
+                  layer.set_root_class(self.class)
+                  layer.traced!
+                end
+              end
+
+              req.start_layer(layer)
+              begin
+                super
+              rescue
+                req.error!
+                raise
+              ensure
+                req.stop_layer
+              end
+            end
           end
         end
-
-        # Start the layer, then execute the user's code
-        req.start_layer(layer)
-        begin
-          super
-        rescue
-          req.error!
-          raise
-        ensure
-          req.stop_layer
-        end
-      end # process_action
+      end
 
       # Given an +ActionDispatch::Request+, formats the uri based on config settings.
-      def scout_transaction_uri(request)
+      def self.scout_transaction_uri(request)
         case ScoutApm::Agent.instance.config.value("uri_reporting")
         when 'path'
           request.path # strips off the query string for more security
@@ -107,8 +110,47 @@ module ScoutApm
           request.filtered_path
         end
       end
+    end
 
-    end # ActionControllerRails3Rails4Instruments
+    module ActionControllerBaseInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name
+      end
+
+      def enable_scoutprof?
+        true
+      end
+    end
+
+    module ActionControllerMetalInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name = args[0]
+      end
+
+      def enable_scoutprof?
+        false
+      end
+    end
+
+    module ActionControllerAPIInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name
+      end
+
+      def enable_scoutprof?
+        false
+      end
+    end
+
+    # Empty, noop module to provide compatibility w/ previous manual instrumentation
+    module ActionControllerRails3Rails4Instruments
+    end
   end
 end
 

data/lib/scout_apm/instruments/action_view.rb

@@ -0,0 +1,49 @@
+module ScoutApm
+  module Instruments
+    # instrumentation for Rails 3 and Rails 4 is the same.
+    class ActionView
+      attr_reader :logger
+
+      def initalize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+        @installed = false
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        @installed = true
+
+        if defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::PartialRenderer"
+          ::ActionView::PartialRenderer.class_eval do
+            include ScoutApm::Tracer
+
+            instrument_method :render_partial,
+              :type => "View",
+              :name => '#{@template.virtual_path rescue "Unknown Partial"}/Rendering',
+              :scope => true
+
+            instrument_method :collection_with_template,
+              :type => "View",
+              :name => '#{@template.virtual_path rescue "Unknown Collection"}/Rendering',
+              :scope => true
+          end
+
+          ScoutApm::Agent.instance.logger.info "Instrumenting ActionView::TemplateRenderer"
+          ::ActionView::TemplateRenderer.class_eval do
+            include ScoutApm::Tracer
+            instrument_method :render_template,
+              :type => "View",
+              :name => '#{args[0].virtual_path rescue "Unknown"}/Rendering',
+              :scope => true
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/scout_apm/instruments/active_record.rb

@@ -122,7 +122,7 @@ module ScoutApm
             current_layer.desc = desc
           end
 
-          log_without_scout_instruments(sql, name, &block)
+          log_without_scout_instruments(*args, &block)
 
         # OR: Start a new layer, we didn't pick up instrumentation earlier in the stack.
         else
@@ -130,7 +130,7 @@ module ScoutApm
           layer.desc = desc
           req.start_layer(layer)
           begin
-            log_without_scout_instruments(sql, name, &block)
+            log_without_scout_instruments(*args, &block)
           ensure
             req.stop_layer
           end

data/lib/scout_apm/instruments/mongoid.rb

@@ -32,8 +32,8 @@ module ScoutApm
           ### See moped instrument for Moped driven deploys
 
           ### 5.x Mongoid
-          if mongoid_v5? && defined?(::Mongoid::Contextual::Mongo)
-            ScoutApm::Agent.instance.logger.info "Instrumenting Mongoid 5.x"
+          if (mongoid_v5? || mongoid_v6?) && defined?(::Mongoid::Contextual::Mongo)
+            ScoutApm::Agent.instance.logger.info "Instrumenting Mongoid 5.x/6.x"
             # All the public methods from Mongoid::Contextual::Mongo.
             # TODO: Geo and MapReduce support (?). They are in other Contextual::* classes
             methods = [
@@ -99,6 +99,14 @@ module ScoutApm
         end
       end
 
+      def mongoid_v6?
+        if defined?(::Mongoid::VERSION)
+          ::Mongoid::VERSION =~ /\A6/
+        else
+          false
+        end
+      end
+
 
       # Example of what a filter looks like: => {"founded"=>{"$gte"=>"1980-1-1"}, "name"=>{"$in"=>["Tool", "Deftones", "Melvins"]}}
       # Approach: find every leaf-node, clear it. inspect the whole thing when done.