scout_apm 2.4.0.pre → 2.4.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd45ad6c823f8163081d1a4083f1740823351551
-  data.tar.gz: 822bdbc9113c78762a31258b166fe71786bb3448
+  metadata.gz: 08385e64d3b8d96ae39c02f892b637dfd0a9b154
+  data.tar.gz: 3ab13e2996230a611bca4907bd439d5503b05af5
 SHA512:
-  metadata.gz: 6c041d9e89c7dd58588755d805ff88dce9d55ddc38733143e92b32cb1cc8c2d53f577540f69dcc6af8aabb217903ef11c8dc8fe8981e191edc5239c42a1e9317
-  data.tar.gz: 4d70647935de5bcd27fbaa04f3b4a5e657cb01f13e7384ea17f57ee6bbcf5c73b30bfeb7c37c66bda2688069c4b7c5af61e29098a61c293ba06e1f2a3c1358aa
+  metadata.gz: 50d959241a2921399d5d05e67add7b75000782e24ae9276c3a99460b9dcfcb076f72b230c6e35f29cb47f3dd3a75e2fb6487490e084f97403dfe030e4cf7210a
+  data.tar.gz: 6d36b242cc269e99981dae5fda755aa8bee1ef73616e1afc9dbabcd9a81aca3190f42d27fc6dddcc5b7309078b0ad6086e17008720ad90b35af0765f7ec237b2

data/CHANGELOG.markdown

@@ -1,3 +1,12 @@
+# 2.4.0
+
+* Rework agent startup sequence
+
+# 2.3.2
+
+* More robust startup sequence when using `rails server` vs. directly launching an app server
+* Avoid incompatibility with 3rd party gems that aggressively obtain database connections
+
 # 2.3.1
 
 * Fix DevTrace bug

data/lib/scout_apm/agent/exit_handler.rb

@@ -34,6 +34,7 @@ module ScoutApm
       def shutdown
         logger.info "Shutting down ScoutApm"
         return if !context.started?
+        context.shutting_down!
         ::ScoutApm::Agent.instance.stop_background_worker
       end
 

data/lib/scout_apm/agent.rb

@@ -46,7 +46,9 @@ module ScoutApm
       # 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.
-      AppServerLoad.new(context).run
+      #
+      # Save it into a variable to prevent it from ever running twice
+      @app_server_load ||= AppServerLoad.new(context).run
 
       logger.info "Scout Agent [#{ScoutApm::VERSION}] installed"
 
@@ -61,8 +63,12 @@ module ScoutApm
     # installed, and starting the background worker.
     #
     # Does not attempt to start twice.
-    def start
-      return if context.started?
+    def start(_opts={})
+      if context.started?
+        start_background_worker unless background_worker_running?
+        return
+      end
+
       install unless context.installed?
 
       context.started!
@@ -127,15 +133,24 @@ module ScoutApm
     #  Background Worker Lifecycle  #
     #################################
 
-    def start_background_worker
+    # Creates the worker thread. The worker thread is a loop that runs continuously. It sleeps for +Agent#period+ and when it wakes,
+    # processes data, either saving it to disk or reporting to Scout.
+    # => true if thread & worker got started
+    # => false if it wasn't started (either due to already running, or other preconditions)
+    def start_background_worker(quiet=false)
       if !context.config.value('monitor')
-        logger.debug "Not starting background worker as monitoring isn't enabled."
+        logger.debug "Not starting background worker as monitoring isn't enabled." unless quiet
         return false
       end
 
       if background_worker_running?
-        logger.info "Not starting background worker, already started"
-        return
+        logger.info "Not starting background worker, already started" unless quiet
+        return false
+      end
+
+      if context.shutting_down?
+        logger.info "Not starting background worker, already in process of shutting down" unless quiet
+        return false
       end
 
       logger.info "Initializing worker thread."
@@ -150,6 +165,8 @@ module ScoutApm
           periodic_work.run
         }
       end
+
+      return true
     end
 
     def stop_background_worker

data/lib/scout_apm/agent_context.rb

@@ -75,6 +75,10 @@ module ScoutApm
       @started
     end
 
+    def shutting_down?
+      @shutting_down
+    end
+
     def installed?
       @installed
     end
@@ -157,6 +161,10 @@ module ScoutApm
       @started = true
     end
 
+    def shutting_down!
+      @shutting_down = true
+    end
+
     def store=(store)
       @store = store
 

data/lib/scout_apm/app_server_load.rb

@@ -43,6 +43,10 @@ module ScoutApm
         :paas               => to_s_safe(environment.platform_integration.name),
         :git_sha            => to_s_safe(environment.git_revision.sha)
       }
+    ensure
+      # Sometimes :database_engine and :database_adapter can cause a reference to an AR connection.
+      # Make sure we release all AR connections held by this thread.
+      ActiveRecord::Base.clear_active_connections! if Utils::KlassHelper.defined?("ActiveRecord::Base")
     end
 
     # Calls `.to_s` on the object passed in.

data/lib/scout_apm/tracked_request.rb

@@ -295,8 +295,26 @@ module ScoutApm
         trace = converter.call
         ScoutApm::InstantReporting.new(trace, instant_key).call
       end
+
+      if web? || job?
+        ensure_background_worker
+      end
     end
 
+    # Ensure the background worker thread is up & running - a fallback if other
+    # detection doesn't achieve this at boot.
+    def ensure_background_worker
+      agent = ScoutApm::Agent.instance
+      agent.start
+
+      if agent.start_background_worker(:quiet)
+        agent.logger.info("Force Started BG Worker")
+      end
+    rescue => e
+      true
+    end
+
+
     # Only call this after the request is complete
     def unique_name
       return nil if ignoring_request?

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.4.0.pre"
+  VERSION = "2.4.0.pre2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.0.pre
+  version: 2.4.0.pre2
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest