The unix signal is a method of sending messages between processes). When a signal is sent, the operating system interrupts the target process's normal flow of execution. There are standard signals that are used to stop a process but there are also custom signals that can be used for other purposes. This document is an attempt to list all supported signals that Puma will respond to. In general, signals need only be sent to the master process of a cluster.
If you are new to signals it can be useful to see how they can be used. When a process is created in a *nix like operating system it will have a PID - or process identifier that can be used to send signals to the process. For demonstration we will create an infinitely running process by tailing a file:
$ echo "foo" >> my.log $ irb > pid = Process.spawn 'tail -f my.log'
From here we can see that the tail process is running by using the
$ ps aux | grep tail schneems 87152 0.0 0.0 2432772 492 s032 S+ 12:46PM 0:00.00 tail -f my.log
You can send a signal in Ruby using the Process module:
$ irb > puts pid #=> 87152 Process.detach(pid) # https://ruby-doc.org/core-2.1.1/Process.html#method-c-detach Process.kill("TERM", pid)
Now you will see via
ps that there is no more
tail process. Sometimes when referring to signals the
SIG prefix will be used for instance
SIGTERM is equivalent to sending
Puma cluster responds to these signals:
TTINincrement the worker count by 1
TTOUdecrement the worker count by 1
TERMto worker. Worker will attempt to finish then exit.
USR2restart workers. This also reloads puma configuration file, if there is one.
USR1restart workers in phases, a rolling restart. This will not reload configuration file.
HUPreopen log files defined in stdout_redirect configuration parameter. If there is no stdout_redirect option provided it will behave like
INTequivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
URGrefork workers in phases from worker 0, if
fork_workersoption is enabled.
Callbacks order in case of different signals
puma configuration file reloaded, if there is one * Pruning Bundler environment puma configuration file reloaded, if there is one before_fork on_worker_fork after_worker_fork Gemfile in context on_worker_boot Code of the app is loaded and running
on_worker_shutdown on_restart puma configuration file reloaded, if there is one before_fork on_worker_fork after_worker_fork Gemfile in context on_worker_boot Code of the app is loaded and running
on_worker_shutdown on_worker_fork after_worker_fork Gemfile in context on_worker_boot Code of the app is loaded and running