daemons 0.2.1 → 0.3.0

data/README

@@ -1,4 +1,4 @@
-= Daemons Version 0.2.1
+= Daemons Version 0.3.0
 
 (See Releases for release-specific information)
 
@@ -7,6 +7,10 @@
 Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server) 
 to be <i>run as a daemon</i> and to be <i>controlled by simple start/stop/restart commands</i>.
 
+Besides this basic functionality, daemons offers many advanced features like <i>exception backtracing</i> 
+and logging (in case your ruby script crashes) and <i>monitoring</i> and automatic restarting of your processes
+if they crash.
+
 Daemons includes the <tt>daemonize.rb</tt> script written by <i>Travis Whitton</i> to do the daemonization
 process.
 

data/Releases

@@ -4,7 +4,6 @@
 
 * Initial release
  
- 
 == Release 0.2.0: Mar 21, 2005
 
 * Exception backtrace functionality added
@@ -15,3 +14,10 @@
 == Release 0.2.1: Mar 21, 2005
 
 * Bugfix for a problem with the 'status' command
+
+== Release 0.3.0: April 21, 2005
+
+* New monitor functionality: automatic restarting of your applications if they crash
+* 'restart' command fixed
+* '--force' command modifier (please refer to the documentation)
+* Some more bugfixes and improvements

data/TODO

@@ -1,3 +1,6 @@
 * write the README (2005-02-07) *DONE*
 * write some real tests (2005-02-08)
 * document the new options (2005-03-14)
+* start/stop with --force options (2005-04-05)
+* option to give some console output on start/stop commands (2005-04-05)
+

data/examples/ctrl_crash.rb

@@ -10,6 +10,7 @@ require 'daemons'
 
 
 options = {
+  :log_output => true,
   :backtrace => true
 }
 

data/examples/ctrl_exit.rb

@@ -0,0 +1,15 @@
+lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../lib'))
+
+if File.exists?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  require 'rubygems' rescue nil
+end
+
+require 'daemons'
+
+
+options = {
+}
+
+Daemons.run(File.join(File.split(__FILE__)[0], 'myserver_exiting.rb'), options)

data/examples/ctrl_monitor.rb

@@ -0,0 +1,16 @@
+lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../lib'))
+
+if File.exists?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  require 'rubygems' rescue nil
+end
+
+require 'daemons'
+
+
+options = {
+  :monitor => true
+}
+
+Daemons.run(File.join(File.split(__FILE__)[0], 'myserver_crashing.rb'), options)

data/examples/ctrl_multiple.rb

@@ -0,0 +1,16 @@
+lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../lib'))
+
+if File.exists?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  require 'rubygems' rescue nil
+end
+
+require 'daemons'
+
+
+options = {
+  :multiple => true
+}
+
+Daemons.run(File.join(File.split(__FILE__)[0], 'myserver.rb'), options)

data/examples/myserver_crashing.rb.output

@@ -0,0 +1,15 @@
+/home/uehli/Desktop/daemons-current/examples/myserver_crashing.rb:13: CRASH! (RuntimeError)
+	from /home/uehli/Desktop/daemons-current/examples/myserver_crashing.rb:6:in `loop'
+	from /home/uehli/Desktop/daemons-current/examples/myserver_crashing.rb:6
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:116:in `load'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:116:in `run_via_load'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:90:in `start'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:359:in `run'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:469:in `run'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:468:in `call'
+	from /home/uehli/Desktop/daemons-current/lib/daemons/cmdline.rb:94:in `catch_exceptions'
+	from /home/uehli/Desktop/daemons-current/lib/daemons.rb:468:in `run'
+	from ctrl_crash.rb:17
+ping from myserver.rb!
+this example server will crash in 3 seconds...
+CRASH!

data/examples/myserver_exiting.rb

@@ -0,0 +1,8 @@
+loop do
+  puts 'ping from myserver.rb!'
+  puts 'this example server will exit in 3 seconds...'
+  
+  sleep(3)
+  
+  Process.exit!
+end

data/lib/daemons.rb

@@ -4,6 +4,7 @@ require 'optparse/time'
 require 'daemons/pidfile'  
 require 'daemons/cmdline'
 require 'daemons/exceptions'
+require 'daemons/monitor'
 
 
 # All functions and classes that Daemons provides reside in this module.
@@ -17,7 +18,7 @@ require 'daemons/exceptions'
 #
 module Daemons
 
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
   
   require 'daemons/daemonize'
    
@@ -48,11 +49,11 @@ module Daemons
       PidFile.dir(@dir_mode || @group.dir_mode, @dir || @group.dir, @script || @group.script)
     end
     
-    def start
+    def real_start
       opts = @group.controller.options
       
       unless opts[:ontop]
-        Daemonize.daemonize()
+        Daemonize.daemonize(opts[:log_output] ? File.join(pidfile_dir(), @group.app_name + '.output') : nil)
       end
       
       @pid_file.write
@@ -90,6 +91,13 @@ module Daemons
         run_via_load()
       end
     end
+    private :real_start
+    
+    def start
+      @group.create_monitor(@group.applications[0] || self)
+      
+      real_start
+    end
     
     def run
       if @group.controller.options[:exec]
@@ -132,31 +140,34 @@ module Daemons
       
       
       # the code below only logs the last exception
-      e = nil
+#       e = nil
+#       
+#       ObjectSpace.each_object {|o|
+#         if ::Exception === o
+#           e = o
+#         end
+#       }
+#       
+#       l_file.error e
+#       l_file.close
       
+      # this code logs every exception found in memory
       ObjectSpace.each_object {|o|
         if ::Exception === o
-          e = o
+          l_file.error o
         end
       }
       
-      l_file.error e
       l_file.close
-      
-      e = nil
-      
-      # this code logs every exception found in memory
-#       ObjectSpace.each_object {|o|
-#         if ::Exception === o
-#           l_file.error o
-#         end
-#       }
-#       
-#       l_file.close
     end
     
     
     def stop
+      if @group.controller.options[:force] and not running?
+        self.zap
+        return
+      end
+      
       Process.kill('TERM', @pid_file.read)
       
       # We try to remove the pid-files by ourselves, in case the application
@@ -169,10 +180,14 @@ module Daemons
       @pid_file.remove
     end
     
+    def zap!
+      @pid_file.remove rescue nil
+    end
+    
     def show_status
       running = self.running?
       
-      puts "#{self.group.app_name}: #{running ? '' : 'not'} running#{(running and @pid_file.exists?) ? ' [pid ' + @pid_file.read.to_s + ']' : ''}#{(@pid_file.exists? and not running) ? ' (but pid-file exists: ' + @pid_file.read.to_s + ')' : ''}"
+      puts "#{self.group.app_name}: #{running ? '' : 'not '}running#{(running and @pid_file.exists?) ? ' [pid ' + @pid_file.read.to_s + ']' : ''}#{(@pid_file.exists? and not running) ? ' (but pid-file exists: ' + @pid_file.read.to_s + ')' : ''}"
     end
     
     # This function implements a (probably too simle) method to detect
@@ -184,7 +199,7 @@ module Daemons
     #
     def running?
       if @pid_file.exists?
-        return /#{@pid_file.read} / =~ `ps ax`
+        return PidFile.running?(@pid_file.read)
       end
       
       return false
@@ -197,6 +212,7 @@ module Daemons
     attr_reader :app_name
     attr_reader :script
     
+    attr_reader :monitor
     attr_reader :controller
     
     attr_reader :applications
@@ -215,6 +231,7 @@ module Daemons
       @app_name = app_name
       @script = script
       @controller = controller
+      @monitor = nil
       
       options = controller.options
       
@@ -223,6 +240,14 @@ module Daemons
       @dir_mode = options[:dir_mode] || :script
       @dir = options[:dir] || ''
       
+      #@applications = find_applications(pidfile_dir())
+    end
+    
+    # Setup the application group.
+    # Currently this functions calls <tt>find_applications</tt> which finds
+    # all running instances of the application and populates the application array.
+    #
+    def setup
       @applications = find_applications(pidfile_dir())
     end
     
@@ -235,33 +260,76 @@ module Daemons
       
       #pp pid_files
       
-      return pid_files.map {|f| Application.new(self, PidFile.existing(f))}
+      @monitor = Monitor.find(dir, app_name + '_monitor')
+      
+      pid_files.reject! {|f| f =~ /_monitor.pid$/}
+      
+      return pid_files.map {|f|
+        app = Application.new(self, PidFile.existing(f))
+        setup_app(app)
+        app
+      }
     end
     
     def new_application(script = nil)
       if @applications.size > 0 and not @multiple
-        raise RuntimeException.new('there is already one or more instance(s) of the program running')
+        if @controller.options[:force]
+          @applications.delete_if {|a|
+            unless a.running?
+              a.zap
+              true
+            end
+          }
+        end
+        
+        raise RuntimeException.new('there is already one or more instance(s) of the program running') unless @applications.empty?
       end
       
       app = Application.new(self)
       
-      app.controller_argv = @controller_argv
-      app.app_argv = @app_argv
+      setup_app(app)
       
       @applications << app
       
       return app
     end
     
+    def setup_app(app)
+      app.controller_argv = @controller_argv
+      app.app_argv = @app_argv
+    end
+    private :setup_app
+    
+    def create_monitor(an_app)
+      return if @monitor
+      
+      if @controller.options[:monitor]
+        @monitor = Monitor.new(an_app)
+
+        @monitor.start(@applications)
+      end
+    end
+    
     def start_all
-      @applications.each {|a| fork { a.start } }
+      @monitor.stop if @monitor
+      @monitor = nil
+      
+      @applications.each {|a| 
+        fork { 
+          a.start 
+        } 
+      }
     end
     
     def stop_all
+      @monitor.stop if @monitor
+      
       @applications.each {|a| a.stop}
     end
     
     def zap_all
+      @monitor.stop if @monitor
+      
       @applications.each {|a| a.zap}
     end
     
@@ -323,6 +391,8 @@ module Daemons
       @group.controller_argv = @controller_part
       @group.app_argv = @app_part
       
+      @group.setup
+      
       case @command
         when 'start'
           @group.new_application.start
@@ -331,9 +401,11 @@ module Daemons
         when 'stop'
           @group.stop_all
         when 'restart'
-          @group.stop_all
-          sleep 1
-          @group.start_all
+          unless @group.applications.empty?
+            @group.stop_all
+            sleep 1
+            @group.start_all
+          end
         when 'zap'
           @group.zap_all
         when 'status'
@@ -412,7 +484,7 @@ module Daemons
   #                       but by exec'ing the script file
   # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
   #                       pid-file directory if the application exits due to an uncaught exception
-  #
+  # <tt>:monitor</tt>::   Monitor the programs and restart crashed instances
   # -----
   # 
   # === Example:
@@ -422,7 +494,8 @@ module Daemons
   #     :multiple   => true,
   #     :ontop      => true,
   #     :exec       => true,
-  #     :backtrace  => true
+  #     :backtrace  => true,
+  #     :monitor    => true
   #   }
   #
   #   Daemons.run(File.join(File.split(__FILE__)[0], 'myscript.rb'), options)

data/lib/daemons/cmdline.rb

@@ -22,6 +22,10 @@ module Daemons
           @options[:ontop] = t
         end
         
+        opts.on("-f", "--force", "Force operation") do |t|
+          @options[:force] = t
+        end
+        
         #opts.separator ""
         #opts.separator "Specific options:"
 

data/lib/daemons/daemonize.rb

@@ -113,7 +113,7 @@ module Daemonize
   
   
   # This method causes the current running process to become a daemon
-  def daemonize(oldmode=0)
+  def daemonize(logfile_name = nil, oldmode=0)
     srand # Split rand streams between spawning and daemonized process
     safefork and exit # Fork and exit from the parent
 
@@ -134,15 +134,34 @@ module Daemonize
     # Make sure all file descriptors are closed
     ObjectSpace.each_object(IO) do |io|
       unless [STDIN, STDOUT, STDERR].include?(io)
-        unless io.closed?
-          io.close rescue nil
+        begin
+          unless io.closed?
+            io.close
+          end
+        rescue ::Exception
         end
       end
     end
 
-    STDIN.reopen "/dev/null"       # Free file descriptors and
-    STDOUT.reopen "/dev/null", "a" # point them somewhere sensible
-    STDERR.reopen STDOUT           # STDOUT/STDERR should go to a logfile
+    # Free file descriptors and
+    # point them somewhere sensible
+    # STDOUT/STDERR should go to a logfile
+    
+    STDIN.reopen "/dev/null" rescue nil       
+    
+    if logfile_name
+      begin
+        STDOUT.reopen logfile_name, "a" 
+      rescue ::Exception
+        STDOUT.reopen "/dev/null" rescue nil
+      end
+    else
+      STDOUT.reopen "/dev/null" rescue nil
+    end
+     
+    STDERR.reopen STDOUT rescue nil           
+    
+    
     return oldmode ? sess_id : 0   # Return value is mostly irrelevant
   end
   module_function :daemonize

data/lib/daemons/monitor.rb

@@ -0,0 +1,101 @@
+
+module Daemons
+
+  require 'daemons/daemonize'
+   
+  class Monitor
+    
+    def self.find(dir, app_name)
+      pid_file = PidFile.find_files(dir, app_name)[0]
+      
+      if pid_file
+        pid_file = PidFile.existing(pid_file)
+        
+        unless PidFile.running?(pid_file.read)
+          pid_file.remove rescue nil
+          return
+        end
+        
+        monitor = self.allocate
+      
+        monitor.instance_variable_set(:@pid_file, pid_file)
+        
+        return monitor
+      end
+      
+      return nil
+    end
+    
+    
+    def initialize(an_app)
+      @pid_file = PidFile.new(an_app.pidfile_dir, an_app.group.app_name + '_monitor', false)
+    end
+    
+    def start(applications)
+      return if applications.empty?
+      
+      fork do
+        Daemonize.daemonize
+        
+        begin  
+          @pid_file.write
+          
+  #         at_exit {
+  #           @pid_file.remove rescue nil
+  #         }
+          
+          # This part is needed to remove the pid-file if the application is killed by 
+          # daemons or manually by the user.
+          # Note that the applications is not supposed to overwrite the signal handler for
+          # 'TERM'.
+          #
+  #         trap('TERM') {
+  #           @pid_file.remove rescue nil
+  #           exit
+  #         }
+          
+          sleep(60)
+          
+          loop do
+            applications.each {|a|
+              sleep(10)
+              
+              unless a.running?
+                a.zap!
+                
+                Process.detach(fork { a.start })
+                
+                sleep(10)
+              end
+            }
+            
+            sleep(30)
+          end
+        rescue ::Exception => e
+          begin
+            File.open(File.join(@pid_file.dir, @pid_file.progname + '.log'), 'a') {|f|
+              f.puts Time.now
+              f.puts e
+              f.puts e.backtrace.inspect
+            }
+          ensure 
+            @pid_file.remove rescue nil
+            exit!
+          end
+        end
+      end
+      
+    end
+    
+    
+    def stop
+      Process.kill('TERM', @pid_file.read) rescue nil
+      
+      # We try to remove the pid-files by ourselves, in case the application
+      # didn't clean it up.
+      @pid_file.remove rescue nil
+    end
+    
+  end
+  
+end

data/lib/daemons/pidfile.rb

@@ -40,6 +40,12 @@ module Daemons
     end
     
 
+    def PidFile.running?(pid, additional = nil)
+      output = `ps ax`
+      return (/#{pid} / =~ output and (additional ? /#{additional}/ =~ output : true))
+    end
+    
+    
     # Returns the directory that should be used to write the pid file to
     # depending on the given mode.
     # 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: daemons
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2005-03-21
+  version: 0.3.0
+date: 2005-04-21
 summary: A toolkit to convert your script to a controllable daemon
 require_paths: 
   - lib
@@ -37,16 +37,22 @@ files:
   - lib/daemons/exceptions.rb
   - lib/daemons/cmdline.rb
   - lib/daemons/pidfile.rb
+  - lib/daemons/monitor.rb
+  - test/tmp
   - test/testapp.rb
   - test/tc_main.rb
   - test/test1.rb
-  - test/tmp
   - examples/myserver.rb
   - examples/myserver_crashing.rb
   - examples/ctrl_crash.rb
   - examples/ctrl_ontop.rb
   - examples/ctrl_exec.rb
   - examples/ctrl_normal.rb
+  - examples/ctrl_multiple.rb
+  - examples/myserver_exiting.rb
+  - examples/ctrl_exit.rb
+  - examples/myserver_crashing.rb.output
+  - examples/ctrl_monitor.rb
 test_files: 
   - test/tc_main.rb
 rdoc_options: []