scout_apm 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0d5d02cc644b23e02868a9705fba1a15f0250bba5bff1c92eb97efaf04f1d87
-  data.tar.gz: e0f5acef9895941f7d2f327596d1f9eef9f6a3ef374ddced1ee658b2882bc525
+  metadata.gz: 302bcce1cb8a4e8e1a000857fed8764438486e8d9a1c7df47c4cd9af475d6468
+  data.tar.gz: ff41334b370a15f45262c5fc6e215400c100f13beb41cd4bbafcbe2800e1ad9f
 SHA512:
-  metadata.gz: 976b31dc166e501368825e07b3377138be135790a23a92fc52681f81d780034641d86496ac0d03dda0639127673d6b1908f5191f966a9193488094a24a7720a7
-  data.tar.gz: 835d1e4f4db51c71a41521f5892e91d1d67c7cd96effc91f684bacbe6fa9e9303e9abdb9b697c75d79d656bab45d9b241b3200ac8203236fb75a07c101f3c5fb
+  metadata.gz: 50e3e4e094927f4add2b1839a9f4b5d8ded24785fc52fce7e37d5931c12e685b0be0234c3c2c5714cc366dcf4dc3dbe0c8f3d8d949e871a552011c558d65e6a5
+  data.tar.gz: 83f98b354e219d40b449df8e7ae121bf0f084e8ac7d7ac7c0d71c32c295791779a6c8720551e92e73f7a4592dfad9d10d709c47e619dc797c6557a8ac7523679

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 2.6.1
+
+* Logging total autoinstrumented spans and the ratio of significant to total spans (#283).
+* Added `autoinstruments_ignore` option (also #283).
+
 # 2.6.0
 
 * Autoinstruments (#247). Disabled by default. Set `auto_instruments: true` to enable.

data/lib/scout_apm/agent_context.rb

@@ -103,6 +103,13 @@ module ScoutApm
       @slow_job_policy ||= ScoutApm::SlowJobPolicy.new(self)
     end
 
+    # Maintains a Histogram of insignificant/significant autoinstrument layers.
+    # significant = 1
+    # insignificant = 0
+    def auto_instruments_layer_histograms
+      @auto_instruments_layer_histograms ||= ScoutApm::RequestHistograms.new
+    end
+
     # Histogram of the cumulative requests since the start of the process
     def request_histograms
       @request_histograms ||= ScoutApm::RequestHistograms.new

data/lib/scout_apm/auto_instrument/instruction_sequence.rb

@@ -5,15 +5,17 @@ module ScoutApm
   module AutoInstrument
     module InstructionSequence
       def load_iseq(path)
-        if Rails.controller_path?(path)
+        if Rails.controller_path?(path) & !Rails.ignore?(path)
           begin
             new_code = Rails.rewrite(path)
             return self.compile(new_code, File.basename(path), path)
           rescue
             warn "Failed to apply auto-instrumentation to #{path}: #{$!}"
           end
+        elsif Rails.ignore?(path)
+          warn "AutoInstruments are ignored for path=#{path}."
         end
-        
+
         return self.compile_file(path)
       end
     end

data/lib/scout_apm/auto_instrument/layer.rb

@@ -1,11 +1,12 @@
 
 module ScoutApm
-  def self.AutoInstrument(name, backtrace = nil)
+  def self.AutoInstrument(name, backtrace, file_name)
     request = ScoutApm::RequestManager.lookup
 
     begin
       layer = ScoutApm::Layer.new('AutoInstrument', name)
       layer.backtrace = backtrace
+      layer.file_name = file_name
 
       request.start_layer(layer)
       started_layer = true

data/lib/scout_apm/auto_instrument/rails.rb

@@ -17,6 +17,19 @@ module ScoutApm
         CONTROLLER_FILE.match(path) && !GEM_FILE.match(path)
       end
 
+      # Autoinstruments increases overhead when applied to many code expressions that perform little work.
+      # You can exclude files from autoinstruments via the `auto_instruments_ignore` option.
+      def self.ignore?(path)
+        res = false
+        ScoutApm::Agent.instance.context.config.value('auto_instruments_ignore').each do |ignored_file_name|
+          if path.include?(ignored_file_name)
+            res = true
+            break
+          end
+        end
+        res
+      end
+
       def self.rewrite(path, code = nil)
         code ||= File.read(path)
 
@@ -60,7 +73,7 @@ module ScoutApm
           bt = ["#{file_name}:#{line}:in `#{method_name}'"]
 
           return [
-            "::ScoutApm::AutoInstrument("+ source.dump + ",#{bt}" + "){",
+            "::ScoutApm::AutoInstrument("+ source.dump + ",#{bt}" + ",'#{file_name}'" + "){",
             "}"
           ]
         end

data/lib/scout_apm/config.rb

@@ -34,6 +34,7 @@ require 'scout_apm/environment'
 # start_resque_server_instrument - Used in special situations with certain Resque installs
 # timeline_traces - true/false to enable sending of of the timeline trace format.
 # auto_instruments - true/false whether to install autoinstruments. Only installed if on a supported Ruby version.
+# auto_instruments_ignore - An array of file names to exclude from autoinstruments (Ex: ['application_controller']).
 #
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
@@ -77,7 +78,8 @@ module ScoutApm
         'uri_reporting',
         'instrument_http_url_length',
         'timeline_traces',
-        'auto_instruments'
+        'auto_instruments',
+        'auto_instruments_ignore'
     ]
 
     ################################################################################
@@ -171,7 +173,8 @@ module ScoutApm
       'instrument_http_url_length' => IntegerCoercion.new,
       'start_resque_server_instrument' => BooleanCoercion.new,
       'timeline_traces' => BooleanCoercion.new,
-      'auto_instruments' => BooleanCoercion.new
+      'auto_instruments' => BooleanCoercion.new,
+      'auto_instruments_ignore' => JsonCoercion.new,
     }
 
 
@@ -280,7 +283,8 @@ module ScoutApm
         'start_resque_server_instrument' => true, # still only starts if Resque is detected
         'collect_remote_ip' => true,
         'timeline_traces' => true,
-        'auto_instruments' => false
+        'auto_instruments' => false,
+        'auto_instruments_ignore' => []
       }.freeze
 
       def value(key)

data/lib/scout_apm/instant/middleware.rb

@@ -94,7 +94,8 @@ module ScoutApm
 
       def preconditions_met?
         if dev_trace_disabled?
-          logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
+          # The line below is very noise as it is called on every request.
+          # logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
           return false
         end
 

data/lib/scout_apm/layer.rb

@@ -38,6 +38,9 @@ module ScoutApm
     # backtrace of where it occurred.
     attr_accessor :backtrace
 
+    # The file name associated with the layer. Only used for autoinstruments overhead logging.
+    attr_accessor :file_name
+
     # As we go through a part of a request, instrumentation can store additional data
     # Known Keys:
     #   :record_count - The number of rows returned by an AR query (From notification instantiation.active_record)

data/lib/scout_apm/periodic_work.rb

@@ -12,10 +12,24 @@ module ScoutApm
       ScoutApm::Debug.instance.call_periodic_hooks
       @reporting.process_metrics
       clean_old_percentiles
+      log_layer_histograms
     end
 
     private
 
+    def log_layer_histograms
+      # Ex key/value -
+      # "/Users/dlite/projects/scout/apm/app/controllers/application_controller.rb"=>[[0.0, 689], [1.0, 16]]
+      hists = context.auto_instruments_layer_histograms.as_json
+      hists_summary = hists.map { |k,v|
+        [
+          k,
+          {:total => total=v.map(&:last).inject(:+), :significant => (v.last.last/total.to_f).round(2)}
+        ]
+      }.to_h
+      context.logger.debug("AutoInstrument Significant Layer Histograms: #{hists_summary.pretty_inspect}")
+    end
+
     # XXX: Move logic into a RequestHistogramsByTime class that can keep the timeout logic in it
     def clean_old_percentiles
       context.

data/lib/scout_apm/request_histograms.rb

@@ -22,6 +22,10 @@ module ScoutApm
       @histograms.keys.each { |n| yield n }
     end
 
+    def as_json
+      @histograms.as_json
+    end
+
     def add(item, value)
       @histograms[item].add(value)
     end

data/lib/scout_apm/tracked_request.rb

@@ -180,14 +180,18 @@ module ScoutApm
       false
     end
 
+    # Returns +true+ if the total call time of AutoInstrument layers exceeds +AUTO_INSTRUMENT_TIMING_THRESHOLD+ and
+    # records a Histogram of insignificant / significant layers by file name.
     def layer_insignificant?(layer)
+      result = false # default is significant
       if layer.type == 'AutoInstrument'
         if layer.total_call_time < AUTO_INSTRUMENT_TIMING_THRESHOLD
-          context.logger.debug("IGNORE LAYER name=#{layer.name} total_call_time=#{layer.total_call_time}")
-          return true
+          result = true # not significant
         end
+        # 0 = not significant, 1 = significant
+        @agent_context.auto_instruments_layer_histograms.add(layer.file_name, (result ? 0 : 1))
       end
-      return false
+      result
     end
 
     # Maintains a lookup Hash of call counts by layer name. Used to determine if we should capture a backtrace.
@@ -329,7 +333,7 @@ module ScoutApm
         memo
       end
       walker.walk
-      converter_results = converter_instances.inject({}) do |memo, (slug,i)| 
+      converter_results = converter_instances.inject({}) do |memo, (slug,i)|
         memo[slug] = i.record!
         memo
       end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "2.6.0"
+  VERSION = "2.6.1"
 end

data/test/unit/auto_instrument/assignments-instrumented.rb

@@ -1,26 +1,26 @@
 
 class Assignments
   def nested_assignment
-    @email ||= if (email = ::ScoutApm::AutoInstrument("session[\"email\"]",["BACKTRACE"]){session["email"]}).present?
-        ::ScoutApm::AutoInstrument("User.where(email: email).first",["BACKTRACE"]){User.where(email: email).first}
+    @email ||= if (email = ::ScoutApm::AutoInstrument("session[\"email\"]",["BACKTRACE"],'FILE_NAME'){session["email"]}).present?
+        ::ScoutApm::AutoInstrument("User.where(email: email).first",["BACKTRACE"],'FILE_NAME'){User.where(email: email).first}
       else
         nil
       end
   end
 
   def paginate_collection(coll)
-    page = (::ScoutApm::AutoInstrument("params[:page].present?",["BACKTRACE"]){params[:page].to_i} : 1)
-    per_page = (::ScoutApm::AutoInstrument("params[:per_page].present?",["BACKTRACE"]){params[:per_page].to_i} : 20)
-    pagination, self.collection = ::ScoutApm::AutoInstrument("pagy(...",["BACKTRACE"]){pagy(
+    page = (::ScoutApm::AutoInstrument("params[:page].present?",["BACKTRACE"],'FILE_NAME'){params[:page].to_i} : 1)
+    per_page = (::ScoutApm::AutoInstrument("params[:per_page].present?",["BACKTRACE"],'FILE_NAME'){params[:per_page].to_i} : 20)
+    pagination, self.collection = ::ScoutApm::AutoInstrument("pagy(...",["BACKTRACE"],'FILE_NAME'){pagy(
       coll,
       items: per_page,
       page: page
     )}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s",["BACKTRACE"]){headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s",["BACKTRACE"]){headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s",["BACKTRACE"]){headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s",["BACKTRACE"]){headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s}
-    ::ScoutApm::AutoInstrument("headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s",["BACKTRACE"]){headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s}
-    ::ScoutApm::AutoInstrument("collection",["BACKTRACE"]){collection}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s",["BACKTRACE"],'FILE_NAME'){headers[PAGINATION_TOTAL_HEADER] = pagination.count.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s",["BACKTRACE"],'FILE_NAME'){headers[PAGINATION_TOTAL_PAGES_HEADER] = pagination.pages.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s",["BACKTRACE"],'FILE_NAME'){headers[PAGINATION_PER_PAGE_HEADER] = per_page.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s",["BACKTRACE"],'FILE_NAME'){headers[PAGINATION_PAGE_HEADER] = pagination.page.to_s}
+    ::ScoutApm::AutoInstrument("headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s",["BACKTRACE"],'FILE_NAME'){headers[PAGINATION_NEXT_PAGE_HEADER] = pagination.next.to_s}
+    ::ScoutApm::AutoInstrument("collection",["BACKTRACE"],'FILE_NAME'){collection}
   end
 end

data/test/unit/auto_instrument/controller-instrumented.rb

@@ -3,47 +3,47 @@ class ClientsController < ApplicationController
   before_action :check_authorization
 
   def index
-    if ::ScoutApm::AutoInstrument("params[:status] == \"activated\"",["BACKTRACE"]){params[:status] == "activated"}
-      @clients = ::ScoutApm::AutoInstrument("Client.activated",["BACKTRACE"]){Client.activated}
+    if ::ScoutApm::AutoInstrument("params[:status] == \"activated\"",["BACKTRACE"],'FILE_NAME'){params[:status] == "activated"}
+      @clients = ::ScoutApm::AutoInstrument("Client.activated",["BACKTRACE"],'FILE_NAME'){Client.activated}
     else
-      @clients = ::ScoutApm::AutoInstrument("Client.inactivated",["BACKTRACE"]){Client.inactivated}
+      @clients = ::ScoutApm::AutoInstrument("Client.inactivated",["BACKTRACE"],'FILE_NAME'){Client.inactivated}
     end
   end
 
   def create
