scout_apm 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0a32ed17d0fae5e86bf5e64cfe7f25dfe9d1a77
-  data.tar.gz: 0e910af3eebdef26c093df1f522795aea983d890
+  metadata.gz: bf1eaf130d67f52fcfcf414c6db4347fa4b94521
+  data.tar.gz: 0386d415a40a707645a65662237f0d44b9bbbdd8
 SHA512:
-  metadata.gz: f125f45638df4302321104e62d147725636ce4a31ea69d4ee9ca6b5730fb9673ac4ea3cca1e2cf58ff5874ac4c90ccce2eb737b940ca3780a4741fa531763784
-  data.tar.gz: 78eeec2d2700d0d02c937be30abc4322820935e89bd178a6d31114b86ea2e5d040b57578eccd7043e9c1386b4f2b6ffa1e26c94d52ae8d1c7afbbdf624cdbc1a
+  metadata.gz: 71d5d59042427c3bf1afbd753fb8646e012c6187c940a0f6a2854a6123cbc5259b8297ca168a5d91793d6722b6082cd0a7c5da520399a13085b4ca7fc274cf3a
+  data.tar.gz: a2ca63e84f57dd17828072076d0c1bd1b757caf1ef3f82a7954ca928b4d09c973ebbda094cb6a5d1ecbbf1c28c3813838239ca55be7c2b1c24c50f430fe49559

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 2.1.0
+
+* Added ignore key to configuration to entirely ignore an endpoint. No traces
+  or metrics will be collected. Useful for health-check endpoints.
+* Better logging for DevTrace
+
 # 2.0.0
 
 * Reporting object allocation & mem delta metrics and mem delta for requests and jobs.

data/lib/scout_apm/agent.rb

@@ -20,6 +20,7 @@ module ScoutApm
     attr_reader :slow_request_policy
     attr_reader :slow_job_policy
     attr_reader :process_start_time # used when creating slow transactions to report how far from startup the transaction was recorded.
+    attr_reader :ignored_uris
 
     # Histogram of the cumulative requests since the start of the process
     attr_reader :request_histograms
@@ -115,6 +116,8 @@ module ScoutApm
       init_logger
       logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
 
+      @ignored_uris = ScoutApm::IgnoredUris.new(config.value('ignore'))
+
       if environment.deploy_integration
         logger.info "Starting monitoring for [#{environment.deploy_integration.name}]]."
         return environment.deploy_integration.install

data/lib/scout_apm/config.rb

@@ -75,6 +75,23 @@ module ScoutApm
       end
     end
 
+    # If the passed value is a string, attempt to decode as json
+    # This is a no-op unless the `JSON` constant is defined
+    class JsonCoercion
+      def coerce(val)
+        case val
+        when String
+          if defined?(JSON) && JSON.respond_to?(:parse)
+            JSON.parse(val)
+          else
+            val
+          end
+        else
+          val
+        end
+      end
+    end
+
     # Simply returns the passed in value, without change
     class NullCoercion
       def coerce(val)
@@ -82,10 +99,12 @@ module ScoutApm
       end
     end
 
+
     SETTING_COERCIONS = {
       "monitor"                => BooleanCoercion.new,
       "enable_background_jobs" => BooleanCoercion.new,
       "dev_trace"              => BooleanCoercion.new,
+      "ignore"                 => JsonCoercion.new,
     }
 
 
@@ -137,7 +156,7 @@ module ScoutApm
         'report_format'          => 'json',
         'disabled_instruments'   => [],
         'enable_background_jobs' => true,
-        'ignore_traces' => [],
+        'ignore'                 => [],
         'dev_trace' => false, # false for now so code can live in main branch
       }.freeze
 

data/lib/scout_apm/ignored_uris.rb

@@ -0,0 +1,15 @@
+# On first run, caches the regexes made by the `ignored` configuration setting
+module ScoutApm
+  class IgnoredUris
+    attr_reader :regex
+
+    def initialize(prefixes)
+      regexes = Array(prefixes).map {|prefix| %r{\A#{prefix}} }
+      @regex = Regexp.union(*regexes)
+    end
+
+    def ignore?(uri)
+      !! regex.match(uri)
+    end
+  end
+end

data/lib/scout_apm/instant/middleware.rb

@@ -41,12 +41,13 @@ module ScoutApm
     # Note that this middleware never even gets inserted unless Rails environment is development (See Railtie)
     class Middleware
       def initialize(app)
+        ScoutApm::Agent.instance.logger.info("Activating Scout DevTrace because environment=development and dev_trace=true in scout_apm config")
         @app        = app
       end
 
       def call(env)
         status, headers, response = @app.call(env)
-
+        path, content_type = env['PATH_INFO'], headers['Content-Type']
         if ScoutApm::Agent.instance.config.value('dev_trace')
           if response.respond_to?(:body)
             req = ScoutApm::RequestManager.lookup
@@ -63,8 +64,9 @@ module ScoutApm
               hash.merge!(metadata:metadata)
               payload = ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(hash)
 
-              if env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
-                # Add the payload as a header if it's an AJAX call
+              if env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest' || content_type.include?("application/json")
+                ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This is either AJAX or JSON. Path=#{path}; ContentType=#{content_type}")
+                # Add the payload as a header if it's an AJAX call or JSON
                 headers['X-scoutapminstant'] = payload
                 [status, headers, response]
               else
@@ -77,24 +79,27 @@ module ScoutApm
                 page.add_to_body("<script src='#{apm_host}/instant/scout_instant.js?cachebust=#{Time.now.to_i}'></script>")
                 page.add_to_body("<script>var scoutInstantPageTrace=#{payload};window.scoutInstant=window.scoutInstant('#{apm_host}', scoutInstantPageTrace)</script>")
 
-
                 if response.is_a?(ActionDispatch::Response)
+                  ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This appears to be an HTML page and an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
                   # preserve the ActionDispatch::Response when applicable
                   response.body=[page.res]
                   [status, headers, response]
                 else
+                  ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body. This appears to be an HTML page but not an ActionDispatch::Response. Path=#{path}; ContentType=#{content_type}")
                   # otherwise, just return an array
-                  # TODO: this will break ActionCable repsponse
                   [status, headers, [page.res]]
                 end
               end
             else
+              ScoutApm::Agent.instance.logger.debug("DevTrace: in middleware, dev_trace is active, and response has a body, but no trace was found. Path=#{path}; ContentType=#{content_type}")
               [status, headers, response]
             end
           else
+            # don't log anything here - this is the path for all assets served in development, and the log would get noisy
             [status, headers, response]
           end
         else
+          ScoutApm::Agent.instance.logger.debug("DevTrace: isn't activated via config. Try: SCOUT_DEV_TRACE=true rails server")
           [status, headers, response]
         end
       end

data/lib/scout_apm/layer_converters/slow_request_converter.rb

@@ -39,13 +39,6 @@ module ScoutApm
           allocation_metrics = {}
         end
 
-        (ScoutApm::Agent.instance.config.value("ignore_traces") || []).each do |pattern|
-          if /#{pattern}/ =~ uri
-            ScoutApm::Agent.instance.logger.debug("Skipped recording a trace for #{uri} due to `ignore_traces` pattern: #{pattern}")
-            return nil
-          end
-        end
-
         SlowTransaction.new(uri,
                             scope.legacy_metric_name,
                             root_layer.total_call_time,

data/lib/scout_apm/tracked_request.rb

@@ -222,6 +222,9 @@ module ScoutApm
     def record!
       @recorded = true
 
+      # Bail out early if the user asked us to ignore this uri
+      return if ScoutApm::Agent.instance.ignored_uris.ignore?(annotations[:uri])
+
       # Update immediate and long-term histograms for both job and web requests
       if unique_name != :unknown
         ScoutApm::Agent.instance.request_histograms.add(unique_name, root_layer.total_call_time)

data/lib/scout_apm/utils/backtrace_parser.rb

@@ -1,25 +1,27 @@
 require 'scout_apm/environment'
 
-# Removes actual values from SQL. Used to both obfuscate the SQL and group
-# similar queries in the UI.
+# Given a call stack Array, grabs the first +APP_FRAMES+ callers within the
+# application root directory.
+#
 module ScoutApm
   module Utils
     class BacktraceParser
 
       APP_FRAMES = 3 # will return up to 3 frames from the app stack.
 
-      def initialize(call_stack)
+      attr_reader :call_stack
+
+      def initialize(call_stack, root=ScoutApm::Environment.instance.root)
         @call_stack = call_stack
         # We can't use a constant as it'd be too early to fetch environment info
-        @@app_dir_regex ||= /\A(#{ScoutApm::Environment.instance.root.to_s.gsub('/','\/')}\/)(app\/(.+))/.freeze
+        @@app_dir_regex = %r|#{root}/(.*)|
       end
 
-      # Given a call stack Array, grabs the first +APP_FRAMES+ callers within the application root directory.
       def call
         stack = []
-        @call_stack.each_with_index do |c,i|
+        call_stack.each do |c|
           if m = c.match(@@app_dir_regex)
-            stack << m[2]
+            stack << m[1]
             break if stack.size == APP_FRAMES
           end
         end
@@ -28,4 +30,4 @@ module ScoutApm
 
     end
   end
-end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end
 

data/lib/scout_apm.rb

@@ -63,7 +63,7 @@ require 'scout_apm/platform_integrations/server'
 require 'scout_apm/histogram'
 
 require 'scout_apm/deploy_integrations/capistrano_3'
-#require 'scout_apm/deploy_integrations/capistrano_2'
+# require 'scout_apm/deploy_integrations/capistrano_2'
 
 require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
@@ -88,6 +88,7 @@ require 'allocations'
 
 require 'scout_apm/app_server_load'
 
+require 'scout_apm/ignored_uris.rb'
 require 'scout_apm/utils/active_record_metric_name'
 require 'scout_apm/utils/backtrace_parser'
 require 'scout_apm/utils/installed_gems'
@@ -145,7 +146,7 @@ require 'scout_apm/instant/middleware'
 if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR >= 3 && defined?(Rails::Railtie)
   module ScoutApm
     class Railtie < Rails::Railtie
-      initializer "scout_apm.start" do |app|
+      initializer 'scout_apm.start' do |app|
         # attempt to start on first-request if not otherwise started, which is
         # a good catch-all for Webrick, and Passenger and similar, where we
         # can't detect the running app server until actual requests come in.
@@ -153,11 +154,10 @@ if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR
 
         # Attempt to start right away, this will work best for preloading apps, Unicorn & Puma & similar
         ScoutApm::Agent.instance.start
-
       end
     end
     class Railtie < Rails::Railtie
-      initializer "scout_apm.start" do |app|
+      initializer 'scout_apm.start' do |app|
         if Rails.env.development?
           app.middleware.use ScoutApm::Instant::Middleware
         end
@@ -167,4 +167,3 @@ if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR
 else
   ScoutApm::Agent.instance.start
 end
-

data/test/unit/ignored_uris_test.rb

@@ -0,0 +1,16 @@
+require_relative '../test_helper'
+
+require 'scout_apm/ignored_uris'
+
+class IgnoredUrlsTest < Minitest::Test
+  def test_ignores_prefix
+    i = ScoutApm::IgnoredUris.new(["/slow", "/health"])
+    assert_equal true, i.ignore?("/slow/foo/bar")
+    assert_equal true, i.ignore?("/health?leeches=true")
+  end
+
+  def test_does_not_ignore_inner
+    i = ScoutApm::IgnoredUris.new(["/slow", "/health"])
+    assert_equal false, i.ignore?("/users/2/health")
+  end
+end

data/test/unit/utils/backtrace_parser_test.rb

@@ -0,0 +1,52 @@
+require_relative '../../test_helper'
+require 'scout_apm/utils/backtrace_parser'
+
+class BacktraceParserTest < Minitest::Test
+
+  ################################################################################
+  # Helpers
+
+  def root
+    "/Users/scout/secret-next-big-thing/current"
+  end
+
+  def raw_backtrace(count=10)
+    count.times.map {|i| "#{root}/app/controllers/best_#{i}_controller.rb"}
+  end
+
+  ################################################################################
+  # Tests
+
+  def test_maxes_at_APP_FRAMES
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root).call
+
+    assert_equal ScoutApm::Utils::BacktraceParser::APP_FRAMES, result.length
+  end
+
+  def test_picks_off_top_of_trace
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root).call
+
+    assert_equal false, (result[0] =~ %r|app/controllers/best_0_controller.rb|).nil?
+    assert_equal false, (result[1] =~ %r|app/controllers/best_1_controller.rb|).nil?
+    assert_equal false, (result[2] =~ %r|app/controllers/best_2_controller.rb|).nil?
+  end
+
+  def test_trims_off_root_dir
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root).call
+
+    result.each do |r|
+      assert_equal true, (r =~ %r|#{root}|).nil?
+    end
+  end
+
+  def test_works_on_shorter_backtraces
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace(1), root).call
+
+    assert_equal 1, result.length
+  end
+
+  def test_works_with_no_in_app_frames
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, "/Users/scout/different-secrets").call
+    assert_equal 0, result.length
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rusage
@@ -137,6 +137,7 @@ files:
 - lib/scout_apm/framework_integrations/ruby.rb
 - lib/scout_apm/framework_integrations/sinatra.rb
 - lib/scout_apm/histogram.rb
+- lib/scout_apm/ignored_uris.rb
 - lib/scout_apm/instant/assets/xmlhttp_instrumentation.html
 - lib/scout_apm/instant/middleware.rb
 - lib/scout_apm/instant_reporting.rb
@@ -226,6 +227,7 @@ files:
 - test/unit/config_test.rb
 - test/unit/environment_test.rb
 - test/unit/histogram_test.rb
+- test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
@@ -236,6 +238,7 @@ files:
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
+- test/unit/utils/backtrace_parser_test.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - Proprietary (See LICENSE.md)
@@ -257,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.6
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
@@ -268,6 +271,7 @@ test_files:
 - test/unit/config_test.rb
 - test/unit/environment_test.rb
 - test/unit/histogram_test.rb
+- test/unit/ignored_uris_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
 - test/unit/layaway_test.rb
 - test/unit/metric_set_test.rb
@@ -278,3 +282,5 @@ test_files:
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
+- test/unit/utils/backtrace_parser_test.rb
+has_rdoc: