scout_rails 1.0.7 → 1.0.8.pre.3

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 1.0.8
+
+* Processing metrics when a process starts + exits to prevent losing in-memory metrics on process exit.
+* Ensuring scope is nil for samplers (could be run when a process is killed before scope is reset)
+
 # 1.0.7
 
 * Sinatra 1.3+ compatibility (alias dispatch! instead of route_eval)

data/lib/scout_rails.rb

@@ -13,6 +13,7 @@ require File.expand_path('../scout_rails/agent/reporting.rb', __FILE__)
 require File.expand_path('../scout_rails/layaway.rb', __FILE__)
 require File.expand_path('../scout_rails/layaway_file.rb', __FILE__)
 require File.expand_path('../scout_rails/config.rb', __FILE__)
+require File.expand_path('../scout_rails/background_worker.rb', __FILE__)
 require File.expand_path('../scout_rails/environment.rb', __FILE__)
 require File.expand_path('../scout_rails/metric_meta.rb', __FILE__)
 require File.expand_path('../scout_rails/metric_stats.rb', __FILE__)

data/lib/scout_rails/agent.rb

@@ -63,27 +63,46 @@ module ScoutRails
       @started = true
       logger.info "Starting monitoring. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
       start_instruments
-      if !start_worker_thread?
+      if !start_background_worker?
         logger.debug "Not starting worker thread"
-        install_passenger_worker_process_event if environment.app_server == :passenger
+        install_passenger_events if environment.app_server == :passenger
         install_unicorn_worker_loop if environment.app_server == :unicorn
         return
       end
-      start_worker_thread
+      start_background_worker
       handle_exit
       logger.info "Scout Agent [#{ScoutRails::VERSION}] Initialized"
     end
     
-    # Placeholder: store metrics locally on exit so those in memory aren't lost. Need to decide
-    # whether we'll report these immediately or just store locally and risk having stale data.
+    # at_exit, calls Agent#shutdown to wrapup metric reporting.
     def handle_exit
       if environment.sinatra? || environment.jruby? || environment.rubinius?
         logger.debug "Exit handler not supported"
       else
-        at_exit { at_exit { logger.debug "Shutdown!" } }
+        at_exit do 
+          logger.debug "Shutdown!"
+          # MRI 1.9 bug drops exit codes.
+          # http://bugs.ruby-lang.org/issues/5218
+          if environment.ruby_19?
+            status = $!.status if $!.is_a?(SystemExit)
+            shutdown
+            exit status if status
+          else
+            shutdown
+          end
+        end # at_exit
       end
     end
     
+    # Called via an at_exit handler, it (1) stops the background worker and (2) runs it a final time. 
+    # The final run ensures metrics are stored locally to the layaway / reported to scoutapp.com. Otherwise,
+    # in-memory metrics would be lost and a gap would appear on restarts.
+    def shutdown
+      return if !started?
+      @background_worker.stop
+      @background_worker.run_once
+    end
+    
     def started?
       @started
     end
@@ -96,14 +115,20 @@ module ScoutRails
     # * A supported application server isn't detected (example: running via Rails console)
     # * A supported application server is detected, but it forks (Passenger). In this case, 
     #   the agent is started in the forked process.
-    def start_worker_thread?
+    def start_background_worker?
       !environment.forking? or environment.app_server == :thin
     end
     
-    def install_passenger_worker_process_event
+    def install_passenger_events
       PhusionPassenger.on_event(:starting_worker_process) do |forked|
         logger.debug "Passenger is starting a worker process. Starting worker thread."
-        self.class.instance.start_worker_thread
+        self.class.instance.start_background_worker
+      end
+      # The agent's at_exit hook doesn't run when a Passenger process stops. 
+      # 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."
+        ScoutRails::Agent.instance.shutdown
       end
     end
     
@@ -112,52 +137,29 @@ module ScoutRails
       Unicorn::HttpServer.class_eval do
         old = instance_method(:worker_loop)
         define_method(:worker_loop) do |worker|
-          ScoutRails::Agent.instance.start_worker_thread
+          ScoutRails::Agent.instance.start_background_worker
           old.bind(self).call(worker)
         end
       end
     end
     
-    # in seconds, time between when the worker thread wakes up and runs.
-    def period
-      60
-    end
-    
     # 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.
-    def start_worker_thread
+    def start_background_worker
       logger.debug "Creating worker thread."
-      @worker_thread = Thread.new do
-        begin
-          logger.debug "Starting worker thread, running every #{period} seconds"
-          next_time = Time.now + period
-          while true do
-            now = Time.now
-            while now < next_time
-              sleep_time = next_time - now
-              sleep(sleep_time) if sleep_time > 0
-              now = Time.now
-            end
-            process_metrics
-            while next_time <= now
-              next_time += period
-            end
-          end
-        rescue
-          logger.debug "Worker Thread Exception!!!!!!!"
-          logger.debug $!.message
-          logger.debug $!.backtrace
-        end
+      @background_worker = ScoutRails::BackgroundWorker.new
+      @background_worker_thread = Thread.new do
+        @background_worker.start { process_metrics }
       end # thread new
       logger.debug "Done creating worker thread."
     end
     
-    # Called from #process_metrics, which is run via the worker thread. 
+    # Called from #process_metrics, which is run via the background worker. 
     def run_samplers
       begin
         cpu_util=@process_cpu.run # returns a hash
         logger.debug "Process CPU: #{cpu_util.inspect} [#{environment.processors} CPU(s)]"
-        store.track!("CPU/Utilization",cpu_util) if cpu_util
+        store.track!("CPU/Utilization",cpu_util,:scope => nil) if cpu_util
       rescue => e
         logger.info "Error reading ProcessCpu"
         logger.debug e.message
@@ -167,7 +169,7 @@ module ScoutRails
       begin
         mem_usage=@process_memory.run # returns a single number, in MB
         logger.debug "Process Memory: #{mem_usage}MB"
-        store.track!("Memory/Physical",mem_usage) if mem_usage
+        store.track!("Memory/Physical",mem_usage,:scope => nil) if mem_usage
       rescue => e
         logger.info "Error reading ProcessMemory"
         logger.debug e.message

data/lib/scout_rails/background_worker.rb

@@ -0,0 +1,43 @@
+# Used to run a given task every 60 seconds. 
+class ScoutRails::BackgroundWorker
+  # in seconds, time between when the worker thread wakes up and runs.
+  PERIOD = 60
+  
+  def initialize
+    @keep_running = true
+  end
+  
+  def stop
+    @keep_running = false
+  end
+  
+  # Runs the task passed to +start+ once.
+  def run_once
+    @task.call if @task
+  end
+  
+  # Starts running the passed block every 60 seconds (starting now).
+  def start(&block)
+    @task = block
+    begin
+      ScoutRails::Agent.instance.logger.debug "Starting Background Worker, running every #{PERIOD} seconds"
+      next_time = Time.now
+      while @keep_running do
+        now = Time.now
+        while now < next_time
+          sleep_time = next_time - now
+          sleep(sleep_time) if sleep_time > 0
+          now = Time.now
+        end
+        @task.call
+        while next_time <= now
+          next_time += PERIOD
+        end
+      end
+    rescue
+      ScoutRails::Agent.instance.logger.debug "Background Worker Exception!!!!!!!"
+      ScoutRails::Agent.instance.logger.debug $!.message
+      ScoutRails::Agent.instance.logger.debug $!.backtrace
+    end
+  end
+end

data/lib/scout_rails/environment.rb

@@ -104,6 +104,10 @@ module ScoutRails
       defined?(JRuby)
     end
     
+    def ruby_19?
+      defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION.match(/^1\.9/)
+    end
+    
     ### framework checks
 
     def sinatra?

data/lib/scout_rails/version.rb

@@ -1,3 +1,3 @@
 module ScoutRails
-  VERSION = "1.0.7"
+  VERSION = "1.0.8.pre.3"
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: scout_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.7
-  prerelease: 
+  version: 1.0.8.pre.3
+  prerelease: 6
 platform: ruby
 authors:
 - Derek Haynes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Monitors a Ruby on Rails application and reports detailed metrics on
   performance to Scout, a hosted monitoring service.
@@ -30,6 +30,7 @@ files:
 - lib/scout_rails/agent.rb
 - lib/scout_rails/agent/logging.rb
 - lib/scout_rails/agent/reporting.rb
+- lib/scout_rails/background_worker.rb
 - lib/scout_rails/config.rb
 - lib/scout_rails/environment.rb
 - lib/scout_rails/instruments/active_record_instruments.rb
@@ -66,9 +67,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: scout_rails
 rubygems_version: 1.8.10