scout 5.8.8 → 5.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17887658dacdcf2a9af9ffad002a01da70371ee1
-  data.tar.gz: e33d1f81045691d14b119ee8b5505f1be5409e8a
+  metadata.gz: b8225b7bb56901315cf31c6e6d4308b3d2102d60
+  data.tar.gz: e38d3ec3d1c97ddf4a06c1ae5e79c63c16e8fba7
 SHA512:
-  metadata.gz: 2798cc3b483bf9ec3393114e6c6afced138ae8254ecc8ba1841f4725c5b14e53951d35c84c5b4a764f31beca0ce3a5872858cd7d7cab8f1014497b76e5b28b0d
-  data.tar.gz: 09ec0a737b96185bde361c5bf84661a8cf6050bb3f228e3015562a4bc455335e91e3d66b03efc73618611210c72748a8174bf5c70eea6becc47df846f10aa49d
+  metadata.gz: 5f338aa1e81174c811d63c08ab5f01c801b4d4ad9ab34b78762764ae937c7ef6bb5f2ae6ae0c9010c017081c416da96149269e1cb678e111a177c50f697b95d3
+  data.tar.gz: 915f66476f32bc8fd1f3547861a5bbe764761c864988a78593dbcb7ff1724bea2b2ce1a46be2a12b234505656676fc947edc95b41f175c3aa3cef3b658e5eb87

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 5.8.9
+
+* Added support for realtime system metrics (processes, cpu, memory, disks, network devices)
+
 # 5.8.8
 
 * Counters report nil values on initial report, rather than not reporting

data/lib/scout/streamer.rb

@@ -9,7 +9,7 @@ module Scout
 
     # * history_file is the *path* to the history file
     # * plugin_ids is an array of integers
-    def initialize(history_file, streaming_key, p_app_id, p_key, p_secret, plugin_ids, hostname, http_proxy, logger = nil)
+    def initialize(history_file, streaming_key, p_app_id, p_key, p_secret, plugin_ids, system_metric_collectors, hostname, http_proxy, logger = nil)
       @@continue_streaming = true
       @history_file = history_file
       @history      = Hash.new
@@ -42,40 +42,16 @@ module Scout
       # main loop. Continue running until global $continue_streaming is set to false OR we've been running for MAX DURATION
       iteration=1 # use this to log the data at a couple points
       while(streamer_start_time+MAX_DURATION > Time.now && @@continue_streaming) do
-        plugins=[]
-        selected_plugins.each_with_index do |plugin_hash,i|
-          # create an actual instance of the plugin
-          plugin=get_instance_of(plugin_hash)
+        plugins = gather_plugin_reports(selected_plugins)
 
-          start_time=Time.now
-
-          data = {}
-          begin
-            Timeout.timeout(30, PluginTimeoutError) do
-              data = plugin.run
-            end
-          rescue Timeout::Error, PluginTimeoutError
-            error "Plugin took too long to run."
-          end
-
-          duration=((Time.now-start_time)*1000).to_i
-
-          id_and_name = plugin_hash['id_and_name']
-          @history["last_runs"][id_and_name] = start_time
-          @history["memory"][id_and_name]    = data[:memory]
-
-          plugins << {:duration=>duration,
-                     :fields=>plugin.reports.inject{|memo,hash|memo.merge(hash)},
-                     :name=>plugin_hash['name'],
-                     :id=>plugin_hash['id'],
-                     :class=>plugin_hash['code_class']}
-        end
+        system_metric_data = gather_system_metric_reports(system_metric_collectors)
 
         bundle={:hostname=>hostname,
                  :server_time=>Time.now.strftime("%I:%M:%S %p"),
                  :server_unixtime => Time.now.to_i,
                  :num_processes=>`ps -e | wc -l`.chomp.to_i,
-                 :plugins=>plugins }
+                 :plugins=>plugins, 
+                 :system_metrics => system_metric_data}
 
         # stream the data via pusherapp
         begin
@@ -104,6 +80,59 @@ module Scout
     
     private
 
+    def gather_plugin_reports(selected_plugins)
+      plugins = []
+      selected_plugins.each_with_index do |plugin_hash, i|
+        # create an actual instance of the plugin
+        plugin = get_instance_of(plugin_hash)
+        start_time = Time.now
+
+        data = {}
+        begin
+          Timeout.timeout(30, PluginTimeoutError) do
+            data = plugin.run
+          end
+        rescue Timeout::Error, PluginTimeoutError
+          error "Plugin took too long to run."
+        end
+        duration = ((Time.now-start_time) * 1000).to_i
+
+        id_and_name = plugin_hash['id_and_name']
+        @history["last_runs"][id_and_name] = start_time
+        @history["memory"][id_and_name]    = data[:memory]
+
+        plugins << { :duration => duration,
+                     :fields => plugin.reports.inject{|memo,hash|memo.merge(hash)},
+                     :name => plugin_hash['name'],
+                     :id => plugin_hash['id'],
+                     :class => plugin_hash['code_class'] }
+      end
+      plugins
+    end
+
+    def gather_system_metric_reports(system_metric_collectors)
+      system_metric_data = {}
+      all_collectors = { :disk    => ServerMetrics::Disk,
+                         :cpu     => ServerMetrics::Cpu,
+                         :memory  => ServerMetrics::Memory,
+                         :network => ServerMetrics::Network,
+                         :process => ServerMetrics::Processes }
+
+      realtime_collectors = all_collectors.select { |key, klass| system_metric_collectors.include?(key) }
+      realtime_collectors.each_pair do |key, klass|
+        begin
+          collector_previous_run = @history[:server_metrics][key]
+          collector = collector_previous_run.is_a?(Hash) ? klass.from_hash(collector_previous_run) : klass.new() # continue with last run, or just create new
+          system_metric_data[key] = collector.run
+          @history[:server_metrics][key] = collector.to_hash # store its state for next time
+        rescue Exception => e
+          raise if e.is_a?(SystemExit)
+          error "Problem running server/#{key} metrics: #{e.message}: \n#{e.backtrace.join("\n")}"
+        end
+      end
+      system_metric_data
+    end
+      
     # Compile instances of the plugins specified in the passed plugin_ids
     def compile_plugins(all_plugins,plugin_ids)
       num_classes_compiled=0
@@ -199,4 +228,4 @@ module Scout
     end
 
   end
-end
+end

data/lib/scout/streamer_daemon.rb

@@ -11,17 +11,19 @@ module Scout
                               :sync_log => true,
                               :working_dir => File.dirname(history_file)}
 
-      # streamer command might look like: start,A0000000000123,a,b,c,1,3
+      # streamer command might look like: start,A0000000000123,a,b,c,1,3,cpu,memory
       tokens = streamer_command.split(",")
       tokens.shift # gets rid of the "start"
       streaming_key = tokens.shift
       p_app_id = tokens.shift
       p_key = tokens.shift
       p_secret = tokens.shift
-      plugin_ids = tokens.map(&:to_i)
+      numerical_tokens = tokens.select { |token| token =~ /\A\d+\Z/ }
+      system_metric_collectors = (tokens - numerical_tokens).map(&:to_sym)
+      plugin_ids = numerical_tokens.map(&:to_i)
 
       # we use STDOUT for the logger because daemon_spawn directs STDOUT to a log file
-      streamer_args = [history_file,streaming_key,p_app_id,p_key,p_secret,plugin_ids,hostname,http_proxy,Logger.new(STDOUT)]
+      streamer_args = [history_file,streaming_key,p_app_id,p_key,p_secret,plugin_ids,system_metric_collectors,hostname,http_proxy,Logger.new(STDOUT)]
       if File.exists?(streamer_pid_file)
         Scout::StreamerDaemon.restart(daemon_spawn_options, streamer_args)
       else
@@ -45,8 +47,8 @@ module Scout
 
     # this method is called by DaemonSpawn's class start method.
     def start(streamer_args)
-      history,streaming_key,p_app_id,p_key,p_secret,plugin_ids,hostname,http_proxy,log = streamer_args
-      @scout = Scout::Streamer.new(history, streaming_key, p_app_id, p_key, p_secret, plugin_ids, hostname, http_proxy, log)
+      history,streaming_key,p_app_id,p_key,p_secret,plugin_ids,system_metric_collectors,hostname,http_proxy,log = streamer_args
+      @scout = Scout::Streamer.new(history, streaming_key, p_app_id, p_key, p_secret, plugin_ids, system_metric_collectors, hostname, http_proxy, log)
     end
 
     # this method is called by DaemonSpawn's class stop method.

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.8.8"
+  VERSION = "5.8.9"
 end

data/test/streamer_test.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+begin
+  require 'pry'
+rescue LoadError
+  # not using pry
+end
+# must be loaded after 
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/..' )
+require 'lib/scout'
+require 'mocha/setup'
+
+class StreamerTest < Test::Unit::TestCase
+  def test_reports_system_metrics
+    stub_history_file
+    plugin_ids_stub = []
+    system_metric_collectors = [:disk]
+
+    mock_pusher do
+      streamer = Scout::Streamer.new(:history_file_stub, :streaming_key_stub, :pusher_app_id_stub, :pusher_key_stub, :pusher_secret_stub, plugin_ids_stub, system_metric_collectors, :hostname_stub, :http_proxy_stub)
+    end
+
+    response = Pusher::Channel.streamer_data.first
+    assert_equal [:disk], response[:system_metrics].keys
+  end
+
+  private
+
+  def stub_history_file
+    File.stubs(:read).with(:history_file_stub).returns(YAML.dump({:server_metrics => {}}))
+    File.stubs(:dirname).with(:history_file_stub).returns('tmp')
+  end
+
+  # this with a block to mock the pusher call. You can access the streamer data through the Pusher::Channel.streamer_data
+  # Must be called with a code block
+  def mock_pusher(num_runs=1)
+    # redefine the trigger! method, so the streamer doesn't loop indefinitely. We can't just mock it, because
+    # we need to set the $continue_streaming=false
+    $num_runs_for_mock_pusher=num_runs
+    Pusher::Channel.module_eval do
+      alias orig_trigger! trigger!
+      def self.streamer_data;@@streamer_data;end # for getting the data back out
+      def trigger!(event_name, data, socket=nil)
+        $num_run_for_tests = $num_run_for_tests ? $num_run_for_tests+1 : 1
+        @@streamer_data_temp ||= Array.new
+        @@streamer_data_temp << data
+        if $num_run_for_tests >= $num_runs_for_mock_pusher
+          Scout::Streamer.continue_streaming=false
+          $num_run_for_tests=nil
+          @@streamer_data = @@streamer_data_temp.clone
+          @@streamer_data_temp = nil
+        end
+      end
+    end
+    yield # must be called with a block
+    Pusher::Channel.module_eval do
+      alias trigger! orig_trigger!
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout
 version: !ruby/object:Gem::Version
-  version: 5.8.8
+  version: 5.8.9
 platform: ruby
 authors:
 - Andre Lewis
@@ -81,6 +81,7 @@ files:
 - scout.gemspec
 - test/plugins/disk_usage.rb
 - test/scout_test.rb
+- test/streamer_test.rb
 - vendor/httpclient/README.txt
 - vendor/httpclient/bin/httpclient
 - vendor/httpclient/lib/hexdump.rb