scout 5.6.0.alpha.4 → 5.6.0

data/README.markdown

@@ -4,58 +4,51 @@
 
 ## Installing
 
-Install the Scout gem:
+Scout requires Ruby, and is installed via Ruby Gems:
 
     $ gem install scout
 
-Then simply run:
 
-    $ scout
+## First run from the command line:
 
-to start the installation wizard. You'll need your server key, provided via Scout's web UI, to continue. Scout's web UI also provides additional troubleshooting and Ruby installation instructions.
+    $ scout KEY
 
-## Running the Scout Agent
+`KEY` is the identification key assigned by your account at http://scoutapp.com. When run from the command line, scout should print "success." If not, run in verbose mode to see what the problem is:
 
-The Scout agent has several modes of operation and commands.  The normal, intended usage is through a scheduled interval with no output.
+    $ scout KEY -v
 
-Normal checkin with server:
 
-    $ scout [OPTIONS] SERVER_KEY
+## Scout is normally run through cron
 
-`SERVER_KEY` is the identification key assigned by your account at http://scoutapp.com.
+After you've successfully run Scout from the command line, you should configure it to run every minute via cron. This is how Scout is designed to run on an ongoing basis. Your contab will typically look like this:
 
-Install:
+    * * * * *  deploy /usr/bin/scout KEY
 
-    $ scout
-    $ scout [OPTIONS] install
-    
-Local plugin testing:
+... assuming you are using the global crontab, and "deploy" is the user running Scout.
 
-    $ scout [OPTIONS] test PATH_TO_PLUGIN [PLUGIN_OPTIONS]
 
-`PATH_TO_PLUGIN` is the file system path to a Ruby file that contains a Scout plugin.
+## For a full list of options:
 
-`PLUGIN_OPTIONS` are one or more options in the form:
+    $ scout --help
 
-    key1=val1 key2=val2
-    
-These options will be used for the plugin run. [Lean more about creating your own plugins](https://scoutapp.com/info/creating_a_plugin).
+## Troubleshooting
 
-For a full list of options:
+The `scout troubleshoot` command provides useful troubleshooting information (log of the last run, environment information, and the list of gems).
 
-    scout --help
+Extensive help is available via our website (http://scoutapp.com) and while installing the agent via the Scout web UI.
 
-## Setting up in Cron
 
-Configure Scout to run every minute. Typically, this will look like:
+## Local plugin testing:
 
-    * * * * *  deploy /usr/bin/scout SERVER_KEY
-    
-## Troubleshooting
+    $ scout [OPTIONS] test PATH_TO_PLUGIN [PLUGIN_OPTIONS]
 
-The `scout troubleshoot` command provides useful troubleshooting information (log of the last run, environment information, and the list of gems).
+`PATH_TO_PLUGIN` is the file system path to a Ruby file that contains a Scout plugin.
 
-Extensive help is available via our website (http://scoutapp.com) and while installing the agent via the Scout web UI.
+`PLUGIN_OPTIONS` are one or more options in the form:
+
+    key1=val1 key2=val2
+
+These options will be used for the plugin run. [Lean more about creating your own plugins](https://scoutapp.com/info/creating_a_plugin).
 
 ## Credits / Contact
 

data/lib/scout/command/install.rb

@@ -11,12 +11,9 @@ module Scout
         puts <<-END_INTRO.gsub(/^ {8}/, "")
         === Scout Installation Wizard ===
 
-        You need the Server Key displayed in the Server Settings tab.
-        It looks like:
+        You need the 40-character alphanumeric key displayed on the account page.
 
-          6ecad322-0d17-4cb8-9b2c-a12c4541853f
-
-        Enter the Server Key:
+        Enter the Key:
         END_INTRO
         key = gets.to_s.strip
 

data/lib/scout/command/run.rb

@@ -17,8 +17,13 @@ module Scout
           log.info "Sleeping #{@scout.sleep_interval} sec" if log
           sleep @scout.sleep_interval
         end
-        
-        @scout.fetch_plan
+
+        begin
+          @scout.fetch_plan
+        rescue SystemExit => e
+          puts "Failure. Run with '-v -ldebug' for more information" if $stdin.tty?
+          raise e
+        end
 
         # Spawn or stop streamer as needed
         if @scout.streamer_command.is_a?(String)
@@ -40,9 +45,16 @@ module Scout
           elsif @force
             log.info("overriding checkin schedule with --force and checking in now.") if log
           end
-          create_pid_file_or_exit
-          @scout.run_plugins_by_plan
-          @scout.save_history
+
+          begin
+            create_pid_file_or_exit
+            @scout.run_plugins_by_plan
+            @scout.save_history
+            puts "Successfully reported to #{server}" if $stdin.tty?
+          rescue SystemExit => e
+            puts "Failure. Run with '-v -ldebug' for more information" if $stdin.tty?
+            raise e
+          end
 
           begin
             # Since this is a new checkin, overwrite the existing log

data/lib/scout/server.rb

@@ -60,7 +60,7 @@ module Scout
     def refresh?
       return true if !ping_key or account_public_key_changed? # fetch the plan again if the account key is modified/created
 
-      url=URI.join( @server.sub("https://","http://"), "/clients/#{ping_key}/ping.scout?roles=#{@roles}&host=#{Socket.gethostname}")
+      url=URI.join( @server.sub("https://","http://"), "/clients/#{ping_key}/ping.scout?roles=#{@roles}&hostname=#{Socket.gethostname}")
 
       headers = {"x-scout-tty" => ($stdin.tty? ? 'true' : 'false')}
       if @history["plan_last_modified"] and @history["old_plugins"]

data/lib/scout/server_base.rb

@@ -29,7 +29,7 @@ module Scout
                "/clients/CLIENT_KEY/#{url_name}.scout".
                    gsub(/\bCLIENT_KEY\b/, @client_key).
                    gsub(/\b[A-Z_]+\b/) { |k| options[k.downcase.to_sym] || k },
-               "?roles=#{@roles}&host=#{Socket.gethostname}")
+               "?roles=#{@roles}&hostname=#{Socket.gethostname}&tty=#{$stdin.tty? ? 'y' : 'n'}")
     end
 
     def post(url, error, body, headers = Hash.new, &response_handler)

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.6.0.alpha.4"
+  VERSION = "5.6.0"
 end

data/test/scout_test.rb

@@ -29,6 +29,15 @@ AGENT_LOG = File.join AGENT_DIR, 'latest_run.log'
 PLUGINS_PROPERTIES = File.join AGENT_DIR, 'plugins.properties'
 PATH_TO_TEST_PLUGIN = File.expand_path( File.dirname(__FILE__) ) + '/plugins/temp_plugin.rb'
 
+
+# This is a super simple shim to provide the two methods we use in delayed_job's API:
+# some_ar_instance.delay.some_method, and some_ar_class.delay.some_class_method
+class ActiveRecord::Base
+  def delay; self; end
+  def self.delay; self; end
+end
+
+
 class ScoutTest < Test::Unit::TestCase
   def setup
     load_fixtures :clients, :accounts, :plugins, :subscriptions, :plugin_metas, :roles, :plugin_definitions, :notification_groups
@@ -58,7 +67,7 @@ class ScoutTest < Test::Unit::TestCase
     res=""
     PTY.spawn("bin/scout -s http://localhost:4567 -d #{PATH_TO_DATA_FILE} install ") do | stdin, stdout, pid |
       begin
-        stdin.expect("Enter the Server Key:", 3) do |response|
+        stdin.expect("Enter the Key:", 3) do |response|
           assert_not_nil response, "Agent didn't print prompt for server key"
           stdout.puts @client.key # feed the agent the key
           res=stdin.read.lstrip
@@ -557,12 +566,6 @@ mybar=100
       assert @db_role.plugin_definitions.include?(plugin.plugin_definition), "#{plugin} should be included in the db role"
     end
 
-    # 4th checking -- remove all roles
-    exec_scout(@roles_account.key, "--force")
-    client=@roles_account.clients.last
-    assert_equal 1, client.roles.count
-    assert_equal 0, client.plugins.count
-
   end
 
   ######################
@@ -580,7 +583,7 @@ mybar=100
   end
   
   # Runs the scout command with the given +key+ and options. Returns output from the latest run.
-  # Example: scout(KEY,'-F', '-v -l debug'). 
+  # Example: scout(KEY,'-F', '-v', '-l', 'debug').
   # 
   # Notes:
   # * This runs Scout in the test process - it means exit handlers and spawning processes (for streaming) can't 
@@ -595,6 +598,7 @@ mybar=100
     args += ['-s','http://localhost:4567']
     args += ['-d', PATH_TO_DATA_FILE]
     args += opts if opts.any?
+    # args += ['-v', '-l', 'debug'] # if you want to debug
     Scout::Command.dispatch(args)
     File.read(AGENT_LOG) if File.exist?(AGENT_LOG)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scout
 version: !ruby/object:Gem::Version 
-  version: 5.6.0.alpha.4
+  version: 5.6.0
 platform: ruby
 authors: 
 - Andre Lewis
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-14 00:00:00 -08:00
+date: 2013-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -236,9 +236,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
   version: 
 requirements: []