scout 5.8.6 → 5.8.7.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bd2faad548e9481be7072ef0d517fa34204eb5c
+  data.tar.gz: edab687a4b73eaa562d900e6ba81b27859e40e3a
+SHA512:
+  metadata.gz: ed2efa5769da4f8648138e236e8dead6f1f707a2a4743c35cb8f4cc094a885f5be1cc43808a727bbc5b191f28f0d505a57e553e7e154a8fc32cdd124b71a8fa2
+  data.tar.gz: b90907cdbb9d16179fbb296e149f1a54a63260683de351bc047d23d092bd50bd2cad7b2d0dd16dd298fbba540ad2b9f8c79bd01fadc1d6c6c8700777d795e261

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 5.8.7
+
+* Added support for realtime system metrics (processes, cpu, memory, disks, network devices)
+
 # 5.8.6
 
 * Upgrade to use server_metrics 1.2.0 (performance improvements)

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
@@ -71,11 +71,32 @@ module Scout
                      :class=>plugin_hash['code_class']}
         end
 
+        system_metric_data = {}
+        all_collectors = {:disk      => ServerMetrics::Disk,
+                      :cpu       => ServerMetrics::Cpu,
+                      :memory    => ServerMetrics::Memory,
+                      :network   => ServerMetrics::Network,
+                      :processes => 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
+
         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
@@ -199,4 +220,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.6"
+  VERSION = "5.8.7.pre"
 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,66 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: scout
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 5
-  - 8
-  - 6
-  version: 5.8.6
+version: !ruby/object:Gem::Version
+  version: 5.8.7.pre
 platform: ruby
-authors: 
+authors:
 - Andre Lewis
 - Derek Haynes
 - James Edward Gray II
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-03-05 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: elif
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: server_metrics
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: server_metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: |
   The scout gem reports metrics to scoutapp.com, an easy-to-use hosted server monitoring service.
-
 email: support@scoutapp.com
-executables: 
+executables:
 - scout
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.markdown
 - Gemfile
@@ -94,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
@@ -323,40 +311,30 @@ files:
 - vendor/signature/spec/signature_spec.rb
 - vendor/signature/spec/spec_helper.rb
 - vendor/util/lib/core_extensions.rb
-has_rdoc: true
 homepage: http://scoutapp.com
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: scout
-rubygems_version: 1.4.2
+rubygems_version: 2.1.9
 signing_key: 
-specification_version: 3
-summary: Scout is an easy-to-use hosted server monitoring service. The scout Ruby gem reports metrics to our service. The agent runs plugins, configured via the Scout web interface, to monitor a server.
-test_files: 
-- test/plugins/disk_usage.rb
-- test/scout_test.rb
+specification_version: 4
+summary: Scout is an easy-to-use hosted server monitoring service. The scout Ruby
+  gem reports metrics to our service. The agent runs plugins, configured via the Scout
+  web interface, to monitor a server.
+test_files: []
+has_rdoc: