scout_apm 1.2.10 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6e3fc97dff8ae1961d76b52394b1352d0b9ed37
-  data.tar.gz: ec255a3987a94f40a009bb152f07cbc00a6763cc
+  metadata.gz: 99bbe7dc8f3e03137118c997250a4ddc41f9889c
+  data.tar.gz: 3f7305a88ee28e41392d1c30fa182b879d94c95c
 SHA512:
-  metadata.gz: 5d5b03e83afd811e9cf3a9569affdac111e98d78e2668c86bd0ed7cdbca9853e667392f4cb4d6e5820ee9bb3d9841799f9098988dc47e05698f4be87e3d02f52
-  data.tar.gz: 01605ef204077472adec76c6607cecc0d50263faf8ee2b00550d85386b78bda4d2ab5a9edd548b9a2adf97ee2ec8547597e024e0713336bf9ab30d1a75cebc34
+  metadata.gz: e4b44b8e106be2167bd52ed3c405e201c098a4b8b5027afab3dc6a0b51e04f259b8378faa94908d063f234ed3d7dc742dbd05b114614ff77b85c5de7cf35f52a
+  data.tar.gz: bd9ce3b704d0c25ca02409981784420738d223018d55368d19c810c9b498d3caf708e4f66267445b3f30a56095090f5f1716fd497f27e18970e9190ae28c6b00

data/CHANGELOG.markdown

@@ -1,3 +1,10 @@
+# 1.2.11
+
+* Summarizing middleware instrumentation into a single metric for lower overhead.
+* If monitoring isn't enabled:
+  * In ScoutApm::Middleware, don't start the agent
+  * Don't start background worker
+
 # 1.2.10
 
 * Improve exit handler. It wasn't being run during shutdown in some cases.

data/lib/scout_apm/agent.rb

@@ -202,6 +202,10 @@ module ScoutApm
     # Creates the worker thread. The worker thread is a loop that runs continuously. It sleeps for +Agent#period+ and when it wakes,
     # processes data, either saving it to disk or reporting to Scout.
     def start_background_worker
+      if !apm_enabled?
+        logger.debug "Not starting background worker as monitoring isn't enabled."
+        return false
+      end
       logger.info "Not starting background worker, already started" and return if background_worker_running?
       logger.info "Initializing worker thread."
 
@@ -238,7 +242,7 @@ module ScoutApm
         when :rails       then install_instrument(ScoutApm::Instruments::ActionControllerRails2)
         when :rails3_or_4 then
           install_instrument(ScoutApm::Instruments::ActionControllerRails3Rails4)
-          install_instrument(ScoutApm::Instruments::Middleware)
+          install_instrument(ScoutApm::Instruments::MiddlewareSummary)
           install_instrument(ScoutApm::Instruments::RailsRouter)
         when :sinatra     then install_instrument(ScoutApm::Instruments::Sinatra)
         end

data/lib/scout_apm/instruments/{middleware.rb → middleware_detailed.rb}

@@ -1,6 +1,16 @@
+# Inserts a new middleware between each actual middleware in the application,
+# so as to trace the time for each one.
+#
+# Currently disabled due to the overhead of this approach (~10-15ms per request
+# in practice).  Instead, middleware as a whole are instrumented via the
+# MiddlewareSummary class.
+#
+# There will likely be a configuration flag to turn this on in favor of the
+# summary tracing in a future version of the agent, but this is not yet
+# implemented.
 module ScoutApm
   module Instruments
-    class Middleware
+    class MiddlewareDetailed
       def initalize(logger=ScoutApm::Agent.instance.logger)
         @logger = logger
         @installed = false

data/lib/scout_apm/instruments/middleware_summary.rb

@@ -0,0 +1,51 @@
+# Inserts a single middleware at the outer edge of the stack (the first
+# middleware called, before passing to the rest of the stack) to trace the
+# total time spent between all middlewares. This instrument does not attempt to
+# allocate time to specific middlewares. (see MiddlewareDetailed)
+#
+module ScoutApm
+  module Instruments
+    class MiddlewareSummary
+      def initalize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+        @installed = false
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        @installed = true
+
+        if defined?(ActionDispatch) && defined?(ActionDispatch::MiddlewareStack)
+          ScoutApm::Agent.instance.logger.info("Instrumenting Middleware")
+          ActionDispatch::MiddlewareStack.class_eval do
+            def build_with_scout_instruments(app = nil, &block)
+              mw_stack = build_without_scout_instruments(app) { block.call if block }
+              MiddlewareSummaryWrapper.new(mw_stack)
+            end
+
+            alias_method :build_without_scout_instruments, :build
+            alias_method :build, :build_with_scout_instruments
+          end
+        end
+      end
+
+      class MiddlewareSummaryWrapper
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          req = ScoutApm::RequestManager.lookup
+          layer = ScoutApm::Layer.new("Middleware", "Summary")
+          req.start_layer(layer)
+          @app.call(env)
+        ensure
+          req.stop_layer
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/layer_converter.rb

@@ -159,14 +159,12 @@ module ScoutApm
                        end
 
         # Specific Metric
-        if record_specific_metric?(layer.type)
-          meta_options.merge!(:desc => layer.desc) if layer.desc
-          meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
-          meta.extra.merge!(:backtrace => ScoutApm::SlowTransaction.backtrace_parser(layer.backtrace)) if layer.backtrace
-          metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
-          stat = metric_hash[meta]
-          stat.update!(layer.total_call_time, layer.total_exclusive_time)
-        end
+        meta_options.merge!(:desc => layer.desc) if layer.desc
+        meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
+        meta.extra.merge!(:backtrace => ScoutApm::SlowTransaction.backtrace_parser(layer.backtrace)) if layer.backtrace
+        metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
+        stat = metric_hash[meta]
+        stat.update!(layer.total_call_time, layer.total_exclusive_time)
 
         # Merged Metric (no specifics, just sum up by type)
         meta = MetricMeta.new("#{layer.type}/all")
@@ -177,13 +175,6 @@ module ScoutApm
 
       metric_hash
     end
-
-    SKIP_SPECIFICS = ["Middleware"]
-    # For metrics that are known to be of sort duration (Middleware right now), we don't record specifics on each call to eliminate a metric explosion.
-    # There can be many Middlewares in an app.
-    def record_specific_metric?(name)
-      !SKIP_SPECIFICS.include?(name)
-    end
   end
 
   class LayerDepthFirstWalker
@@ -202,6 +193,13 @@ module ScoutApm
     end
 
     def walk(layer=root_layer, &block)
+      # Need to run this for the root layer the first time through.
+      if layer == root_layer
+        @before_block.call(layer) if @before_block
+        yield layer
+        @after_block.call(layer) if @after_block
+      end
+
       layer.children.each do |child|
         @before_block.call(child) if @before_block
         yield child

data/lib/scout_apm/middleware.rb

@@ -5,12 +5,13 @@ module ScoutApm
     def initialize(app)
       @app = app
       @attempts = 0
+      @enabled = ScoutApm::Agent.instance.apm_enabled?
       @started = ScoutApm::Agent.instance.started? && ScoutApm::Agent.instance.background_worker_running?
     end
 
     # If we get a web request in, then we know we're running in some sort of app server
     def call(env)
-      if @started || @attempts > MAX_ATTEMPTS
+      if !@enabled || @started || @attempts > MAX_ATTEMPTS
         @app.call(env)
       else
         attempt_to_start_agent

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.2.10"
+  VERSION = "1.2.11"
 end
 

data/lib/scout_apm.rb

@@ -65,7 +65,8 @@ require 'scout_apm/instruments/delayed_job'
 require 'scout_apm/instruments/active_record'
 require 'scout_apm/instruments/action_controller_rails_2'
 require 'scout_apm/instruments/action_controller_rails_3_rails4'
-require 'scout_apm/instruments/middleware'
+require 'scout_apm/instruments/middleware_summary'
+# require 'scout_apm/instruments/middleware_detailed' # Currently disabled functionality, see the file for details.
 require 'scout_apm/instruments/rails_router'
 require 'scout_apm/instruments/sinatra'
 require 'scout_apm/instruments/process/process_cpu'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.11
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -92,7 +92,8 @@ files:
 - lib/scout_apm/instruments/action_controller_rails_3_rails4.rb
 - lib/scout_apm/instruments/active_record.rb
 - lib/scout_apm/instruments/delayed_job.rb
-- lib/scout_apm/instruments/middleware.rb
+- lib/scout_apm/instruments/middleware_detailed.rb
+- lib/scout_apm/instruments/middleware_summary.rb
 - lib/scout_apm/instruments/mongoid.rb
 - lib/scout_apm/instruments/moped.rb
 - lib/scout_apm/instruments/net_http.rb
@@ -175,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
@@ -191,3 +192,4 @@ test_files:
 - test/unit/slow_transaction_set_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
+has_rdoc: