scout_apm 2.1.24 → 2.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c94cdf557213ec5d7954875a37beee23ec18353
-  data.tar.gz: d40e259ae8115101adf203e8dff98c6f193cc55d
+  metadata.gz: f204bb73b571d29f24c1ef41ef3e643dd53ede06
+  data.tar.gz: 420211b4994ee6437de618b5fd6cea516881d6aa
 SHA512:
-  metadata.gz: c80c11514d116b0d926c2b7e0992c44e4e4cc0be120677d9ac0651fce7069247184e6147cfb081802694792a13fa98db51278f26889ec52b4a4e3d4ac4dc7c0b
-  data.tar.gz: '05465810d1d6f23b287b01daae791d456742adc657fd707d4282d10d822e14420010d8ac7c264034f3271b8c84a48717f842c242685257f8bf703b60addb886c'
+  metadata.gz: e8095e97d2fc53bcad1a8b100ea13f574795cfbe1bc45a7d4717c7c356f2eab3f9d28ff09cd65df0485fca4a82439fb9d13aa668654a2e8599debc6b97ace906
+  data.tar.gz: ebe375745cb23716f9930cf12221d9ee11775ee0ba37a0fe89c510d342b2618171b80724201e9f76d141d612b919d6ac41486c2fc07dd9c6ad727ac4e454a17f

data/lib/scout_apm.rb

@@ -83,6 +83,7 @@ require 'scout_apm/instruments/sinatra'
 require 'scout_apm/instruments/process/process_cpu'
 require 'scout_apm/instruments/process/process_memory'
 require 'scout_apm/instruments/percentile_sampler'
+require 'scout_apm/instruments/action_view'
 require 'allocations'
 
 require 'scout_apm/app_server_load'
@@ -143,6 +144,8 @@ require 'scout_apm/middleware'
 
 require 'scout_apm/instant/middleware'
 
+require 'scout_apm/rack'
+
 if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3 && defined?(Rails::Railtie)
   module ScoutApm
     class Railtie < Rails::Railtie

data/lib/scout_apm/agent.rb

@@ -297,6 +297,7 @@ module ScoutApm
         end
       end
 
+      install_instrument(ScoutApm::Instruments::ActionView)
       install_instrument(ScoutApm::Instruments::ActiveRecord)
       install_instrument(ScoutApm::Instruments::Moped)
       install_instrument(ScoutApm::Instruments::Mongoid)

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -20,73 +20,78 @@ 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
-        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!
+        # 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
+      end
 
-        req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}") )
-        begin
-          super
-        rescue
-          req.error!
-          raise
-        ensure
-          req.stop_layer
+      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.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)
+              req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{resolved_name}") )
+              begin
+                super
+              rescue
+                req.error!
+                raise
+              ensure
+                req.stop_layer
+              end
+            end
+          end
         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
@@ -94,8 +99,35 @@ module ScoutApm
           request.filtered_path
         end
       end
+    end
 
-    end # ActionControllerRails3Rails4Instruments
+    module ActionControllerMetalInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name = args[0]
+      end
+    end
+
+    # Empty, noop module to provide compatibility w/ previous manual instrumentation
+    module ActionControllerRails3Rails4Instruments
+    end
+
+    module ActionControllerBaseInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name
+      end
+    end
+
+    module ActionControllerAPIInstruments
+      include ScoutApm::Instruments::ActionControllerRails3Rails4.build_instrument_module
+
+      def scout_action_name(*args)
+        action_name
+      end
+    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/rack.rb

@@ -0,0 +1,26 @@
+module ScoutApm
+  module Rack
+    def self.install!
+      ScoutApm::Agent.instance.start(:skip_app_server_check => true)
+      ScoutApm::Agent.instance.start_background_worker
+    end
+
+    def self.transaction(endpoint_name, env)
+      req = ScoutApm::RequestManager.lookup
+      req.annotate_request(:uri => env["REQUEST_PATH"]) rescue nil
+      req.context.add_user(:ip => env["REMOTE_ADDR"]) rescue nil
+
+      req.web!
+      req.start_layer(ScoutApm::Layer.new('Controller', endpoint_name))
+
+      begin
+        yield
+      rescue
+        req.error!
+        raise
+      ensure
+        req.stop_layer
+      end
+    end
+  end
+end

data/lib/scout_apm/tracked_request.rb

@@ -53,7 +53,7 @@ module ScoutApm
       @error = false
       @instant_key = nil
       @mem_start = mem_usage
-      @dev_trace =  ScoutApm::Agent.instance.config.value('dev_trace') && Rails.env.development?
+      @dev_trace =  ScoutApm::Agent.instance.config.value('dev_trace') && ScoutApm::Agent.instance.environment.env == "development"
     end
 
     def start_layer(layer)

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.24"
+  VERSION = "2.1.26"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.24
+  version: 2.1.26
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -160,6 +160,7 @@ files:
 - lib/scout_apm/instruments/.DS_Store
 - lib/scout_apm/instruments/action_controller_rails_2.rb
 - lib/scout_apm/instruments/action_controller_rails_3_rails4.rb
+- lib/scout_apm/instruments/action_view.rb
 - lib/scout_apm/instruments/active_record.rb
 - lib/scout_apm/instruments/elasticsearch.rb
 - lib/scout_apm/instruments/grape.rb
@@ -198,6 +199,7 @@ files:
 - lib/scout_apm/platform_integrations/cloud_foundry.rb
 - lib/scout_apm/platform_integrations/heroku.rb
 - lib/scout_apm/platform_integrations/server.rb
+- lib/scout_apm/rack.rb
 - lib/scout_apm/reporter.rb
 - lib/scout_apm/request_histograms.rb
 - lib/scout_apm/request_manager.rb