daemons 1.1.9 → 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb08e3c11dd04ba70fdfa9a27e41d004839a48318b77bf7edb5e93976de129f7
+  data.tar.gz: 683d0ed93f6a41378a3ed585035b773f4008a147542ab6f29281374aa746ccf9
+SHA512:
+  metadata.gz: 9a8743b8307c977149bcfbb1d6b6b36897a1c750ef63a25f7225d7b1774eaffd128843a1d92d626c3062ff680066831214eed8dc3523216b61f15b355701f4d5
+  data.tar.gz: de074de7aa4ba81a507d9b06f900c2eb044628ceb3a02b5cf4abb717dfdbf6df52c56f709caa85b223d8a18b9da2c0057017074089832412a231499ef050dcde

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2012 Thomas Uehlinger
+Copyright (c) 2005-2021 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

@@ -0,0 +1,207 @@
+# Ruby Daemons
+
+[![Build Status](https://travis-ci.org/thuehlinger/daemons.svg?branch=master)](https://travis-ci.org/thuehlinger/daemons)[![Code Climate](https://codeclimate.com/github/acuppy/daemons/badges/gpa.svg)](https://codeclimate.com/github/acuppy/daemons)[![Test Coverage](https://circleci.com/gh/acuppy/daemons.svg?style=shield&circle-token=a4f96fd41f7682661d6543e30207427ac8870c0d)](https://circleci.com/gh/acuppy/daemons)
+
+Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server)
+to be _run as a daemon_ and to be _controlled by simple start/stop/restart commands_.
+
+If you want, you can also use daemons to _run blocks of ruby code in a daemon process_ and to control
+these processes from the main application.
+
+Besides this basic functionality, daemons offers many advanced features like _exception backtracing_
+and logging (in case your ruby script crashes) and _monitoring_ and automatic restarting of your processes
+if they crash.
+
+## Basic Usage
+
+You can use Daemons in four different ways:
+
+### 1. Create wrapper scripts for your server scripts or applications
+
+Layout: suppose you have your self-written server `myserver.rb`:
+
+``` ruby
+# this is myserver.rb
+# it does nothing really useful at the moment
+
+loop do
+  sleep(5)
+end
+```
+
+To use `myserver.rb` in a production environment, you need to be able to
+run `myserver.rb` in the _background_ (this means detach it from the console, fork it
+in the background, release all directories and file descriptors).
+
+Just create `myserver_control.rb` like this:
+
+``` ruby
+# this is myserver_control.rb
+require 'daemons'
+
+Daemons.run('myserver.rb')
+```
+
+And use it like this from the console:
+
+``` sh
+$ ruby myserver_control.rb start
+    (myserver.rb is now running in the background)
+$ ruby myserver_control.rb restart
+    (...)
+$ ruby myserver_control.rb stop
+```
+
+For testing purposes you can even run `myserver.rb` _without forking_ in the background:
+
+``` sh
+$ ruby myserver_control.rb run
+```
+
+An additional nice feature of Daemons is that you can pass _additional arguments_ to the script that
+should be daemonized by seperating them by two _hyphens_:
+
+``` sh
+$ ruby myserver_control.rb start -- --file=anyfile --a_switch another_argument
+```
+
+### 2. Create wrapper scripts that include your server procs
+
+Layout: suppose you have some code you want to run in the background and control that background process
+from a script:
+
+``` ruby
+# this is your code
+# it does nothing really useful at the moment
+
+loop do
+  sleep(5)
+end
+```
+
+To run this code as a daemon create `myproc_control.rb` like this and include your code:
+
+``` ruby
+# this is myproc_control.rb
+require 'daemons'
+
+Daemons.run_proc('myproc.rb') do
+  loop do
+    sleep(5)
+  end
+end
+```
+
+And use it like this from the console:
+
+``` sh
+$ ruby myproc_control.rb start
+    (myproc.rb is now running in the background)
+$ ruby myproc_control.rb restart
+    (...)
+$ ruby myproc_control.rb stop
+```
+
+For testing purposes you can even run `myproc.rb` _without forking_ in the background:
+
+``` sh
+$ ruby myproc_control.rb run
+```
+
+### 3. Control a bunch of daemons from another application
+
+Layout: you have an application `my_app.rb` that wants to run a bunch of
+server tasks as daemon processes.
+
+``` ruby
+# this is my_app.rb
+require 'daemons'
+
+task1 = Daemons.call(:multiple => true) do
+  # first server task
+
+  loop do
+    conn = accept_conn()
+    serve(conn)
+  end
+end
+
+task2 = Daemons.call do
+  # second server task
+
+  loop do
+    something_different()
+  end
+end
+
+# the parent process continues to run
+
+# we can even control our tasks, for example stop them
+task1.stop
+task2.stop
+
+exit
+```
+
+### 4. Daemonize the currently running process
+
+Layout: you have an application `my_daemon.rb` that wants to run as a daemon
+(but without the ability to be controlled by daemons via start/stop commands)
+
+``` ruby
+# this is my_daemons.rb
+require 'daemons'
+
+# Initialize the app while we're not a daemon
+init()
+
+# Become a daemon
+Daemons.daemonize
+
+# The server loop
+loop do
+  conn = accept_conn()
+  serve(conn)
+end
+```
+
+For further documentation, refer to the module documentation of Daemons.
+
+## Displaying daemon status
+
+When daemonizing a process using a wrapper script, as examples 1 and 2 above,
+the status can be shown using
+
+``` sh
+$ ruby myproc_control.rb status
+```
+
+By default this will display whether or not the daemon is running and, if it
+is, its PID.
+
+A custom message can be shown with
+
+``` ruby
+def custom_show_status(app)
+  # Display the default status information
+  app.default_show_status
+
+  puts
+  puts "PS information"
+  system("ps -p #{app.pid.pid.to_s}")
+
+  puts
+  puts "Size of log files"
+  system("du -hs /path/to/logs")
+end
+
+Daemons.run('myserver.rb', { show_status_callback: :custom_show_status })
+```
+
+## Documentation
+
+Documentation can be found at <http://www.rubydoc.info/gems/daemons>.
+
+## Author
+
+Written 2005-2021 by Thomas Uehlinger, 2014-2016 by Aaron Stone.

data/Releases

@@ -1,13 +1,74 @@
 = Daemons Release History
 
+== Release 1.4.1: August 26, 2021
+
+* Fix :proc mode (pass &block explicitly) (thanks to Graham Rogers)
+* Fix style of REAMDE.md
+
+== Release 1.4.0: May 1, 2021
+
+* Allow for customization which signals are sent to stop process (thanks to philister)
+* Resolves mismatched indentations (thanks to Luis M Rodriguez)
+* Allow to use pry-byebug 3.8.0 (thanks to kamipo)
+
+== Release 1.3.1: December 14, 2018
+
+* Fix undefined local variable or method `pid_delimiter'
+
+== 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.
+
+== Release 1.2.5: October 22, 2017
+
+* In Application#stop, call zap, not cleanup on the pidfile (thanks to wevanscfi)
+* Use File.expand_path on and output and log files (thanks to Dave Harris)
+
+== Release 1.2.4: August 1, 2016
+
+* add :shush option
+* add :monitor_interval option
+* add :log_output_syslog option
+
+== Release 1.2.3: June 25, 2015
+
+* fix: ApplicationGroup now waits on subprocesses in start_all (thanks to tobithiel)
+
+== Release 1.2.2: March 17, 2015
+
+* fix 100% CPU usage bug when using monitor mode.
+
+== Release 1.2.1: March 10, 2015
+
+* increase version number to be able to re-push to rubygems
+
+== Release 1.2.0: March 8, 2015
+
+* add options for custum log file names.
+* change pid file name scheme to "#progname_num#{number}.pid" for multiple instances.
+* fix call_as_daemon not saving the PID (thanks Roberto Plancarte)
+* allow for custom statis messages (thanks to Joseph Haig)
+* fix Pid.running? rescuing timeout exceptions (thanks to Geraud Boyer)
+* monitor.rb/application.rb/application_group.rb: handle :monitor and :multiple in combination correctly
+  (thanks to Prakash Murthy).
+* pidfile.rb: Handle invalid or empty pid files instead of returning pid 0 (thanks to Aaron Stone)
+* run the whole gem through Rubocop (thanks to Aaron Stone)
+* gem cleanup (thanks to Aaron Stone)
+
 == Release 1.1.9: August 10, 2012
 
-* daemonize.rb: do srand in the forked child process both in daemonize and call_as_daemon 
+* daemonize.rb: do srand in the forked child process both in daemonize and call_as_daemon
   (thanks to Andrew Havens).
 
 == Release 1.1.8: February 7, 2012
 
-* rename to daemonization.rb to daemonize.rb (and Daemonization to Daemonize) to 
+* rename to daemonization.rb to daemonize.rb (and Daemonization to Daemonize) to
   ensure compatibility.
 
 == Release 1.1.7: February 6, 2012
@@ -21,57 +82,57 @@
 
 == Release 1.1.5: December 19, 2011
 
-* Catch the case where the pidfile is empty but not deleted 
+* Catch the case where the pidfile is empty but not deleted
   and restart the app (thanks to Rich Healey)
 
 == Release 1.1.4: June 17, 2011
 
-* Do not change the umask to 0000 when daemonizing anymore, just leave it as it 
+* Do not change the umask to 0000 when daemonizing anymore, just leave it as it
   was (thanks to Jon Botelho).
 
 == Release 1.1.3: April 14, 2011
 
 * Fixed a bug in Application.stop: the cached pid number needs to
   be used to check for the status of a killed process (thanks to Jimmy Sieben).
-  
+
 == Release 1.1.2: March 29, 2011
 
 * Fixed gemspec to include all needed files.
-  
+
 == Release 1.1.1: March 29, 2011
 
-* Make the logging facilities work in :mode => :none (i.e. when calling 
+* Make the logging facilities work in :mode => :none (i.e. when calling
   Daemons.daemonize) (thanks to the input from Peter Hegedus).
-  
+
 == Release 1.1.0: June 20, 2010
 
 * Honour the options[:app_name] in Daemons.daemonize (thanks to Ryan Tecco).
-* Included a new option :stop_proc to specify a proc that will be called when a 
+* Included a new option :stop_proc to specify a proc that will be called when a
   daemonized process receives a request to stop (thanks to Dave Dupre).
 * Only delete the pidfile if the current pid is the original pid (ghazel).
 * Start when restart but no application running (pcreux).
 * Silently continue if there is no pidfile (ghazel).
 * We now per default wait for processes to stop and
-  kill them automatically it if they do not stop within a given time 
-  (force_kill_waittime). Use the option --no_wait to not wait for processes to 
+  kill them automatically it if they do not stop within a given time
+  (force_kill_waittime). Use the option --no_wait to not wait for processes to
   stop.
 * Set log files mode to 0644 (mikehale).
 * Set pid file permissions to 0644 (mikehale).
 * Added ability to change process uid/gid (mikehale).
-* Fix for: If you happen to start a daemon from a process that has open file 
-  descriptors these will stay open. As it is daemonize.rb only closes ruby IO 
+* Fix for: If you happen to start a daemon from a process that has open file
+  descriptors these will stay open. As it is daemonize.rb only closes ruby IO
   objects (thanks to Han Holl).
 * New reload command (SIGHUP) (thanks to Michael Schuerig).
 
 == Release 1.0.10: March 21, 2008
 
-* By default, we now delete stray pid-files (i.e. pid-files which result for 
-  example from a killed daemon) automatically. This function can be deactivated 
+* By default, we now delete stray pid-files (i.e. pid-files which result for
+  example from a killed daemon) automatically. This function can be deactivated
   by passing :keep_pid_files => true as an option.
-* All pid files of :multiple daemons new get deleted correctly upon exit of the 
+* All pid files of :multiple daemons new get deleted correctly upon exit of the
   daemons (reported by Han Holl).
 * Use the signal 'KILL' instead of 'TERM' on Windows platforms.
-* Use exit! in trap('TERM') instead of exit when option :hard_exit is given 
+* Use exit! in trap('TERM') instead of exit when option :hard_exit is given
   (thanks to Han Holl).
 * Did some clarification on the exception log.
 
@@ -82,12 +143,12 @@
 
 == Release 1.0.8: September 24, 2007
 
-* new Pid.running? function. Checking whether a process exists by sending 
+* new Pid.running? function. Checking whether a process exists by sending
   signal '0' (thanks to Dru Nelson).
 
 == Release 1.0.7: July 7, 2007
 
-* Patch to fix wrong ARGV when using :exec (in def start_exec: 
+* Patch to fix wrong ARGV when using :exec (in def start_exec:
   Kernel.exec(script(), *(@app_argv || []))) (thanks to Alex McGuire).
 
 == Release 1.0.6: Mai 8, 2007
@@ -97,7 +158,7 @@
 
 == Release 1.0.5: February 24, 2007
 
-* Applied patch that makes daemons to use '/var/log' as logfile 
+* Applied patch that makes daemons to use '/var/log' as logfile
   directory if you use :dir_mode = :system (thanks to Han Holl).
 * Daemons should now work with Ruby 1.9 (at least the basic features).
 
@@ -105,7 +166,7 @@
 
 * Document the :log_output option (thanks to Andrew Kuklewicz).
 * Set STDOUT.sync = true when redirecting to a logfile (thanks to Andrew Kuklewicz).
-* Should now run also correctly when there is no working 'ps ax' on the system 
+* Should now run also correctly when there is no working 'ps ax' on the system
   (thanks to Daniel Kehoe).
 
 == Release 1.0.3: November 1, 2006
@@ -117,7 +178,7 @@
 * Changed the 'ps -ax' call back to 'ps ax'.
 * Fixed the documentation for the :normal :dir_mode.
 * As a default for Daemons.run_proc, the pid file is now saved in the current directory.
-* In :ontop mode for running a proc (this is equal to calling something like 'ruby ctrl_proc.rb run'), 
+* In :ontop mode for running a proc (this is equal to calling something like 'ruby ctrl_proc.rb run'),
   the proc now runs directly in the calling script, not in a forked process anymore (thanks to Paul Butcher).
 * Set $0 to app_name in the daemons (thanks to Ilya Novoselov).
 
@@ -131,7 +192,7 @@
 
 == Release 0.4.4: February 14, 2006
 
-* Several fixes that allow us to use the Daemons::Controller 
+* Several fixes that allow us to use the Daemons::Controller
   with a proc instead of wrapping a script file. This gives us all the
   PID file management, monitoring, command line options, etc. without having
   to specify a path to our script which can be tricky, especially when using
@@ -143,7 +204,7 @@
   on calling Daemons.run. This will be used to contruct the name of the pid files
   and log files. Defaults to the basename of the script. (thanks to Stephen R. Veit)
 
-* Bugfix: Handle the case where no controller options are given when calling Daemons, 
+* Bugfix: Handle the case where no controller options are given when calling Daemons,
   just options after "--". (thanks to Stephen R. Veit)
 
 

data/examples/call/call.rb

@@ -6,12 +6,10 @@ else
   begin; require 'rubygems'; rescue ::Exception; end
 end
 
-
 require 'daemons'
 
 testfile = File.expand_path(__FILE__) + '.log'
 
-
 # On the first call to <tt<call</tt>, an application group (accessible by <tt>Daemons.group</tt>)
 # will be created an the options will be kept within, so you only have to specify
 # <tt>:multiple</tt> once.
@@ -23,35 +21,34 @@ options = {
   :multiple => true
 }
 
-
 Daemons.call(options) do
-  File.open(testfile, 'w') {|f|
-    f.puts "test"
-  }
+  File.open(testfile, 'w') do |f|
+    f.puts 'test'
+  end
 
-  loop { puts "1"; sleep 5 }
+  loop { puts '1'; sleep 5 }
 end
-puts "first task started"
+puts 'first task started'
 
 Daemons.call do
-  loop { puts "2"; sleep 4 }
+  loop { puts '2'; sleep 4 }
 end
-puts "second task started"
+puts 'second task started'
 
 # NOTE: this process will exit after 5 seconds
 Daemons.call do
-  puts "3"
+  puts '3'
   sleep 5
 end
-puts "third task started"
+puts 'third task started'
 
-puts "waiting 20 seconds..."
+puts 'waiting 20 seconds...'
 sleep(20)
 
-# This call would result in an exception as it will try to kill the third process 
+# This call would result in an exception as it will try to kill the third process
 # which has already terminated by that time; but using the 'true' parameter forces the
 # stop_all procedure.
-puts "trying to stop all tasks..."
+puts 'trying to stop all tasks...'
 Daemons.group.stop_all(true)
 
-puts "done"
+puts 'done'

data/examples/call/call_monitor.rb

@@ -6,12 +6,10 @@ else
   begin; require 'rubygems'; rescue ::Exception; end
 end
 
-
 require 'daemons'
 
 testfile = File.expand_path(__FILE__) + '.log'
 
-
 # On the first call to <tt<call</tt>, an application group (accessible by <tt>Daemons.group</tt>)
 # will be created an the options will be kept within, so you only have to specify
 # <tt>:multiple</tt> once.
@@ -23,33 +21,31 @@ options = {
   :monitor => true
 }
 
-
 Daemons.call(options) do
-  loop { puts "1"; sleep 20 }
+  loop { puts '1'; sleep 20 }
 end
-puts "first task started"
-
+puts 'first task started'
 
 # NOTE: this process will exit after 5 seconds
 Daemons.call do
-  File.open(testfile, 'a') {|f|
-    f.puts "started..."
-    puts "2"
-  
+  File.open(testfile, 'a') do |f|
+    f.puts 'started...'
+    puts '2'
+
     sleep 5
 
-    f.puts "...exit"
-  }
+    f.puts '...exit'
+  end
 end
-puts "second task started"
+puts 'second task started'
 
-puts "waiting 100 seconds..."
+puts 'waiting 100 seconds...'
 sleep(100)
 
-# This call would result in an exception as it will try to kill the third process 
+# This call would result in an exception as it will try to kill the third process
 # which has already terminated by that time; but using the 'true' parameter forces the
 # stop_all procedure.
-puts "trying to stop all tasks..."
+puts 'trying to stop all tasks...'
 Daemons.group.stop_all(true)
 
-puts "done"
+puts 'done'

data/examples/daemonize/daemonize.rb

@@ -6,22 +6,18 @@ else
   begin; require 'rubygems'; rescue ::Exception; end
 end
 
-
-
 require 'daemons'
 
-
 options = {
   :log_output => true
 }
 
-
 testfile = File.expand_path(__FILE__) + '.txt'
 
 Daemons.daemonize(options)
 
-puts "some output..."
+puts 'some output...'
 
-File.open(testfile, 'w') {|f|
-  f.write("test")
-}
+File.open(testfile, 'w') do |f|
+  f.write('test')
+end

data/examples/run/ctrl_crash.rb

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

data/examples/run/ctrl_custom_logfiles.rb

@@ -0,0 +1,18 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exist?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  begin; require 'rubygems'; rescue ::Exception; end
+end
+
+require 'daemons'
+
+options = {
+  :log_output => true,
+  :backtrace => true,
+  :output_logfilename => "custom_output.txt",
+  :logfilename => "custom_log.log"
+}
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_crashing.rb'), options)

data/examples/run/ctrl_exec.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
   :mode => :exec
 }

data/examples/run/ctrl_exit.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
 }
 

data/examples/run/ctrl_keep_pid_files.rb

@@ -8,10 +8,8 @@ end
 
 require 'daemons'
 
-
 options = {
   :keep_pid_files => true
 }
 
-
-Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)

data/examples/run/ctrl_monitor.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
   :monitor => true
 }

data/examples/run/ctrl_monitor_multiple.rb

@@ -0,0 +1,17 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exist?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  begin; require 'rubygems'; rescue ::Exception; end
+end
+
+require 'daemons'
+
+options = {
+  :multiple => true,
+  :monitor => true,
+  :log_output => true,
+}
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_crashing.rb'), options)

data/examples/run/ctrl_monitor_nocrash.rb

@@ -0,0 +1,15 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exist?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  begin; require 'rubygems'; rescue ::Exception; end
+end
+
+require 'daemons'
+
+options = {
+  :monitor => true
+}
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver.rb'), options)