scout 5.5.8 → 5.5.9.pre

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 5.5.9
+
+* Locking data file when writing.
+
 # 5.5.8
 
 * Passing server_name for install + test commands so https_proxy is used.

data/lib/scout.rb

@@ -10,3 +10,4 @@ require "scout/server"
 require "scout/streamer"
 require "scout/daemon_spawn"
 require "scout/streamer_daemon"
+require "scout/data_file"

data/lib/scout/data_file.rb

@@ -0,0 +1,50 @@
+# Used to perform locked, atomic writes to the data file. 
+module Scout
+  class DataFile
+    attr_accessor :path, :logger
+    attr_reader :data
+    
+    def initialize(path,logger)
+      @path = path
+      @logger = logger
+    end
+    
+    # atomic_write first writes to the tmp file.
+    def tmp_path
+      path+'.tmp'
+    end
+    
+    # saves the data file by (1) locking the file at +path+ to ensure other processes 
+    # don't overlap (2) using an atomic write to ensure other processes always read a complete file.
+    def save(content)
+      lock do
+        atomic_write(content)
+      end
+    end
+    
+    private
+    
+    def lock
+      File.open(path, File::RDWR | File::CREAT) do |f|
+        begin
+          f.flock(File::LOCK_EX)
+          yield
+        ensure
+          f.flock(File::LOCK_UN)          
+        end
+      end
+    rescue Errno::ENOENT, Exception  => e
+      logger.error("Unable to access data file [#{e.message}]")
+    end
+    
+    # Uses an Atomic Write - first writes to a tmp file then replace the history file. 
+    # Ensures reads on the history file don't see a partial write.
+    def atomic_write(content)
+      File.open(tmp_path, 'w+') do |f|
+        f.write(content)
+      end
+      FileUtils.mv(tmp_path, path)
+    end
+    
+  end
+end

data/lib/scout/server.rb

@@ -46,6 +46,7 @@ module Scout
       @account_public_key_path = File.join(@local_plugin_path, "scout_rsa.pub")
       @history_tmp_file = history_file+'.tmp'
       @plugin_config = load_plugin_configs(@plugin_config_path)
+      @data_file = Scout::DataFile.new(@history_file,@logger)
 
       # the block is only passed for install and test, since we split plan retrieval outside the lockfile for run
       if block_given?
@@ -56,7 +57,6 @@ module Scout
     end
 
     def refresh?
-      #info "called refresh: ping_key=#{ping_key}"
       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")
@@ -65,7 +65,7 @@ module Scout
       if @history["plan_last_modified"] and @history["old_plugins"]
         headers["If-Modified-Since"] = @history["plan_last_modified"]
       end
-      get(url, "Could not ping #{url} for refresh info", headers) do |res|
+      get(url, "Could not ping #{url} for refresh info", headers) do |res|        
         @streamer_command = res["x-streamer-command"] # usually will be nil, but can be [start,abcd,1234,5678|stop]
         if res.is_a?(Net::HTTPNotModified)
           return false
@@ -545,21 +545,15 @@ module Scout
     # creates a blank history file
     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, "last_client_key" => client_key}, file)
-      end
+      @data_file.save(YAML.dump({"last_runs" => Hash.new, "memory" => Hash.new, "last_client_key" => client_key}))
       info "History file created."
     end
 
     # Saves the history file to disk. 
-    #
-    # Uses an Atomic Write - first writes to a tmp file then replace the history file. 
-    # 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)
+      @data_file.save(YAML.dump(@history))
       info "History file saved."
     end
 

data/lib/scout/version.rb

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

metadata

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