-    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["BACKTRACE"]){Client.new(params[:client])}
-    if ::ScoutApm::AutoInstrument("@client.save",["BACKTRACE"]){@client.save}
-      ::ScoutApm::AutoInstrument("redirect_to @client",["BACKTRACE"]){redirect_to @client}
+    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["BACKTRACE"],'FILE_NAME'){Client.new(params[:client])}
+    if ::ScoutApm::AutoInstrument("@client.save",["BACKTRACE"],'FILE_NAME'){@client.save}
+      ::ScoutApm::AutoInstrument("redirect_to @client",["BACKTRACE"],'FILE_NAME'){redirect_to @client}
     else
       # This line overrides the default rendering behavior, which
       # would have been to render the "create" view.
-      ::ScoutApm::AutoInstrument("render \"new\"",["BACKTRACE"]){render "new"}
+      ::ScoutApm::AutoInstrument("render \"new\"",["BACKTRACE"],'FILE_NAME'){render "new"}
     end
   end
 
   def edit
-    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["BACKTRACE"]){Client.new(params[:client])}
+    @client = ::ScoutApm::AutoInstrument("Client.new(params[:client])",["BACKTRACE"],'FILE_NAME'){Client.new(params[:client])}
 
-    if ::ScoutApm::AutoInstrument("request.post?",["BACKTRACE"]){request.post?}
-      ::ScoutApm::AutoInstrument("@client.transaction do...",["BACKTRACE"]){@client.transaction do
+    if ::ScoutApm::AutoInstrument("request.post?",["BACKTRACE"],'FILE_NAME'){request.post?}
+      ::ScoutApm::AutoInstrument("@client.transaction do...",["BACKTRACE"],'FILE_NAME'){@client.transaction do
         @client.update_attributes(params[:client])
       end}
     end
   end
 
   def data
-    @clients = ::ScoutApm::AutoInstrument("Client.all",["BACKTRACE"]){Client.all}
+    @clients = ::ScoutApm::AutoInstrument("Client.all",["BACKTRACE"],'FILE_NAME'){Client.all}
 
-    formatter = ::ScoutApm::AutoInstrument("proc do |row|...",["BACKTRACE"]){proc do |row|
+    formatter = ::ScoutApm::AutoInstrument("proc do |row|...",["BACKTRACE"],'FILE_NAME'){proc do |row|
       row.to_json
     end}
 
-    ::ScoutApm::AutoInstrument("respond_with @clients.each(&formatter).join(\"\\n\"), :content_type => 'application/json; boundary=NL'",["BACKTRACE"]){respond_with @clients.each(&formatter).join("\n"), :content_type => 'application/json; boundary=NL'}
+    ::ScoutApm::AutoInstrument("respond_with @clients.each(&formatter).join(\"\\n\"), :content_type => 'FILE_NAME'}
   end
   
   def things
     x = {}
     x[:this] ||= 'foo'
-    x[:that] &&= ::ScoutApm::AutoInstrument("'foo'.size",["BACKTRACE"]){'foo'.size}
+    x[:that] &&= ::ScoutApm::AutoInstrument("'FILE_NAME'.size}
   end
 end

data/test/unit/auto_instrument_test.rb

@@ -19,35 +19,33 @@ class AutoInstrumentTest < Minitest::Test
   # test controller.rb file, which will be different on different environments.
   # This normalizes backtraces across environments.
   def normalize_backtrace(string)
-    string.gsub(/\[".+auto_instrument\/.+?:.+?"\]/,'["BACKTRACE"]')
+    string
+      .gsub(/\[".+auto_instrument\/.+?:.+?"\]/,'["BACKTRACE"]')
+      .gsub(/'.+auto_instrument\/.+'/,"'FILE_NAME'")
   end
 
   # Use this to automatically update the test fixtures.
   def update_instrumented_source(name)
-    File.write(
-      instrumented_path(name),
-      normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path(name)))
-    )
+    source = ::ScoutApm::AutoInstrument::Rails.rewrite(source_path(name))
+    source = normalize_backtrace(source)
+    File.write(instrumented_path(name),source)
   end
 
   def test_controller_rewrite
+    # update_instrumented_source("controller")
     assert_equal instrumented_source("controller"),
       normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("controller")))
-
-    # update_instrumented_source("controller")
   end
 
   def test_rescue_from_rewrite
+    # update_instrumented_source("rescue_from")
     assert_equal instrumented_source("rescue_from"),
       normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("rescue_from")))
-
-    # update_instrumented_source("rescue_from")
   end
 
   def test_assignments_rewrite
+    # update_instrumented_source("assignments")
     assert_equal instrumented_source("assignments"),
       normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("assignments")))
-
-    # update_instrumented_source("assignments")
   end
 end if defined? ScoutApm::AutoInstrument

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest