scout_apm 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18409ba68d80eefddd0a94c5c8f47f7e8061d921
-  data.tar.gz: 7ab7791459924188b16c1551bf3682defd268937
+  metadata.gz: c4c35583425f2cec75988d311df46da4b1cea195
+  data.tar.gz: 3e2b125f355a1a5e89037ecf20e2c2d71e7674e6
 SHA512:
-  metadata.gz: a586e1f036a81decca9bdda9d15735174e1676157af56c78cd1c8251b44046872811bfd2fcb4b017c7c973bd6e7daf8e608169c6958f33542a5b32cf16b29d3f
-  data.tar.gz: fb8e623a8f354686a3c3a37ba7e3b9a16db3e17cbefe58b2f7fad198ce5c70b187e33b0d487fcb3f7f71860e8e9b76d2648f81728d6923fdd71bc8e4efee2b7e
+  metadata.gz: f9a78acc7da99ee83c64974b0b32703016acf296855558c09bf7e72b640cef692d9e366f019e687b8d7cf1f337b8085712efa8d2e8a31b7530d314d8a4f483b2
+  data.tar.gz: 876fd43670907912db636a647cdc858205b73733a4f06ee739bf4c592f70aceb1ed3e153b4a58437cbe63146f2af28a44d15e08924d6f1ab6f58f8b0cc325db8

data/CHANGELOG.markdown

@@ -1,3 +1,10 @@
+# master
+
+# 2.1.2
+
+* Applies `Rails.application.config.filter_parameters` settings to reported transaction trace uris
+* Fix incompatibility with ResqueWeb and middleware instrumentation
+
 # 2.1.1
 
 * Fix an issue with AR instrumentation and complex queries

data/lib/scout_apm/agent.rb

@@ -112,7 +112,10 @@ module ScoutApm
     # It initializes the agent and starts the worker thread (if appropiate).
     def start(options = {})
       @options.merge!(options)
+
       @config = ScoutApm::Config.with_file(@config.value("config_file"))
+      layaway.config = config
+
       init_logger
       logger.info "Attempting to start Scout Agent [#{ScoutApm::VERSION}] on [#{environment.hostname}]"
 

data/lib/scout_apm/instant/middleware.rb

@@ -41,8 +41,7 @@ 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
+        @app = app
       end
 
       def call(env)

data/lib/scout_apm/instruments/action_controller_rails_2.rb

@@ -48,8 +48,7 @@ module ScoutApm
       # specific controller actions.
       def perform_action_with_scout_instruments(*args, &block)
         req = ScoutApm::RequestManager.lookup
-        path = ScoutApm::Agent.instance.config.value("uri_reporting") == 'path' ? request.path : request.fullpath
-        req.annotate_request(:uri => path)
+        req.annotate_request(:uri => request.path) # for security by-default, we don't use request.fullpath which could reveal filtered params.
         req.context.add_user(:ip => request.remote_ip)
         req.set_headers(request.headers)
         req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}") )

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -59,8 +59,7 @@ module ScoutApm
     module ActionControllerRails3Rails4Instruments
       def process_action(*args)
         req = ScoutApm::RequestManager.lookup
-        path = ScoutApm::Agent.instance.config.value("uri_reporting") == 'path' ? request.path : request.fullpath
-        req.annotate_request(:uri => path)
+        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
@@ -84,8 +83,19 @@ module ScoutApm
         ensure
           req.stop_layer
         end
+      end # process_action
+
+      # Given an +ActionDispatch::Request+, formats the uri based on config settings.
+      def scout_transaction_uri(request)
+        case ScoutApm::Agent.instance.config.value("uri_reporting")
+        when 'path'
+          request.path # strips off the query string for more security
+        else # default handles filtered params
+          request.filtered_path
+        end
       end
-    end
+
+    end # ActionControllerRails3Rails4Instruments
   end
 end
 

data/lib/scout_apm/instruments/middleware_summary.rb

@@ -23,7 +23,15 @@ module ScoutApm
           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)
+              if app == mw_stack
+                # Return the raw middleware stack if it equaled app. No
+                # middlewares were created, so nothing to wrap & test.
+                #
+                # Avoids instrumentation of something that doesn't exist
+                mw_stack
+              else
+                MiddlewareSummaryWrapper.new(mw_stack)
+              end
             end
 
             alias_method :build_without_scout_instruments, :build
@@ -45,6 +53,36 @@ module ScoutApm
         ensure
           req.stop_layer
         end
+
+        # Some code (found in resque_web initially) attempts to call methods
+        # directly on `MyApplication.app`, which is the middleware stack.
+        # If it hits our middleware instead of the object at the root of the
+        # app that it expected, then a method it expects will not be there, and an
+        # error thrown.
+        #
+        # Specifically, resque_web assumes `ResqueWeb::Engine.app.url_helpers`
+        # is a method call on rails router for its own Engine, when in fact,
+        # we've added a middleware before it.
+        #
+        # So method_missing just proxies anything to the nested @app object
+        #
+        # While method_missing is not very performant, this is only here to
+        # handle edge-cases in other code, and should not be regularly called
+        def method_missing(sym, *arguments, &block)
+          if @app.respond_to?(sym)
+            @app.send(sym, *arguments, &block)
+          else
+            super
+          end
+        end
+
+        def respond_to?(sym, include_private = false)
+          if @app.respond_to?(sym, include_private)
+            true
+          else
+            super
+          end
+        end
       end
     end
   end

data/lib/scout_apm/layaway.rb

@@ -18,7 +18,7 @@ module ScoutApm
     # Must be sortable as an integer
     TIME_FORMAT = "%Y%m%d%H%M"
 
-    attr_reader :config
+    attr_accessor :config
     attr_reader :environment
 
     def initialize(config, environment)

data/lib/scout_apm/store.rb

@@ -69,14 +69,19 @@ module ScoutApm
 
       @mutex.synchronize {
         reporting_periods.select { |time, rp| force || time.timestamp < current_timestamp.timestamp}.
-                          each   { |time, rp|
-                                   collect_samplers(rp)
-                                   layaway.write_reporting_period(rp)
-                                   reporting_periods.delete(time)
-                                 }
+                          each   { |time, rp| write_reporting_period(layaway, time, rp) }
       }
     end
 
+    def write_reporting_period(layaway, time, rp)
+      collect_samplers(rp)
+      layaway.write_reporting_period(rp)
+    rescue => e
+      ScoutApm::Agent.instance.logger.warn("Failed writing data to layaway file: #{e.message} / #{e.backtrace}")
+    ensure
+      reporting_periods.delete(time)
+    end
+
     ######################################
     # Sampler support
     def add_sampler(sampler)

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.1"
+  VERSION = "2.1.2"
 end
 

data/lib/scout_apm.rb

@@ -157,6 +157,8 @@ if defined?(Rails) && defined?(Rails::VERSION) && defined?(Rails::VERSION::MAJOR
     end
     class Railtie < Rails::Railtie
       initializer 'scout_apm.start' do |app|
+        # Install the middleware every time in development mode.
+        # The middleware is a noop if dev_trace is not enabled in config
         if Rails.env.development?
           app.middleware.use ScoutApm::Instant::Middleware
         end

data/test/unit/store_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+require 'scout_apm/store'
+
+class FakeFailingLayaway
+  def write_reporting_period(rp)
+    raise "Always fails. Sucks."
+  end
+end
+
+class StoreTest < Minitest::Test
+  # TODO: Introduce a clock object to avoid having to use 'force'
+  def test_writing_layaway_removes_timestamps
+    s = ScoutApm::Store.new
+    s.track_one!("Controller", "user/show", 10)
+
+    assert_equal(1, s.reporting_periods.size)
+
+    s.write_to_layaway(FakeFailingLayaway.new, true)
+
+    assert_equal({}, s.reporting_periods)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rusage
@@ -235,6 +235,7 @@ files:
 - test/unit/slow_job_policy_test.rb
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
+- test/unit/store_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
@@ -278,6 +279,7 @@ test_files:
 - test/unit/slow_job_policy_test.rb
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
+- test/unit/store_test.rb
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 has_rdoc: