scout 5.5.8.pre → 5.5.8

data/CHANGELOG.markdown

@@ -1,6 +1,7 @@
-# 5.5.8.pre
+# 5.5.8
 
 * Passing server_name for install + test commands so https_proxy is used.
+* Resetting history file when then client key changes
 
 # 5.5.7
 

data/README.markdown

@@ -22,38 +22,39 @@ Normal checkin with server:
 
     $ scout [OPTIONS] SERVER_KEY
 
+`SERVER_KEY` is the identification key assigned by your account at http://scoutapp.com.
+
 Install:
 
     $ scout
     $ scout [OPTIONS] install
-
+    
 Local plugin testing:
 
     $ scout [OPTIONS] test PATH_TO_PLUGIN [PLUGIN_OPTIONS]
 
-
-`SERVER_KEY` is the identification key assigned by your account at http://scoutapp.com.
-
 `PATH_TO_PLUGIN` is the file system path to a Ruby file that contains a Scout plugin.
 
 `PLUGIN_OPTIONS` are one or more options in the form:
 
     key1=val1 key2=val2
     
-These options will be used for the plugin run.
+These options will be used for the plugin run. [Lean more about creating your own plugins](https://scoutapp.com/info/creating_a_plugin).
+
+For a full list of options:
+
+    scout --help
 
 ## Setting up in Cron
 
 Configure Scout to run every minute. Typically, this will look like:
 
     * * * * *  deploy /usr/bin/scout SERVER_KEY
-
-It's often helpful to log the output to a file. To do so:
-
-    * * * * *  deploy /usr/bin/scout SERVER_KEY > /path/to/anywhere/scout.out 2>&1
     
 ## Troubleshooting
 
+The `scout troubleshoot` command provides useful troubleshooting information (log of the last run, environment information, and the list of gems).
+
 Extensive help is available via our website (http://scoutapp.com) and while installing the agent via the Scout web UI.
 
 ## Credits / Contact

data/lib/scout/server.rb

@@ -24,6 +24,7 @@ module Scout
     attr_reader :directives
     attr_reader :plugin_config
     attr_reader :streamer_command
+    attr_reader :client_key
 
     # Creates a new Scout Server connection.
     def initialize(server, client_key, history_file, logger = nil, server_name=nil, http_proxy='', https_proxy='')
@@ -201,6 +202,27 @@ module Scout
       (@history['directives'] || {})['ping_key']
     end
     
+    def client_key_changed?
+      last_client_key=@history['last_client_key']
+      # last_client_key will be nil on versions <= 5.5.7. when the agent runs after the upgrade, it will no longer 
+      # be nil. don't want to aggressively reset the history file as it clears out memory values which may impact alerts.
+      if last_client_key and client_key != last_client_key
+        warn "The key associated with the history file has changed [#{last_client_key}] => [#{client_key}]."
+        true
+      else
+        false
+      end
+    end
+    
+    # need to load the history file first to determine if the key changed. 
+    # if it has, reset.
+    def recreate_history_if_client_key_changed
+      if client_key_changed?
+        create_blank_history
+        @history = YAML.load(File.read(@history_file))
+      end
+    end
+    
     # Returns the Scout public key for code verification.
     def scout_public_key
       return @scout_public_key if instance_variables.include?('@scout_public_key')
@@ -499,6 +521,7 @@ module Scout
         backup_history_and_recreate(contents,
         "Couldn't parse the history file. Deleting it and resetting to an empty history file. Keeping a backup.")
       end
+      recreate_history_if_client_key_changed
       # YAML interprets an empty file as false. This condition catches that
       if !@history
         info "There is a problem with the history file at '#{@history_file}'. The root cause is sometimes a full disk. "+
@@ -523,7 +546,7 @@ module Scout
     def create_blank_history
       debug "Creating empty history file..."
       File.open(@history_file, "w") do |file|
-        YAML.dump({"last_runs" => Hash.new, "memory" => Hash.new}, file)
+        YAML.dump({"last_runs" => Hash.new, "memory" => Hash.new, "last_client_key" => client_key}, file)
       end
       info "History file created."
     end
@@ -534,6 +557,7 @@ module Scout
     # Ensures reads on the history file don't see a partial write. 
     def save_history
       debug "Saving history file..."
+      @history['last_client_key'] = client_key
       File.open(@history_tmp_file, "w") { |file| YAML.dump(@history, file) }
       FileUtils.mv(@history_tmp_file, @history_file)
       info "History file saved."

data/lib/scout/version.rb

@@ -1,3 +1,3 @@
 module Scout
-  VERSION = "5.5.8.pre"
+  VERSION = "5.5.8"
 end

data/test/scout_test.rb

@@ -123,6 +123,18 @@ class ScoutTest < Test::Unit::TestCase
     scout(@client.key)
     assert File.read(AGENT_LOG).size > log_file_size, "log should be longer after ping"
   end
+  
+  def test_should_reset_history_on_key_change
+    test_should_run_first_time
+    data=YAML::load(File.read(PATH_TO_DATA_FILE))
+    assert_equal @client.ping_key, data['directives']['ping_key']
+    assert_equal @client.key, data['last_client_key']
+    sleep 1
+    exec_scout('INVALIDKEY')
+    data=YAML::load(File.read(PATH_TO_DATA_FILE))
+    assert_equal 'INVALIDKEY', data['last_client_key']
+    assert_nil data['directives']
+  end
 
   def test_should_use_name_option
     scout(@client.key,'--name=My New Server')

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: scout
 version: !ruby/object:Gem::Version
-  version: 5.5.8.pre
-  prerelease: 6
+  version: 5.5.8
+  prerelease: 
 platform: ruby
 authors:
 - Andre Lewis
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elif
-  requirement: &2160671080 !ruby/object:Gem::Requirement
+  requirement: &2157721580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160671080
+  version_requirements: *2157721580
 description: ! 'Scout makes monitoring and reporting on your web applications as flexible
   and simple as possible.
 
@@ -232,9 +232,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: scout
 rubygems_version: 1.8.10