daemons 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc83cd9641e813a84137af3a5ee5a0ce14ae8b3f
-  data.tar.gz: 6ff0dedb0c407a49ab2b3037fe7aeba50c161ee4
+  metadata.gz: b9dd7a0ebbf277c1b9181d6a0b2842a23745a641
+  data.tar.gz: c0c19d888f7e3a5e9bf2adef3d461e9901e3ba62
 SHA512:
-  metadata.gz: e712b26c9135ec38e02d4283ae52cfdf2b13f22c7168d66e66563223e34653f1603232e6e2dc65c1a5f39df8411f59fd9a1e6be106ae878456a4ef6d314d5eed
-  data.tar.gz: 8ba557b1f944a37544079bac30b25a86395c8e74366eca728ef9e245f12c1d2483a9ee777f715390c6975c45f6fb522162e69a95fc2d2b945ee512814f7d3047
+  metadata.gz: 01bad14851edb2e7bda6f5e477e9e5f4137023869e71f654c77c5f2d02950605337f01d16fb408a7759342777a8f0035f0ca976d856134834b4b8a4b2c62f461
+  data.tar.gz: 3909cb80e4a2d5b0ec534912b9ba572acb6db8ed7fbd5592ad9789999f4d8bf502061c6883f06afc478c5fc9abe7938eb8da774a78fded8aa1b3b08bb081cbb0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2017 Thomas Uehlinger, 2014-2016 Aaron Stone
+Copyright (c) 2005-2018 Thomas Uehlinger, 2014-2016 Aaron Stone
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -201,7 +201,7 @@ end
 Daemons.run('myserver.rb', { show_status_callback: :custom_show_status })
 ```
 
-Documenation
+Documentation
 -------------------
 
 Documentation can be found at http://www.rubydoc.info/gems/daemons.
@@ -209,4 +209,4 @@ Documentation can be found at http://www.rubydoc.info/gems/daemons.
 Author
 ------
 
-Written 2005-2017 by Thomas Uehlinger, 2014-2016 by Aaron Stone.
+Written 2005-2018 by Thomas Uehlinger, 2014-2016 by Aaron Stone.

data/Releases

@@ -1,5 +1,11 @@
 = Daemons Release History
 
+== Release 1.3.0: December 10, 2018
+
+* Make logging more configurable.
+* Add configuration options for pid file delimters, force_kill_waittime
+* All status callback to be anything callable.
+
 == Release 1.2.6: December 24, 2017
 
 * Add links to rubydoc.info documentation.

data/lib/daemons.rb

@@ -99,6 +99,7 @@ module Daemons
   # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
   # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
   #                       same time
+  # <tt>:pid_delimiter</tt>:: Specifies the separator used when enumerating multiple process names/pid-files. Default is '_num'.
   # <tt>:ontop</tt>::     When given (i.e. set to true), stay on top, i.e. do not daemonize the application
   #                       (but the pid-file and other things are written as usual)
   # <tt>:shush</tt>::     When given (i.e. set to true), turn on silent mode (no output to the terminal)
@@ -129,6 +130,7 @@ module Daemons
   #     :dir_mode           => :script,
   #     :dir                => 'pids',
   #     :multiple           => true,
+  #     :pid_delimiter      => '.n',
   #     :ontop              => true,
   #     :shush              => false,
   #     :mode               => :exec,

data/lib/daemons/application.rb

@@ -31,7 +31,7 @@ module Daemons
       ['dir', 'log_dir', 'logfilename', 'output_logfilename'].each do |k|
         @options[k] = File.expand_path(@options[k]) if @options.key?(k)
       end
-        
+
       @dir_mode = @dir = @script = nil
 
       @force_kill_waittime = @options[:force_kill_waittime] || 20
@@ -44,7 +44,7 @@ module Daemons
         if @options[:no_pidfiles]
           @pid = PidMem.new
         elsif dir = pidfile_dir
-          @pid = PidFile.new(dir, @group.app_name, @group.multiple)
+          @pid = PidFile.new(dir, @group.app_name, @group.multiple, @options[:pid_delimiter])
         else
           @pid = PidMem.new
         end
@@ -52,7 +52,12 @@ module Daemons
     end
 
     def show_status_callback=(function)
-      @show_status_callback = method(function)
+      @show_status_callback =
+        if function.respond_to?(:call)
+          function
+        else
+          method(function)
+        end
     end
 
     def change_privilege

data/lib/daemons/application_group.rb

@@ -38,8 +38,11 @@ module Daemons
       @dir = @options[:dir] || ''
 
       @keep_pid_files = @options[:keep_pid_files] || false
+
       @no_pidfiles = @options[:no_pidfiles] || false
 
+      @pid_delimiter = @options[:pid_delimiter]
+
       @applications = []
     end
 
@@ -94,7 +97,7 @@ module Daemons
       @monitor = Monitor.find(dir, app_name + '_monitor')
 
       reporter = Reporter.new(options)
-      pid_files = PidFile.find_files(dir, app_name, ! @keep_pid_files) do |pid, file|
+      pid_files = PidFile.find_files(dir, app_name, ! @keep_pid_files, @pid_delimiter) do |pid, file|
         reporter.deleted_found_pidfile(pid, file)
       end
 

data/lib/daemons/cmdline.rb

@@ -12,7 +12,7 @@ module Daemons
         opts.on('-t', '--ontop', 'Stay on top (does not daemonize)') do |t|
           @options[:ontop] = t
         end
-        
+
         opts.on('-s', '--shush', 'Silent mode (no output to the terminal)') do |t|
           @options[:shush] = t
         end
@@ -25,9 +25,37 @@ module Daemons
           @options[:no_wait] = t
         end
 
+        opts.on('-w', '--force_kill_waittime SECONDS', Integer, 'Maximum time to wait for processes to stop before force-killing') do |t|
+          @options[:force_kill_waittime] = t
+        end
+
+        opts.on('--pid_delimiter STRING', 'Text used to separate process number in full process name and pid-file name') do |value|
+          @options[:pid_delimiter] = value
+        end
+
         opts.separator ''
         opts.separator 'Common options:'
 
+        opts.on('-l', '--log_output', 'Enable input/output stream redirection') do |value|
+          @options[:log_output] = value
+        end
+
+        opts.on('--logfilename FILE', String, 'Custom log file name for exceptions') do |value|
+          @options[:logfilename] = value
+        end
+
+        opts.on('--output_logfilename FILE', String, 'Custom file name for input/output stream redirection log') do |value|
+          @options[:output_logfilename] = value
+        end
+
+        opts.on('--log_dir DIR', String, 'Directory for log files') do |value|
+          @options[:log_dir] = value
+        end
+
+        opts.on('--syslog', 'Enable output redirction into SYSLOG instead of a file') do |value|
+          @options[:log_output_syslog] = value
+        end
+
         # No argument, shows at tail.  This will print an options summary
         opts.on_tail('-h', '--help', 'Show this message') do
           controller.print_usage
@@ -62,7 +90,7 @@ END
     def parse(args)
       # The options specified on the command line will be collected in *options*.
       # We set default values here.
-      
+
       @opts.parse(args)
 
       @options
@@ -71,20 +99,21 @@ END
 
   class Controller
     def print_usage
-      puts "Usage: #{@app_name} <command> <options> -- <application options>"
-      puts
-      puts '* where <command> is one of:'
-      puts '  start         start an instance of the application'
-      puts '  stop          stop all instances of the application'
-      puts '  restart       stop all instances and restart them afterwards'
-      puts '  reload        send a SIGHUP to all instances of the application'
-      puts '  run           start the application and stay on top'
-      puts '  zap           set the application to a stopped state'
-      puts '  status        show status (PID) of application instances'
-      puts
-      puts '* and where <options> may contain several of the following:'
-
-      puts @optparse.usage
+      puts <<-USAGE.gsub(/^ {6}/, '')
+      Usage: #{@app_name} <command> <options> -- <application options>
+
+      * where <command> is one of:
+        start         start an instance of the application
+        stop          stop all instances of the application
+        restart       stop all instances and restart them afterwards
+        reload        send a SIGHUP to all instances of the application
+        run           run the application in the foreground (same as start -t)
+        zap           set the application to a stopped state
+        status        show status (PID) of application instances
+
+      * and where <options> may contain several of the following:
+      #{@optparse.usage}
+      USAGE
     end
 
     def catch_exceptions(&block)

data/lib/daemons/pidfile.rb

@@ -13,8 +13,8 @@ module Daemons
   # === How does a Pid-File look like?
   #
   # Pid-Files generated by Daemons have to following format:
-  #   <scriptname>.rb<number>.pid
-  # (Note that <tt><number></tt> is omitted if only one instance of the script can
+  #   <scriptname>_num<number>.pid
+  # (Note that <tt>_num<number></tt> is omitted if only one instance of the script can
   # run at any time)
   #
   # Each file just contains one line with the pid as string (for example <tt>6432</tt>).
@@ -28,10 +28,11 @@ module Daemons
   # 3.  in the preconfigured directory <tt>/var/run</tt> (<tt>:system</tt> option for <tt>:dir_mode</tt>)
   #
   class PidFile < Pid
+    DEFAULT_PID_DELIMITER = '_num'
     attr_reader :dir, :progname, :multiple, :number
 
-    def self.find_files(dir, progname, delete = false)
-      files = Dir[File.join(dir, "#{progname}_num*.pid")]
+    def self.find_files(dir, progname, delete = false, pid_delimiter = nil)
+      files = Dir[File.join(dir, "#{progname}#{pid_delimiter || DEFAULT_PID_DELIMITER}*.pid")]
       files = Dir[File.join(dir, "#{progname}.pid")] if files.size == 0
 
       files.delete_if { |f| not (File.file?(f) and File.readable?(f)) }
@@ -62,10 +63,11 @@ module Daemons
       new_instance
     end
 
-    def initialize(dir, progname, multiple = false)
+    def initialize(dir, progname, multiple = false, pid_delimiter = nil)
       @dir = File.expand_path(dir)
       @progname = progname
       @multiple = multiple
+      @pid_delimiter = pid_delimiter || DEFAULT_PID_DELIMITER
       @number = nil
       @number = 0 if multiple
 
@@ -81,7 +83,8 @@ module Daemons
     end
 
     def filename
-      File.join(@dir, "#{@progname}#{@number ? '_num' + @number.to_s : '' }.pid")
+      suffix = "#{pid_delimiter}#{@number}" if @number
+      File.join(@dir, "#{@progname}#{suffix}.pid")
     end
 
     def exist?

data/lib/daemons/version.rb

@@ -1,3 +1,3 @@
 module Daemons
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daemons
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Thomas Uehlinger
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A toolkit to create and control daemons in different ways