scout_apm 2.1.13 → 2.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 270c8e00f124e50fa52444a01e1d17339ea46a86
-  data.tar.gz: e9699a8a5614f9e752a0b64fba22079a655e52d1
+  metadata.gz: faa58ca3a2800e8aade5ade08a31d2c5db1e5a7d
+  data.tar.gz: ceb42f746d3b72eb84610522eeee9247fd68cf81
 SHA512:
-  metadata.gz: 5e1935a1bdb172835103fc0b6a61ecf3e3306df472db5a87730c4d056cc20ad8fa36abde59b59bdf577e463645e57c358e6a12e3e719ca870811ed90d6bbe0ea
-  data.tar.gz: e53d0af91f2de2f6123ade8b76744cdbf8b33bc10d13913aa930782a75b576b0db4b5a91b92bfe93b50dd15be4d90d8dce64fd6d9a56828eb29543544504a467
+  metadata.gz: b692efc8a697ffb71657d9c2493c1c4fd2bc003f5970155339654679832d6b7fd9da95d26bc0d2b46c153980da697532376556556ff8b2ba10140cc5fb398180
+  data.tar.gz: 3ae789a0000e598a39bce414c4955d13fa354e38f716d53ddb6041160a89fc9a500c3f1d1144095e0487722eedc2951cb6681e8db4f8917bf162adbc52112b51

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 2.1.14
+
+* Add TrackedRequest#ignore_request! to entirely ignore and stop capturing a
+  certain request. Use in your code by calling:
+    ScoutApm::RequestManager.lookup.ignore_request!
+
 # 2.1.13
 
 * Rework Delayed Job instrumentation to not interfere with other instruments.

data/lib/scout_apm/instant/middleware.rb

@@ -50,6 +50,9 @@ module ScoutApm
         if ScoutApm::Agent.instance.config.value('dev_trace')
           if response.respond_to?(:body)
             req = ScoutApm::RequestManager.lookup
+
+            return [status, headers, response] if req.ignoring_request?
+
             slow_converter = LayerConverters::SlowRequestConverter.new(req)
             trace = slow_converter.call
             if trace

data/lib/scout_apm/instruments/active_record.rb

@@ -62,8 +62,10 @@ module ScoutApm
             layer = req.current_layer
             if layer && layer.type == "ActiveRecord"
               layer.annotate_layer(payload)
-            else
+            elsif layer
               ScoutApm::Agent.instance.logger.debug("Expected layer type: ActiveRecord, got #{layer && layer.type}")
+            else
+              # noop, no layer at all. We're probably ignoring this req.
             end
           end
         end

data/lib/scout_apm/instruments/net_http.rb

@@ -22,12 +22,17 @@ module ScoutApm
             include ScoutApm::Tracer
 
             def request_with_scout_instruments(*args,&block)
-              url = (@address + args.first.path.split('?').first)[0..99]
-              self.class.instrument("HTTP", "request", :desc => url) do
+              self.class.instrument("HTTP", "request", :desc => request_scout_description(args.first)) do
                 request_without_scout_instruments(*args, &block)
               end
             end
 
+            def request_scout_description(req)
+              path = req.path
+              path = path.path if path.respond_to?(:path)
+              (@address + path.split('?').first)[0..99]
+            end
+
             alias request_without_scout_instruments request
             alias request request_with_scout_instruments
           end

data/lib/scout_apm/tracked_request.rb

@@ -57,9 +57,9 @@ module ScoutApm
     end
 
     def start_layer(layer)
-      if ignoring_children?
-        return
-      end
+      return if ignoring_children?
+
+      return ignoring_start_layer if ignoring_request?
 
       start_request(layer) unless @root_layer
       @layers[-1].add_child(layer) if @layers.any?
@@ -69,6 +69,8 @@ module ScoutApm
     def stop_layer
       return if ignoring_children?
 
+      return ignoring_stop_layer if ignoring_request?
+
       layer = @layers.pop
 
       # Safeguard against a mismatch in the layer tracking in an instrument.
@@ -110,6 +112,8 @@ module ScoutApm
 
     BACKTRACE_BLACKLIST = ["Controller", "Job"]
     def capture_backtrace?(layer)
+      return if ignoring_request?
+
       # Never capture backtraces for this kind of layer. The backtrace will
       # always be 100% framework code.
       return false if BACKTRACE_BLACKLIST.include?(layer.type)
@@ -210,6 +214,8 @@ module ScoutApm
     end
 
     def instant?
+      return false if ignoring_request?
+
       instant_key
     end
 
@@ -222,6 +228,8 @@ module ScoutApm
     def record!
       @recorded = true
 
+      return if ignoring_request?
+
       # Bail out early if the user asked us to ignore this uri
       return if ScoutApm::Agent.instance.ignored_uris.ignore?(annotations[:uri])
 
@@ -271,6 +279,8 @@ module ScoutApm
 
     # Only call this after the request is complete
     def unique_name
+      return nil if ignoring_request?
+
       @unique_name ||= begin
                          scope_layer = LayerConverters::ConverterBase.new(self).scope_layer
                          if scope_layer
@@ -285,6 +295,8 @@ module ScoutApm
     # Used to know when we should just create a new one (don't attempt to add
     # data to an already-recorded request). See RequestManager
     def recorded?
+      return ignoring_recorded? if ignoring_request?
+
       @recorded
     end
 
@@ -333,5 +345,48 @@ module ScoutApm
     def backtrace_threshold
       dev_trace ? 0.05 : 0.5 # the minimum threshold in seconds to record the backtrace for a metric.
     end
+
+    ################################################################################
+    # Ignoring the rest of a request
+    ################################################################################
+
+    # At any point in the request, calling code or instrumentation can call
+    # `ignore_request!` to immediately stop recording any information about new
+    # layers, and delete any existing layer info.  This class will still exist,
+    # and respond to methods as normal, but `record!` won't be called, and no
+    # data will be recorded.
+
+    def ignore_request!
+      return if @ignoring_request
+
+      # Set instance variable
+      @ignoring_request = true
+
+      # Store data we'll need
+      @ignoring_depth = @layers.length
+
+      # Clear data
+      @layers = []
+      @root_layer = nil
+      @call_set = nil
+      @annotations = {}
+      @instant_key = nil
+    end
+
+    def ignoring_request?
+      @ignoring_request
+    end
+
+    def ignoring_start_layer
+      @ignoring_depth += 1
+    end
+
+    def ignoring_stop_layer
+      @ignoring_depth -= 1
+    end
+
+    def ignoring_recorded?
+      @ignoring_depth <= 0
+    end
   end
 end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.13"
+  VERSION = "2.1.14"
 end
 

data/scout_apm.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "m"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "rake-compiler"
+  s.add_development_dependency "addressable"
 end

data/test/unit/instruments/net_http_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+require 'scout_apm/instruments/net_http'
+
+require 'addressable'
+
+class NetHttpTest < Minitest::Test
+  def setup
+    ScoutApm::Instruments::NetHttp.new.install
+  end
+
+  def test_request_scout_description_for_uri
+    req = Net::HTTP::Get.new(URI('http://example.org/here'))
+    assert_equal '/here', Net::HTTP.new('').request_scout_description(req)
+  end
+
+  def test_request_scout_description_for_addressable
+    req = Net::HTTP::Get.new(Addressable::URI.parse('http://example.org/here'))
+    assert_equal '/here', Net::HTTP.new('').request_scout_description(req)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.13
+  version: 2.1.14
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Monitors Ruby apps and reports detailed metrics on performance to Scout.
 email:
 - support@scoutapp.com
@@ -234,6 +248,7 @@ files:
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
+- test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
@@ -267,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.6.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
@@ -283,6 +298,7 @@ test_files:
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
+- test/unit/instruments/net_http_test.rb
 - test/unit/instruments/percentile_sampler_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
@@ -295,4 +311,3 @@ test_files:
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb
-has_rdoc: