scout_apm 3.0.0.pre16 → 3.0.0.pre17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48d7c95db58d0248a431b10cb8501128892ed804
-  data.tar.gz: cee8126c3395ee5b45c2c42b4523d95e901f2817
+  metadata.gz: 2ca61b61ba4135b8ee89ffb1efb4946f0c0afa44
+  data.tar.gz: d980d2baab58e6ceecf1d54aa97128180cf9052e
 SHA512:
-  metadata.gz: 84c6a1840c5bbdba0770967ded0a6de09d396080c384044c723a53a872ce0b6fec3aa83bf930f8f8f3709f9a50f6b896e3641d53dbe7f9428769ff158b5a49d8
-  data.tar.gz: fe384265d5792579373739d283da2efbcd3eb4fb1f32b0e4281100154b8050b321f7c8bf751ca38fb136e06e5c33cab9366359c80a22e0d90ac9feed180140fa
+  metadata.gz: 5bd058b09d66c99c304af71ca7343462d02dc588230253712462fdad6628f718bad8a33655de42f1eb27ae98e2cec39840f247173e4fe0cf1ef0110dbb727105
+  data.tar.gz: 2cd9079153c0d8f050055ae62e7d3c18531b6e90e6d5a4e12661c0cd5e598ab930584229304d2a44017347f00cb2fada6e407bfbc5b54a8ce871e3df91147f3d

data/CHANGELOG.markdown

@@ -2,9 +2,31 @@
 
 * ScoutProf BETA
 
+# 2.4.3
+
+* Ensure a startup hook runs on forking webservers
+
+# 2.4.2
+
+* Fix shutdown hook for Passenger
+
+# 2.4.1
+
+* Fix logging on STDOUT only platforms (Heroku)
+
 # 2.4.0
 
 * Rework agent startup sequence
+* Install all background job instrumentations if you're running more than one
+* Capture longer individual SQL statements
+* Capture multiple SQL statements if multiple are run during a single AR call.
+
+# 2.3.5
+
+* More robust recovery from stale layaway files
+* Quiet logging when hitting unusual layaway file limits
+* Better naming for Sidekiq delayed method jobs
+* Webrick is only required if actually needed
 
 # 2.3.4
 

data/README.markdown

@@ -1,14 +1,21 @@
-# ScoutApm
+# ScoutApm Ruby Agent
 
-A Ruby gem for detailed Rails application performance analysis. Metrics are reported to [Scout](https://scoutapp.com), a hosted application monitoring service. 
+A Ruby gem for detailed Rails application performance analysis. Metrics are
+reported to [Scout](https://scoutapp.com), a hosted application monitoring
+service.
 
 ## Getting Started
 
-Install the gem:
+Add the gem to your Gemfile
 
-    gem install scout_apm
-    
-Signup for a [Scout](https://apm.scoutapp.com) account and copy the config file to `RAILS_ROOT/config/scout_apm.yml`.
+    gem 'scout_apm'
+
+Update your Gemfile
+
+    bundle install
+
+Signup for a [Scout](https://apm.scoutapp.com) account and put the provided
+config file at `RAILS_ROOT/config/scout_apm.yml`.
 
 Your config file should look like:
 
@@ -22,7 +29,8 @@ Your config file should look like:
 
 ## Docs
 
-For the complete list of supported frameworks, Rubies, etc, see our [help site](http://help.apm.scoutapp.com/).
+For the complete list of supported frameworks, Rubies, configuration options
+and more, see our [help site](http://help.apm.scoutapp.com/).
 
 ## Help
 

data/lib/scout_apm/agent.rb

@@ -48,13 +48,6 @@ module ScoutApm
       context.installed!
 
       if ScoutApm::Agent::Preconditions.check?(context) || force
-        # XXX: Should this happen at application start?
-        # Should this ever happen after fork?
-        # We start a thread in this, which can screw stuff up when we then fork.
-        #
-        # Save it into a variable to prevent it from ever running twice
-        @app_server_load ||= AppServerLoad.new(context).run
-
         start
       end
     end
@@ -75,6 +68,9 @@ module ScoutApm
 
       log_environment
 
+      # Save it into a variable to prevent it from ever running twice
+      @app_server_load ||= AppServerLoad.new(context).run
+
       start_background_worker
     end
 
@@ -124,6 +120,7 @@ module ScoutApm
 
     def should_load_instruments?
       return true if context.config.value('dev_trace')
+      return false unless context.config.value('monitor')
       context.environment.app_server_integration.found? || context.environment.background_job_integrations.any?
     end
 

data/lib/scout_apm/agent_context.rb

@@ -220,7 +220,7 @@ module ScoutApm
         {
           :log_level     => config.value('log_level'),
           :log_file_path => config.value('log_file_path'),
-          :stdout        => config.value('log_stdout'),
+          :stdout        => config.value('log_stdout') || environment.platform_integration.log_to_stdout?,
           :stderr        => config.value('log_stderr'),
           :logger_class  => config.value('log_class'),
         }

data/lib/scout_apm/background_job_integrations/delayed_job.rb

@@ -51,7 +51,6 @@ module ScoutApm
               queue = job.queue || "default"
 
               req = ScoutApm::RequestManager.lookup
-              req.job!
 
               begin
                 latency = Time.now - job.created_at

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -57,7 +57,6 @@ module ScoutApm
     class SidekiqMiddleware
       def call(_worker, msg, queue)
         req = ScoutApm::RequestManager.lookup
-        req.job!
         req.annotate_request(:queue_latency => latency(msg))
 
         queue_layer = ScoutApm::Layer.new('Queue', queue)

data/lib/scout_apm/instruments/action_controller_rails_2.rb

@@ -57,7 +57,6 @@ module ScoutApm
         req.context.add_user(:ip => request.remote_ip)
         req.set_headers(request.headers)
         req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}") )
-        req.web!
 
         begin
           perform_action_without_scout_instruments(*args, &block)

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -77,8 +77,6 @@ module ScoutApm
               req.context.add_user(:ip => request.remote_ip) rescue nil
               req.set_headers(request.headers)
 
-              req.web!
-
               resolved_name = scout_action_name(*args)
               layer = ScoutApm::Layer.new("Controller", "#{controller_path}/#{resolved_name}")
 

data/lib/scout_apm/instruments/grape.rb

@@ -44,7 +44,6 @@ module ScoutApm
         req.context.add_user(:ip => request.ip) rescue nil
 
         req.set_headers(request.headers)
-        req.web!
 
         begin
           name = ["Grape",

data/lib/scout_apm/instruments/resque.rb

@@ -11,7 +11,6 @@ module ScoutApm
         end
 
         req = ScoutApm::RequestManager.lookup
-        req.job!
 
         begin
           req.start_layer(ScoutApm::Layer.new('Queue', queue))

data/lib/scout_apm/layer_converters/find_layer_by_type.rb

@@ -16,6 +16,10 @@ module ScoutApm
         @scope ||= call(["Controller", "Job"])
       end
 
+      def controller
+        @controller ||= call(["Controller"])
+      end
+
       def job
         @job ||= call(["Job"])
       end

data/lib/scout_apm/logger.rb

@@ -40,7 +40,11 @@ module ScoutApm
     def fatal(*args, &block); @logger.fatal(*args, &block); end
 
     def log_level=(level)
-      @logger.level = level
+      @logger.level = log_level_from_opts(level)
+    end
+
+    def log_level
+      @logger.level
     end
 
     def log_file_path
@@ -48,11 +52,11 @@ module ScoutApm
     end
 
     def stdout?
-      @opts[:stdout] || @opts[:log_file_path] == "STDOUT"
+      @opts[:stdout] || (@opts[:log_file_path] || "").upcase == "STDOUT"
     end
 
     def stderr?
-      @opts[:stderr] || @opts[:log_file_path] == "STDERR"
+      @opts[:stderr] || (@opts[:log_file_path] || "").upcase == "STDERR"
     end
 
     private
@@ -86,13 +90,16 @@ module ScoutApm
       end
     end
 
-    def log_level_from_opts
-      case @opts[:log_level]
+    def log_level_from_opts(explicit=nil)
+      candidate = explicit || (@opts[:log_level] || "").downcase
+
+      case candidate
       when "debug" then ::Logger::DEBUG
       when "info" then ::Logger::INFO
       when "warn" then ::Logger::WARN
       when "error" then ::Logger::ERROR
       when "fatal" then ::Logger::FATAL
+      when ::Logger::DEBUG, ::Logger::INFO, ::Logger::WARN, ::Logger::ERROR, ::Logger::FATAL then candidate
       else ::Logger::INFO
       end
     end
@@ -116,11 +123,12 @@ module ScoutApm
     # Check if this path is ok for a log file.
     # Does it exist?
     # Is it writable?
-    # XXX: Implement
     def validate_path(candidate)
-      !candidate.nil?
-    end
+      return false if candidate.nil?
 
+      directory = File.dirname(candidate)
+      File.writable?(directory)
+    end
 
     class DefaultFormatter < ::Logger::Formatter
       def call(severity, time, progname, msg)

data/lib/scout_apm/rack.rb

@@ -10,8 +10,8 @@ module ScoutApm
       req.annotate_request(:uri => env["REQUEST_PATH"]) rescue nil
       req.context.add_user(:ip => env["REMOTE_ADDR"]) rescue nil
 
-      req.web!
-      req.start_layer(ScoutApm::Layer.new('Controller', endpoint_name))
+      layer = ScoutApm::Layer.new('Controller', endpoint_name)
+      req.start_layer(layer)
 
       begin
         yield

data/lib/scout_apm/server_integrations/passenger.rb

@@ -29,7 +29,7 @@ module ScoutApm
         # This does run when a process stops.
         PhusionPassenger.on_event(:stopping_worker_process) do
           logger.debug "Passenger is stopping a worker process, shutting down the agent."
-          ScoutApm::Agent.instance.shutdown
+          ScoutApm::Agent.instance.stop_background_worker
         end
       end
 

data/lib/scout_apm/tracked_request.rb

@@ -26,10 +26,6 @@ module ScoutApm
     # Can be nil if we never reach a Rails Controller
     attr_reader :headers
 
-    # What kind of request is this? A trace of a web request, or a background job?
-    # Use job! and web! to set, and job? and web? to query
-    attr_reader :request_type
-
     # This maintains a lookup hash of Layer names and call counts. It's used to trigger fetching a backtrace on n+1 calls.
     # Note that layer names might not be Strings - can alse be Utils::ActiveRecordMetricName. Also, this would fail for layers
     # with same names across multiple types.
@@ -249,20 +245,14 @@ module ScoutApm
       @headers = headers
     end
 
-    def job!
-      @request_type = "job"
-    end
-
+    # This request is a job transaction iff it has a 'Job' layer
     def job?
-      request_type == "job"
-    end
-
-    def web!
-      @request_type = "web"
+      layer_finder.job != nil
     end
 
+    # This request is a web transaction iff it has a 'Controller' layer
     def web?
-      request_type == "web"
+      layer_finder.controller != nil
     end
 
     def instant?
@@ -306,7 +296,6 @@ module ScoutApm
         LayerConverters::SlowRequestConverter,
       ]
 
-      layer_finder = LayerConverters::FindLayerByType.new(self)
       walker = LayerConverters::DepthFirstWalker.new(self.root_layer)
       converters = converters.map do |klass|
         instance = klass.new(@agent_context, self, layer_finder, @store)
@@ -328,6 +317,10 @@ module ScoutApm
       end
     end
 
+    def layer_finder
+      @layer_finder ||= LayerConverters::FindLayerByType.new(self)
+    end
+
     # Ensure the background worker thread is up & running - a fallback if other
     # detection doesn't achieve this at boot.
     def ensure_background_worker

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "3.0.0.pre16"
+  VERSION = "3.0.0.pre17"
 end

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -11,7 +11,6 @@ class SidekiqTest < Minitest::Test
   def test_middleware_call_happy_path
     fake_request = mock
     fake_request.expects(:annotate_request)
-    fake_request.expects(:job!)
     fake_request.expects(:start_layer).twice
     fake_request.expects(:stop_layer).twice
     fake_request.expects(:error!).never
@@ -29,7 +28,6 @@ class SidekiqTest < Minitest::Test
   def test_middleware_call_job_exception
     fake_request = mock
     fake_request.expects(:annotate_request)
-    fake_request.expects(:job!)
     fake_request.expects(:start_layer).twice
     fake_request.expects(:stop_layer).twice
     fake_request.expects(:error!)
@@ -47,7 +45,6 @@ class SidekiqTest < Minitest::Test
   def test_middleware_call_edge_cases
     fake_request = mock
     fake_request.expects(:annotate_request)
-    fake_request.expects(:job!)
     fake_request.expects(:start_layer).twice
     fake_request.expects(:stop_layer).twice
     fake_request.expects(:error!)

data/test/unit/logger_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+require 'scout_apm/logger'
+
+class LoggerTest < Minitest::Test
+  def setup
+    @env_root = Pathname.new(File.dirname(__FILE__)) + "../../"
+  end
+
+  def test_detect_stdout
+    logger = ScoutApm::Logger.new("", { :log_file_path => "STDOUT"})
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+
+    # and lowercase
+    logger = ScoutApm::Logger.new("", { :log_file_path => "stdout"})
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_force_stdout
+    logger = ScoutApm::Logger.new("", { :stdout => true })
+    assert logger.stdout?
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_pick_log_file_with_no_options
+    logger = ScoutApm::Logger.new(@env_root, { })
+    assert_equal (@env_root + "log" + "scout_apm.log").to_s, logger.log_destination
+  end
+
+  def test_pick_log_file_with_different_dir
+    logger = ScoutApm::Logger.new(@env_root, { :log_file_path => "/tmp" })
+    assert_equal "/tmp/scout_apm.log", logger.log_destination
+  end
+
+  def test_pick_log_file_invalid_dir
+    logger = ScoutApm::Logger.new(@env_root, { :log_file_path => "/not_a_real_dir" })
+    assert_equal STDOUT, logger.log_destination
+  end
+
+  def test_pick_log_dir_not_writable
+    Dir.mktmpdir { |dir|
+      # An unwritable dir
+      FileUtils.chmod(0000, dir)
+      logger = ScoutApm::Logger.new(@env_root, { :log_file_path => dir })
+      assert_equal STDOUT, logger.log_destination
+
+      # so it can be deleted
+      FileUtils.chmod(0700, dir)
+    }
+  end
+
+  def test_set_log_level
+    logger = ScoutApm::Logger.new(@env_root, { :log_level => "debug" })
+    assert_equal ::Logger::DEBUG, logger.log_level
+  end
+
+  def test_set_log_level_after
+    logger = ScoutApm::Logger.new(@env_root, { :log_level => "debug" })
+    logger.log_level = "info"
+    assert_equal ::Logger::INFO, logger.log_level
+
+    logger.log_level = ::Logger::ERROR
+    assert_equal ::Logger::ERROR, logger.log_level
+  end
+end

data/test/unit/test_tracked_request.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class TrackedRequestDumpAndLoadTest < Minitest::Test
   # TrackedRequest must be marshalable
   def test_marshal_dump_load
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
+    tr = ScoutApm::TrackedRequest.new(ScoutApm::AgentContext.new, ScoutApm::FakeStore.new)
     tr.prepare_to_dump!
 
     dumped = Marshal.dump(tr)
@@ -12,58 +12,22 @@ class TrackedRequestDumpAndLoadTest < Minitest::Test
   end
 
   def test_restore_store
-    faux = ScoutApm::FakeStore.new
-    tr = ScoutApm::TrackedRequest.new(faux)
-    assert_equal faux, tr.instance_variable_get("@store")
+    faux_store = ScoutApm::FakeStore.new
+    context = ScoutApm::AgentContext.new
+    tr = ScoutApm::TrackedRequest.new(context, faux_store)
+    assert_equal faux_store, tr.instance_variable_get("@store")
 
     tr.prepare_to_dump!
     assert_nil tr.instance_variable_get("@store")
 
     tr.restore_store
-    assert_equal ScoutApm::Agent.instance.store, tr.instance_variable_get("@store")
-  end
-end
-
-class TrackedRequestFlagsTest < Minitest::Test
-  def test_set_web
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
-    assert_false tr.web?
-    tr.web!
-    assert tr.web?
-  end
-
-  def test_set_job
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
-    assert ! tr.job?
-    tr.job!
-    assert tr.job?
-  end
-
-  def test_set_error
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
-    assert_false tr.error?
-    tr.error!
-    assert tr.error?
-  end
-
-  def test_set_error_and_web
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
-    assert_false tr.error?
-    assert_false tr.web?
-
-    tr.web!
-    assert_false tr.error?
-    assert tr.web?
-
-    tr.error!
-    assert tr.error?
-    assert tr.web?
+    assert_equal context.store, tr.instance_variable_get("@store")
   end
 end
 
 class TrackedRequestLayerManipulationTest < Minitest::Test
   def test_start_layer
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
+    tr = ScoutApm::TrackedRequest.new(ScoutApm::AgentContext.new, ScoutApm::FakeStore.new)
     tr.start_layer(ScoutApm::Layer.new("Foo", "Bar"))
 
     assert_equal "Foo", tr.current_layer.type
@@ -74,7 +38,7 @@ class TrackedRequestLayerManipulationTest < Minitest::Test
     controller_layer = ScoutApm::Layer.new("Controller", "users/index")
     ar_layer = ScoutApm::Layer.new("ActiveRecord", "Users#find")
 
-    tr = ScoutApm::TrackedRequest.new(ScoutApm::FakeStore.new)
+    tr = ScoutApm::TrackedRequest.new(ScoutApm::AgentContext.new, ScoutApm::FakeStore.new)
     tr.start_layer(controller_layer)
     tr.start_layer(ar_layer)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre16
+  version: 3.0.0.pre17
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -335,6 +335,7 @@ files:
 - test/unit/layer_converters/metric_converter_test.rb
 - test/unit/layer_converters/stubs.rb
 - test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
 - test/unit/metric_set_test.rb
 - test/unit/remote/test_message.rb
 - test/unit/remote/test_router.rb
@@ -399,6 +400,7 @@ test_files:
 - test/unit/layer_converters/metric_converter_test.rb
 - test/unit/layer_converters/stubs.rb
 - test/unit/limited_layer_test.rb
+- test/unit/logger_test.rb
 - test/unit/metric_set_test.rb
 - test/unit/remote/test_message.rb
 - test/unit/remote/test_router.rb