scout 5.4.4.alpha → 5.4.5.alpha

data/.gitignore

@@ -4,3 +4,6 @@ pkg/*
 **/.DS_Store
 .idea
 working_dir/
+.bundle
+.rvmrc
+Gemfile.lock

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in scout.gemspec
 gemspec
+
+group :test do
+  gem "newrelic_rpm"
+  gem "activerecord", "2.2.2"
+  gem "mysql"
+end

data/Rakefile

@@ -5,3 +5,7 @@ require "bundler/gem_tasks"
 # rake build    # Builds gem into the pkg directory
 # rake install  # Build and install the current version into system gems
 # rake release  # Create, tag, build, and publish the current version to rubygems.org
+
+task :test do
+  require "test/scout_test"
+end

data/lib/scout/streamer.rb

@@ -15,40 +15,51 @@ module Scout
       @history      = Hash.new
       @logger       = logger
 
-      @plugins = []
+      @plugin_hashes = []
 
       Pusher.app_id = '11495'
       Pusher.key = 'a95aa7293cd158100246'
       Pusher.secret = '9c13ccfe325fe3ae682d'
 
-      debug "plugin_ids = #{plugin_ids.inspect}"
-      debug "streaming_key = #{streaming_key}"
-
       streamer_start_time = Time.now
 
+      info("Streamer PID=#{$$} starting")
+
       hostname=Socket.gethostname
       # load history
       load_history
 
       # get the array of plugins, AKA the plugin plan
       @plugin_plan = Array(@history["old_plugins"])
-
-      # iterate through the plan and compile each plugin. We only compile plugins once at the beginning of the run
-      @plugin_plan.each do |plugin|
-        begin
-          compile_plugin(plugin) # this is what adds to the @plugin array
-        rescue Exception
-          error("Encountered an error: #{$!.message}")
-          puts $!.backtrace.join('\n')
+      info("Starting streamer with key=#{streaming_key} and plugin_ids: #{plugin_ids.inspect}. #{@history_file} includes plugin ids #{@plugin_plan.map{|p|p['id']}.inspect}")
+
+      # Compile instances of the plugins specified in the passed plugin_ids
+      plugin_ids.each_with_index do |plugin_id,i|
+        plugin_data=@plugin_plan.find{|plugin| plugin['id'] && plugin['id'].to_i == plugin_id}
+        if plugin_data
+          begin
+            plugin=get_instance_of(plugin_data, plugin_id)
+            info("#{i+1}) plugin_id=#{plugin_id} - instance of #{plugin.class.name} created for #{plugin_data['name']}" )
+            if plugin.is_a?(Plugin) # safety check that it's an instance of Plugin
+              @plugin_hashes.push(:instance=>plugin, :id=>plugin_id, :name=>plugin_data['name'])
+            end
+          rescue Exception
+            error("Encountered an error compiling: #{$!.message}")
+            error $!.backtrace.join('\n')
+          end
+        else
+          info("#{i+1}) plugin_id=#{plugin_id} specified in #{plugin_ids.inspect} but not found in #{@history_file}")
         end
       end
 
+      info "Finished compilation. #{@plugin_plan.size} plugins; #{@plugin_hashes.size} instances instantiated"
+
       # 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=[]
-        @plugins.each_with_index do |plugin,i|
-          # ignore plugins whose ids are not in the plugin_ids array -- this also ignores local plugins
-          next if !(@plugin_plan[i]['id'] && plugin_ids.include?(@plugin_plan[i]['id'].to_i))
+        @plugin_hashes.each_with_index do |plugin_hash,i|
+          plugin=plugin_hash[:instance]
           start_time=Time.now
           plugin.reset!
           plugin.run
@@ -56,8 +67,8 @@ module Scout
 
           plugins << {:duration=>duration,
                      :fields=>plugin.reports.inject{|memo,hash|memo.merge(hash)},
-                     :name=>@plugin_plan[i]["name"],
-                     :id=>@plugin_plan[i]["id"]}
+                     :name=>plugin_hash[:name],
+                     :id=>plugin_hash[:id]}
         end
 
         bundle={:hostname=>hostname,
@@ -72,6 +83,11 @@ module Scout
           error "Error pushing data: #{e.message}"
         end
 
+        if iteration == 2 || iteration == 100
+          info "Run #{iteration} data dump:"
+          info bundle.to_json
+        end
+
         if false
           # debugging
           File.open(File.join(File.dirname(@history_file),"debug.txt"),"w") do |f|
@@ -81,27 +97,18 @@ module Scout
         end
 
         sleep(SLEEP)
+        iteration+=1
       end
+
+      info("Streamer PID=#{$$} ending.")
     end
 
     
     private
 
-    #def post_bundle(bundle)
-    #  post( urlify(:stream),
-    #        "Unable to stream to server.",
-    #        bundle.to_json,
-    #        "Content-Type"     => "application/json")
-    #rescue Exception
-    #  error "Unable to stream to server."
-    #  debug $!.class.to_s
-    #  debug $!.message
-    #  debug $!.backtrace.join("\n")
-    #end
-
-    # sets up the @plugins array
-    def compile_plugin(plugin)
-      plugin_id = plugin['id']
+    # plugin is a hash of plugin data from the history file (id, name, code, etc).
+    # This plugin returns an instantiated instance of the plugin
+    def get_instance_of(plugin, plugin_id)
 
       # take care of plugin overrides
       local_path = File.join(File.dirname(@history_file), "#{plugin_id}.rb")
@@ -111,27 +118,30 @@ module Scout
         code_to_run=plugin['code'] || ""
       end
 
-      id_and_name = "#{plugin['id']}-#{plugin['name']}".sub(/\A-/, "")
+      id_and_name = "#{plugin_id}-#{plugin['name']}".sub(/\A-/, "")
       last_run    = @history["last_runs"][id_and_name] ||
                     @history["last_runs"][plugin['name']]
       memory      = @history["memory"][id_and_name] ||
                     @history["memory"][plugin['name']]
       options=(plugin['options'] || Hash.new)
       options.merge!(:tuner_days=>"")
+
       code_class=Plugin.extract_code_class(code_to_run)
-      begin
+
+      # eval the plugin code if it's not already defined
+      if !Plugin.const_defined?(code_class)
         eval(code_to_run, TOPLEVEL_BINDING, plugin['path'] || plugin['name'] )
-        klass=Plugin.const_get(code_class)
-        info "Added a #{klass.name} plugin, id = #{plugin_id}"
-        @plugins << klass.load(last_run, (memory || Hash.new), options)
+      end
 
-        # turn certain methods into null-ops, so summaries aren't generated. Note that this is ad-hoc, and not future-proof.
-        if klass.name=="RailsRequests"; def klass.analyze;end;end
-        if klass.name=="ApacheAnalyzer"; def klass.generate_log_analysis;end;end
+      # now that we know the class is defined, reference its class
+      klass=Scout::Plugin.const_get(code_class)
 
-      rescue Exception
-        error "Plugin would not compile: #{$!.message}"
-      end
+      # turn certain methods into null-ops, so summaries aren't generated. Note that this is ad-hoc, and not future-proof.
+      if klass.name=="RailsRequests"; def klass.analyze;end;end
+      if klass.name=="ApacheAnalyzer"; def klass.generate_log_analysis;end;end
+
+      # finally, return an instance of the plugin
+      klass.load(last_run, (memory || Hash.new), options)
     end
 
 
@@ -156,7 +166,5 @@ module Scout
       end
     end
 
-    def growl(message)`growlnotify -m '#{message.gsub("'","\'")}'`;end
-
   end
 end

data/lib/scout/streamer_control.rb

@@ -3,12 +3,12 @@ module Scout
 
     # args are: server, key, history, plugin_ids, streaming_key, log
     def start(args)
-      puts "StreamerControl#start PID=#{pid}"
+      #puts "StreamerControl#start PID=#{pid}"
       server,key,history,plugin_ids,streaming_key,log = args
-      $continue_streaming = true #
+      $continue_streaming = true #needed for streamer to loop
 
       @scout = Scout::Streamer.new(server, key, history, plugin_ids, streaming_key, log)
-      puts "StreamerControl - done. Removing pid_file at #{pid_file} containing PID=#{pid}"
+      # puts "StreamerControl - done. Removing pid_file at #{pid_file} containing PID=#{pid}"
       File.unlink(pid_file) if File.exists?(pid_file) # a better way of doing this?
     end
 

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.4.4.alpha"
+  VERSION = "5.4.5.alpha"
 end

data/test/scout_test.rb

@@ -5,6 +5,7 @@
 #
 $VERBOSE=nil
 $LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/..' )
 require 'test/unit'
 require 'lib/scout'
 require "pty"
@@ -392,66 +393,58 @@ mybar=100
     File.open(local_path,"w"){|f|f.write(code)}
 
     scout(@client.key)
-
     assert_equal plugin_count+1, @client.reload.plugins.count, "there should be one additional plugin records -- created from the local plugin"
-
     File.delete(local_path)
   end
 
+  # Streamer tests
 
+  # includes two plugins of the same class
   def test_streamer_plugin_compilation
-    # 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
-    Pusher::Channel.module_eval do
-      alias orig_trigger! trigger!
-      def trigger!(event_name, data, socket=nil)
-        $streamer_data = data
-        $continue_streaming=false
+    mock_pusher do
+      plugins=[]
+      plugins << create_plugin(@client, "AclPlugin_1", PLUGIN_FIXTURES[:acl][:code], PLUGIN_FIXTURES[:acl][:sig])
+      plugins << create_plugin(@client, "XYZ Plugin",  PLUGIN_FIXTURES[:xyz][:code], PLUGIN_FIXTURES[:xyz][:sig])
+      plugins << create_plugin(@client, "AclPlugin_2", PLUGIN_FIXTURES[:acl][:code], PLUGIN_FIXTURES[:acl][:sig])
+
+      scout(@client.key) # to write the initial history file. Sinatra MUST be running
+      $continue_streaming = true # so the streamer will run once
+      streamer=Scout::Streamer.new("http://none", "bogus_client_key", PATH_TO_DATA_FILE, [@client.plugins.first.id]+plugins.map(&:id), "bogus_streaming_key",nil) # for debugging, make last arg Logger.new(STDOUT)
+      res = $streamer_data # $streamer_data via the mock_streamer call
+
+      assert res.is_a?(Hash)
+      assert res[:plugins].is_a?(Array)
+      assert_equal 4, res[:plugins].size
+      assert_equal 2, res[:plugins][0][:fields][:load]
+      assert_equal 1, res[:plugins][1][:fields][:value]
+      assert_equal 2, res[:plugins][2][:fields][:value]
+      assert_equal 1, res[:plugins][3][:fields][:value]
+    end # end of mock_pusher
+  end
+
+  def test_streamer_with_local_plugin
+    local_path=File.join(AGENT_DIR,"my_local_plugin.rb")
+    code=<<-EOC
+      class LocalPluginTest < Scout::Plugin
+        def build_report; report(:answer=>42);end
       end
-    end
-    plugins=[]
-    acl_code="class AclPlugin < Scout::Plugin;def build_report; report(:value=>1);end;end"
-    acl_sig=<<EOS
-QT/IYlR+/3h0YwBAHJeFz4HRFlisocVGorafNYJSYJC5RaUKqxu3dM+bOU4P
-mQ5SmAt1mtXD5BJy2MeHam7Y8HAiWJbDBB318feZrC6xI2amu1b1/YMUyY8y
-fMXS9z8J+ABsFIyV26av1KLxU1EHxi9iKxPwMg0HKJhTBStX4uIyncr/+ZSS
-QKywEwPIPihFFyh9B2Z5WVSHtGcZG9CXDa20hrbQoNutOTniTkr00evBItYL
-FN4L0F0ApIjTTkZW2vjzNR59j8HfZ7zrPfy33VhJkyAS0o9nQt5v0J5wKHj1
-c3egj/Ffn/zSWZ1cTf3VSpfrGKUAlyB9KphZeYv2Og==
-EOS
-    plugins << create_plugin(@client, "AclPlugin_1", acl_code, acl_sig)
-
-    code="class XYZPlugin < Scout::Plugin;def build_report; report(:value=>2);end;end"
-    sig=<<EOS
-6cNcDCM2GWcoT1Iqri+XFPgAiMxQaf0b8kOi4KKafNVD94cPkcy6OknNeQUM
-v6GYcfGCAsiZvnjl/2wsqjvrAl/zyuSW/s5YLsjxca1LEvhkyxbpnDGuj32k
-3IuWKQ6JuEbmPXPP1aFsosOm7dbTCrjEn1fDQWAzmfCwznHV3MiqzvPD2D9g
-7gtxXcblNP6hm7A6AlBzP0hwYORR//gpLLGtmT5ewltHUj9aSUY0GQle3lvH
-/uzBDoV1x6mEYR2jPO5QQxL3BvTBvpC06ec8M/ZWbO9IwA7/DOs+vYfngxlp
-jbtpAK9QCaAalKy/Z29os/7aViHy9z9IVCpC/z3MDA==
-EOS
-    plugins << create_plugin(@client, "XYZ Plugin", code, sig)
-
-    plugins << create_plugin(@client, "AclPlugin_2", acl_code, acl_sig)
-
-    scout(@client.key) # to write the initial history file. Sinatra MUST be running
-    $continue_streaming = true # so the streamer will run once
-    streamer=Scout::Streamer.new("http://none", "bogus_client_key", PATH_TO_DATA_FILE, [@client.plugins.first.id]+plugins.map(&:id), "bogus_streaming_key",nil) # for debugging, make last arg Logger.new(STDOUT)
-    res = $streamer_data # $streamer_data is set in the Channel.trigger! method we temporarily defined above
+    EOC
+    File.open(local_path,"w"){|f|f.write(code)}
+    scout(@client.key)
 
-    assert res.is_a?(Hash)
-    assert res[:plugins].is_a?(Array)
-    assert_equal 4, res[:plugins].size
-    assert_equal 2, res[:plugins][0][:fields][:load]
-    assert_equal 1, res[:plugins][1][:fields][:value]
-    assert_equal 2, res[:plugins][2][:fields][:value]
-    assert_equal 1, res[:plugins][3][:fields][:value]
+    mock_pusher do
+      $continue_streaming = true # so the streamer will run once
+      streamer=Scout::Streamer.new("http://none", "bogus_client_key", PATH_TO_DATA_FILE, [@client.plugins.first.id], "bogus_streaming_key",nil) # for debugging, make last arg Logger.new(STDOUT)
+      res = $streamer_data # $streamer_data via the mock_streamer call
 
-    Pusher::Channel.module_eval do
-      alias trigger! orig_trigger!
-    end
+      assert res.is_a?(Hash)
+      assert res[:plugins].is_a?(Array)
+      assert_equal 1, res[:plugins].size
+      assert_equal 2, res[:plugins][0][:fields][:load]
+    end # end of mock_pusher
   end
 
+
   # test streamer starting and stopping
   def test_streamer_process_management
     streamer_pid_file = File.join(AGENT_DIR, "scout_streamer.pid")
@@ -460,13 +453,14 @@ EOS
 
     assert !File.exist?(streamer_pid_file)
 
-    assert @client.update_attribute(:streamer_command, "start,abc,1,3")
+    assert @client.update_attribute(:streamer_command, "start,A0000000000123,1,3")
     scout(@client.key)
     assert File.exist?(streamer_pid_file)
     process_id = File.read(streamer_pid_file).to_i
     assert process_running?(process_id)
     assert_nil @client.reload.streamer_command
 
+    sleep 2
     assert @client.update_attribute(:streamer_command, "stop")
     scout(@client.key)
     assert !File.exist?(streamer_pid_file)
@@ -578,7 +572,7 @@ EOS
     end    
   end
 
-  # see scout's rake plugin:sign task to create the signatre
+  # see scout's rake plugin:sign task to create the signature
   def create_plugin(client,name, code, signature)
     p=client.plugins.create(:name=>name)
     PluginMeta.create(:plugin=>p)
@@ -591,6 +585,49 @@ EOS
     p
   end
 
+  # this with a block to mock the pusher call. You can access the streamer data through the global $streamer_data
+  # Must be called with a code block
+  def mock_pusher
+    # 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
+    Pusher::Channel.module_eval do
+      alias orig_trigger! trigger!
+      def trigger!(event_name, data, socket=nil)
+        $streamer_data = data
+        $continue_streaming=false
+      end
+    end
+    yield # must be called with a block
+    Pusher::Channel.module_eval do
+      alias trigger! orig_trigger!
+    end
+  end
+
+
+  # Use these to create plugins as needed
+  PLUGIN_FIXTURES={
+      :acl=>{:code=>"class AclPlugin < Scout::Plugin;def build_report; report(:value=>1);end;end",
+             :sig=><<EOS
+QT/IYlR+/3h0YwBAHJeFz4HRFlisocVGorafNYJSYJC5RaUKqxu3dM+bOU4P
+mQ5SmAt1mtXD5BJy2MeHam7Y8HAiWJbDBB318feZrC6xI2amu1b1/YMUyY8y
+fMXS9z8J+ABsFIyV26av1KLxU1EHxi9iKxPwMg0HKJhTBStX4uIyncr/+ZSS
+QKywEwPIPihFFyh9B2Z5WVSHtGcZG9CXDa20hrbQoNutOTniTkr00evBItYL
+FN4L0F0ApIjTTkZW2vjzNR59j8HfZ7zrPfy33VhJkyAS0o9nQt5v0J5wKHj1
+c3egj/Ffn/zSWZ1cTf3VSpfrGKUAlyB9KphZeYv2Og==
+EOS
+      },
+      :xyz=>{:code=>"class XYZPlugin < Scout::Plugin;def build_report; report(:value=>2);end;end",
+             :sig=><<EOS
+6cNcDCM2GWcoT1Iqri+XFPgAiMxQaf0b8kOi4KKafNVD94cPkcy6OknNeQUM
+v6GYcfGCAsiZvnjl/2wsqjvrAl/zyuSW/s5YLsjxca1LEvhkyxbpnDGuj32k
+3IuWKQ6JuEbmPXPP1aFsosOm7dbTCrjEn1fDQWAzmfCwznHV3MiqzvPD2D9g
+7gtxXcblNP6hm7A6AlBzP0hwYORR//gpLLGtmT5ewltHUj9aSUY0GQle3lvH
+/uzBDoV1x6mEYR2jPO5QQxL3BvTBvpC06ec8M/ZWbO9IwA7/DOs+vYfngxlp
+jbtpAK9QCaAalKy/Z29os/7aViHy9z9IVCpC/z3MDA==
+EOS
+      }
+  } # end of PLUGIN_FIXTURES
+
 end
 
 # Connect to AR before running

metadata

@@ -1,39 +1,40 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: scout
-version: !ruby/object:Gem::Version
-  version: 5.4.4.alpha
-  prerelease: 6
+version: !ruby/object:Gem::Version 
+  version: 5.4.5.alpha
 platform: ruby
-authors:
+authors: 
 - Andre Lewis
 - Derek Haynes
 - James Edward Gray II
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-12-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: elif
-  requirement: &70156034409200 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :runtime
-  prerelease: false
-  version_requirements: *70156034409200
-description: ! 'Scout makes monitoring and reporting on your web applications as flexible
-  and simple as possible.
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  Scout makes monitoring and reporting on your web applications as flexible and simple as possible.
 
-'
 email: support@scoutapp.com
-executables:
+executables: 
 - scout
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -219,31 +220,34 @@ 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: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>'
-    - !ruby/object:Gem::Version
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
       version: 1.3.1
+  version: 
 requirements: []
+
 rubyforge_project: scout
-rubygems_version: 1.8.10
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Web-based monitoring, reporting, and alerting for your servers, clusters,
-  and applications.
-test_files:
+summary: Web-based monitoring, reporting, and alerting for your servers, clusters, and applications.
+test_files: 
 - test/plugins/disk_usage.rb
 - test/scout_test.rb