SIGNALS

   1 == Signal handling
   2
   3 In general, signals need only be sent to the master process.  However,
   4 the signals Rainbows! uses internally to communicate with the worker
   5 processes are documented here as well.  With the exception of TTIN/TTOU,
   6 signal handling matches the behavior of and {nginx}[http://nginx.net/]
   7 so it should be possible to easily share process management scripts
   8 between \Rainbows!, Unicorn and nginx.
   9
  10 === Master Process
  11
  12 * HUP - reload config file, app, and gracefully restart all workers
  13
  14 * INT/TERM - quick shutdown, kills all workers immediately
  15
  16 * QUIT - graceful shutdown, waits for workers to finish their
  17   current request before finishing.
  18
  19 * USR1 - reopen all logs owned by the master and all workers
  20   See Unicorn::Util.reopen_logs for what is considered a log.
  21
  22 * USR2 - reexecute the running binary.  A separate QUIT
  23   should be sent to the original process once the child is verified to
  24   be up and running.
  25
  26 * WINCH - gracefully stops workers but keep the master running.
  27   This will only work for daemonized processes.
  28
  29 * TTIN - increment the number of worker processes by one
  30
  31 * TTOU - decrement the number of worker processes by one
  32
  33 === Worker Processes
  34
  35 Sending signals directly to the worker processes should not normally be
  36 needed.  If the master process is running, any exited worker will be
  37 automatically respawned.
  38
  39 * INT/TERM - Quick shutdown, immediately exit.
  40   Unless WINCH has been sent to the master (or the master is killed),
  41   the master process will respawn a worker to replace this one.
  42
  43 * QUIT - Gracefully exit after finishing the current request.
  44   Unless WINCH has been sent to the master (or the master is killed),
  45   the master process will respawn a worker to replace this one.
  46
  47 * USR1 - Reopen all logs owned by the worker process.
  48   See Unicorn::Util.reopen_logs for what is considered a log.
  49   Unlike Unicorn, log files are reopened immediately in \Rainbows!
  50   since worker processes are likely to be serving multiple clients
  51   simutaneously, we can't wait for all of them to finish.
  52
  53 === Procedure to replace a running rainbows executable
  54
  55 You may replace a running instance of rainbows with a new one without
  56 losing any incoming connections.  Doing so will reload all of your
  57 application code, Unicorn/Rainbows! config, Ruby executable, and all
  58 libraries.  The only things that will not change (due to OS limitations)
  59 are:
  60
  61 1. The path to the rainbows executable script.  If you want to change to
  62    a different installation of Ruby, you can modify the shebang
  63    line to point to your alternative interpreter.
  64
  65 The procedure is exactly like that of nginx:
  66
  67 1. Send USR2 to the master process
  68
  69 2. Check your process manager or pid files to see if a new master spawned
  70    successfully.  If you're using a pid file, the old process will have
  71    ".oldbin" appended to its path.  You should have two master instances
  72    of rainbows running now, both of which will have workers servicing
  73    requests.  Your process tree should look something like this:
  74
  75      rainbows master (old)
  76      \_ rainbows worker[0]
  77      \_ rainbows worker[1]
  78      \_ rainbows worker[2]
  79      \_ rainbows worker[3]
  80      \_ rainbows master
  81         \_ rainbows worker[0]
  82         \_ rainbows worker[1]
  83         \_ rainbows worker[2]
  84         \_ rainbows worker[3]
  85
  86 3. You can now send WINCH to the old master process so only the new workers
  87    serve requests.  If your rainbows process is bound to an
  88    interactive terminal, you can skip this step.  Step 5 will be more
  89    difficult but you can also skip it if your process is not daemonized.
  90
  91 4. You should now ensure that everything is running correctly with the
  92    new workers as the old workers die off.
  93
  94 5. If everything seems ok, then send QUIT to the old master.  You're done!
  95
  96    If something is broken, then send HUP to the old master to reload
  97    the config and restart its workers.  Then send QUIT to the new master
  98    process.