Class: Unicorn::Configurator
- Inherits:
-
Object
- Object
- Unicorn::Configurator
- Includes:
- Unicorn
- Defined in:
- lib/unicorn/configurator.rb
Overview
Implements a simple DSL for configuring a unicorn server.
See yhbt.net/unicorn/examples/unicorn.conf.rb and yhbt.net/unicorn/examples/unicorn.conf.minimal.rb example configuration files. An example config file for use with nginx is also available at yhbt.net/unicorn/examples/nginx.conf
See the TUNING.html document for more information on tuning unicorn.
Constant Summary collapse
- RACKUP =
used to stash stuff for deferred processing of cli options in config.ru after “working_directory” is bound. Do not rely on this being around later on…
{ :daemonize => false, :host => Unicorn::Const::DEFAULT_HOST, :port => Unicorn::Const::DEFAULT_PORT, :set_listener => false, :options => { :listeners => [] } }
- DEFAULTS =
Default settings for Unicorn
{ :timeout => 60, :logger => Logger.new($stderr), :worker_processes => 1, :after_fork => lambda { |server, worker| server.logger.info("worker=#{worker.nr} spawned pid=#{$$}") }, :before_fork => lambda { |server, worker| server.logger.info("worker=#{worker.nr} spawning...") }, :before_exec => lambda { |server| server.logger.info("forked child re-executing...") }, :after_worker_exit => lambda { |server, worker, status| m = "reaped #{status.inspect} worker=#{worker.nr rescue 'unknown'}" if status.success? server.logger.info(m) else server.logger.error(m) end }, :after_worker_ready => lambda { |server, worker| server.logger.info("worker=#{worker.nr} ready") }, :pid => nil, :early_hints => false, :worker_exec => false, :preload_app => false, :check_client_connection => false, :rewindable_input => true, :client_body_buffer_size => Unicorn::Const::MAX_BODY, }
Constants included from Unicorn
Instance Attribute Summary collapse
-
#after_reload ⇒ Object
:stopdoc:.
-
#config_file ⇒ Object
:stopdoc:.
-
#set ⇒ Object
:stopdoc:.
Instance Method Summary collapse
-
#[](key) ⇒ Object
:nodoc:.
-
#after_fork(*args, &block) ⇒ Object
sets after_fork hook to a given block.
-
#after_worker_exit(*args, &block) ⇒ Object
sets after_worker_exit hook to a given block.
-
#after_worker_ready(*args, &block) ⇒ Object
sets after_worker_ready hook to a given block.
-
#before_exec(*args, &block) ⇒ Object
sets the before_exec hook to a given Proc object.
-
#before_fork(*args, &block) ⇒ Object
sets before_fork got be a given Proc object.
-
#check_client_connection(bool) ⇒ Object
When enabled, unicorn will check the client connection by writing the beginning of the HTTP headers before calling the application.
-
#client_body_buffer_size(bytes) ⇒ Object
The maximum size (in
bytes
) to buffer in memory before resorting to a temporary file. -
#commit!(server, options = {}) ⇒ Object
:nodoc:.
-
#default_middleware(bool) ⇒ Object
sets whether to add default middleware in the development and deployment RACK_ENVs.
-
#early_hints(bool) ⇒ Object
sets whether to enable the proposed early hints Rack API.
-
#expand_addr(address) ⇒ Object
expands “unix:path/to/foo” to a socket relative to the current path expands pathnames of sockets if relative to “~” or “~username” expands “*:port and ”:port“ to ”0.0.0.0:port“.
-
#initialize(defaults = {}) ⇒ Configurator
constructor
:startdoc:.
-
#listen(address, options = {}) ⇒ Object
Adds an
address
to the existing listener set. -
#listeners(addresses) ⇒ Object
sets listeners to the given
addresses
, replacing or augmenting the current set. -
#logger(obj) ⇒ Object
sets object to the
obj
Logger-like object. -
#pid(path) ⇒ Object
sets the
path
for the PID file of the unicorn master process. -
#preload_app(bool) ⇒ Object
Enabling this preloads an application before forking worker processes.
-
#reload(merge_defaults = true) ⇒ Object
:nodoc:.
-
#rewindable_input(bool) ⇒ Object
Toggles making env rewindable.
-
#stderr_path(path) ⇒ Object
Allow redirecting $stderr to a given path.
-
#stdout_path(path) ⇒ Object
Same as stderr_path, except for $stdout.
-
#timeout(seconds) ⇒ Object
sets the timeout of worker processes to
seconds
. -
#user(user, group = nil) ⇒ Object
Runs worker processes as the specified
user
andgroup
. -
#worker_exec(bool) ⇒ Object
Whether to exec in each worker process after forking.
-
#worker_processes(nr) ⇒ Object
sets the current number of worker_processes to
nr
. -
#working_directory(path) ⇒ Object
sets the working directory for Unicorn.
Methods included from Unicorn
builder, listener_names, log_error, pipe
Constructor Details
#initialize(defaults = {}) ⇒ Configurator
:startdoc:
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/unicorn/configurator.rb', line 65 def initialize(defaults = {}) #:nodoc: self.set = Hash.new(:unset) @use_defaults = defaults.delete(:use_defaults) self.config_file = defaults.delete(:config_file) # after_reload is only used by unicorn_rails, unsupported otherwise self.after_reload = defaults.delete(:after_reload) set.merge!(DEFAULTS) if @use_defaults defaults.each { |key, value| self.__send__(key, value) } Hash === set[:listener_opts] or set[:listener_opts] = Hash.new { |hash,key| hash[key] = {} } Array === set[:listeners] or set[:listeners] = [] reload(false) end |
Instance Attribute Details
#after_reload ⇒ Object
:stopdoc:
17 18 19 |
# File 'lib/unicorn/configurator.rb', line 17 def after_reload @after_reload end |
#config_file ⇒ Object
:stopdoc:
17 18 19 |
# File 'lib/unicorn/configurator.rb', line 17 def config_file @config_file end |
#set ⇒ Object
:stopdoc:
17 18 19 |
# File 'lib/unicorn/configurator.rb', line 17 def set @set end |
Instance Method Details
#[](key) ⇒ Object
:nodoc:
128 129 130 |
# File 'lib/unicorn/configurator.rb', line 128 def [](key) # :nodoc: set[key] end |
#after_fork(*args, &block) ⇒ Object
sets after_fork hook to a given block. This block will be called by the worker after forking. The following is an example hook which adds a per-process listener to every worker:
after_fork do |server,worker|
# per-process listener ports for debugging/admin:
addr = "127.0.0.1:#{9293 + worker.nr}"
# the negative :tries parameter indicates we will retry forever
# waiting on the existing process to exit with a 5 second :delay
# Existing options for Unicorn::Configurator#listen such as
# :backlog, :rcvbuf, :sndbuf are available here as well.
server.listen(addr, :tries => -1, :delay => 5, :backlog => 128)
end
166 167 168 |
# File 'lib/unicorn/configurator.rb', line 166 def after_fork(*args, &block) set_hook(:after_fork, block_given? ? block : args[0]) end |
#after_worker_exit(*args, &block) ⇒ Object
sets after_worker_exit hook to a given block. This block will be called by the master process after a worker exits:
after_worker_exit do |server,worker,status|
# status is a Process::Status instance for the exited worker process
unless status.success?
server.logger.error("worker process failure: #{status.inspect}")
end
end
after_worker_exit is only available in unicorn 5.3.0+
181 182 183 |
# File 'lib/unicorn/configurator.rb', line 181 def after_worker_exit(*args, &block) set_hook(:after_worker_exit, block_given? ? block : args[0], 3) end |
#after_worker_ready(*args, &block) ⇒ Object
sets after_worker_ready hook to a given block. This block will be called by a worker process after it has been fully loaded, directly before it starts responding to requests:
after_worker_ready do |server,worker|
server.logger.info("worker #{worker.nr} ready, dropping privileges")
worker.user('username', 'groupname')
end
Do not use Configurator#user if you rely on changing users in the after_worker_ready hook.
after_worker_ready is only available in unicorn 5.3.0+
198 199 200 |
# File 'lib/unicorn/configurator.rb', line 198 def after_worker_ready(*args, &block) set_hook(:after_worker_ready, block_given? ? block : args[0]) end |
#before_exec(*args, &block) ⇒ Object
sets the before_exec hook to a given Proc object. This Proc object will be called by the master process right before exec()-ing the new unicorn binary. This is useful for freeing certain OS resources that you do NOT wish to share with the reexeced child process. There is no corresponding after_exec hook (for obvious reasons).
215 216 217 |
# File 'lib/unicorn/configurator.rb', line 215 def before_exec(*args, &block) set_hook(:before_exec, block_given? ? block : args[0], 1) end |
#before_fork(*args, &block) ⇒ Object
sets before_fork got be a given Proc object. This Proc object will be called by the master process before forking each worker.
205 206 207 |
# File 'lib/unicorn/configurator.rb', line 205 def before_fork(*args, &block) set_hook(:before_fork, block_given? ? block : args[0]) end |
#check_client_connection(bool) ⇒ Object
When enabled, unicorn will check the client connection by writing the beginning of the HTTP headers before calling the application.
This will prevent calling the application for clients who have disconnected while their connection was queued.
This only affects clients connecting over Unix domain sockets and TCP via loopback (127...*). It is unlikely to detect disconnects if the client is on a remote host (even on a fast LAN).
This option cannot be used in conjunction with :tcp_nopush.
574 575 576 |
# File 'lib/unicorn/configurator.rb', line 574 def check_client_connection(bool) set_bool(:check_client_connection, bool) end |
#client_body_buffer_size(bytes) ⇒ Object
The maximum size (in bytes
) to buffer in memory before resorting to a temporary file. Default is 112 kilobytes. This option has no effect if “rewindable_input” is set to false
.
559 560 561 |
# File 'lib/unicorn/configurator.rb', line 559 def client_body_buffer_size(bytes) set_int(:client_body_buffer_size, bytes, 0) end |
#commit!(server, options = {}) ⇒ Object
:nodoc:
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/unicorn/configurator.rb', line 108 def commit!(server, = {}) #:nodoc: skip = [:skip] || [] if ready_pipe = RACKUP.delete(:ready_pipe) server.ready_pipe = ready_pipe end if set[:check_client_connection] set[:listeners].each do |address| if set[:listener_opts][address][:tcp_nopush] == true raise ArgumentError, "check_client_connection is incompatible with tcp_nopush:true" end end end set.each do |key, value| value == :unset and next skip.include?(key) and next server.__send__("#{key}=", value) end end |
#default_middleware(bool) ⇒ Object
sets whether to add default middleware in the development and deployment RACK_ENVs.
default_middleware is only available in unicorn 5.5.0+
276 277 278 |
# File 'lib/unicorn/configurator.rb', line 276 def default_middleware(bool) set_bool(:default_middleware, bool) end |
#early_hints(bool) ⇒ Object
sets whether to enable the proposed early hints Rack API. If enabled, Rails 5.2+ will automatically send a 103 Early Hint for all the ‘javascript_include_tag` and `stylesheet_link_tag` in your response. See: api.rubyonrails.org/v5.2/classes/ActionDispatch/Request.html#method-i-send_early_hints See also tools.ietf.org/html/rfc8297
285 286 287 |
# File 'lib/unicorn/configurator.rb', line 285 def early_hints(bool) set_bool(:early_hints, bool) end |
#expand_addr(address) ⇒ Object
expands “unix:path/to/foo” to a socket relative to the current path expands pathnames of sockets if relative to “~” or “~username” expands “*:port and ”:port“ to ”0.0.0.0:port“
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/unicorn/configurator.rb', line 640 def (address) #:nodoc: return "0.0.0.0:#{address}" if Integer === address return address unless String === address case address when %r{\Aunix:(.*)\z} File.($1) when %r{\A~} File.(address) when %r{\A(?:\*:)?(\d+)\z} "0.0.0.0:#$1" when %r{\A\[([a-fA-F0-9:]+)\]\z}, %r/\A((?:\d+\.){3}\d+)\z/ canonicalize_tcp($1, 80) when %r{\A\[([a-fA-F0-9:]+)\]:(\d+)\z}, %r{\A(.*):(\d+)\z} canonicalize_tcp($1, $2.to_i) else address end end |
#listen(address, options = {}) ⇒ Object
Adds an address
to the existing listener set. May be specified more than once. address
may be an Integer port number for a TCP port, an “IP_ADDRESS:PORT” for TCP listeners or a pathname for UNIX domain sockets.
listen 3000 # listen to port 3000 on all TCP interfaces
listen "127.0.0.1:3000" # listen to port 3000 on the loopback interface
listen "/path/to/.unicorn.sock" # listen on the given Unix domain socket
listen "[::1]:3000" # listen to port 3000 on the IPv6 loopback interface
When using Unix domain sockets, be sure: 1) the path matches the one used by nginx 2) uses the same filesystem namespace as the nginx process For systemd users using PrivateTmp=true (for either nginx or unicorn), this means Unix domain sockets must not be placed in /tmp
The following options may be specified (but are generally not needed):
- :backlog => number of clients
-
This is the backlog of the listen() syscall.
Some operating systems allow negative values here to specify the maximum allowable value. In most cases, this number is only recommendation and there are other OS-specific tunables and variables that can affect this number. See the listen(2) syscall documentation of your OS for the exact semantics of this.
If you are running unicorn on multiple machines, lowering this number can help your load balancer detect when a machine is overloaded and give requests to a different machine.
Default: 1024
Note: with the Linux kernel, the net.core.somaxconn sysctl defaults to 128, capping this value to 128. Raising the sysctl allows a larger backlog (which may not be desirable with multiple, load-balanced machines).
- :rcvbuf => bytes, :sndbuf => bytes
-
Maximum receive and send buffer sizes (in bytes) of sockets.
These correspond to the SO_RCVBUF and SO_SNDBUF settings which can be set via the setsockopt(2) syscall. Some kernels (e.g. Linux 2.4+) have intelligent auto-tuning mechanisms and there is no need (and it is sometimes detrimental) to specify them.
See the socket API documentation of your operating system to determine the exact semantics of these settings and other operating system-specific knobs where they can be specified.
Defaults: operating system defaults
- :tcp_nodelay => true or false
-
Disables Nagle’s algorithm on TCP sockets if
true
.Setting this to
true
can make streaming responses in Rails 3.1 appear more quickly at the cost of slightly higher bandwidth usage. The effect of this option is most visible if nginx is not used, but nginx remains highly recommended with unicorn.This has no effect on UNIX sockets.
Default:
true
(Nagle’s algorithm disabled) in unicorn This defaulted tofalse
in unicorn 3.x - :tcp_nopush => true or false
-
Enables/disables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
This prevents partial TCP frames from being sent out and reduces wakeups in nginx if it is on a different machine. Since unicorn is only designed for applications that send the response body quickly without keepalive, sockets will always be flushed on close to prevent delays.
This has no effect on UNIX sockets.
Default:
false
This defaulted totrue
in unicorn 3.4 - 3.7 - :ipv6only => true or false
-
This option makes IPv6-capable TCP listeners IPv6-only and unable to receive IPv4 queries on dual-stack systems. A separate IPv4-only listener is required if this is true.
Enabling this option for the IPv6-only listener and having a separate IPv4 listener is recommended if you wish to support IPv6 on the same TCP port. Otherwise, the value of env will appear as an ugly IPv4-mapped-IPv6 address for IPv4 clients (e.g “:ffff:10.0.0.1” instead of just “10.0.0.1”).
Default: Operating-system dependent
- :reuseport => true or false
-
This enables multiple, independently-started unicorn instances to bind to the same port (as long as all the processes enable this).
This option must be used when unicorn first binds the listen socket. It cannot be enabled when a socket is inherited via SIGUSR2 (but it will remain on if inherited), and it cannot be enabled directly via SIGHUP.
Note: there is a chance of connections being dropped if one of the unicorn instances is stopped while using this.
This is supported on *BSD systems and Linux 3.9 or later.
ref: lwn.net/Articles/542629/
Default: false (unset)
- :tries => Integer
-
Times to retry binding a socket if it is already in use
A negative number indicates we will retry indefinitely, this is useful for migrations and upgrades when individual workers are binding to different ports.
Default: 5
- :delay => seconds
-
Seconds to wait between successive
tries
Default: 0.5 seconds
- :umask => mode
-
Sets the file mode creation mask for UNIX sockets. If specified, this is usually in octal notation.
Typically UNIX domain sockets are created with more liberal file permissions than the rest of the application. By default, we create UNIX domain sockets to be readable and writable by all local users to give them the same accessibility as locally-bound TCP listeners.
This has no effect on TCP listeners.
Default: 0000 (world-read/writable)
- :tcp_defer_accept => Integer
-
Defer accept() until data is ready (Linux-only)
For Linux 2.6.32 and later, this is the number of retransmits to defer an accept() for if no data arrives, but the client will eventually be accepted after the specified number of retransmits regardless of whether data is ready.
For Linux before 2.6.32, this is a boolean option, and accepts are always deferred indefinitely if no data arrives. This is similar to
:accept_filter => "dataready"
under FreeBSD.Specifying
true
is synonymous for the default value(s) below, andfalse
ornil
is synonymous for a value of zero.A value of
1
is a good optimization for local networks and trusted clients. There is no good reason to ever disable this with azero
value with unicorn.Default: 1
- :accept_filter => String
-
defer accept() until data is ready (FreeBSD-only)
This enables either the “dataready” or (default) “httpready” accept() filter under FreeBSD. This is intended as an optimization to reduce context switches with common GET/HEAD requests.
There is no good reason to change from the default.
Default: “httpready”
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 |
# File 'lib/unicorn/configurator.rb', line 483 def listen(address, = {}) address = (address) if String === address [ :umask, :backlog, :sndbuf, :rcvbuf, :tries ].each do |key| value = [key] or next Integer === value or raise ArgumentError, "not an integer: #{key}=#{value.inspect}" end [ :tcp_nodelay, :tcp_nopush, :ipv6only, :reuseport ].each do |key| (value = [key]).nil? and next TrueClass === value || FalseClass === value or raise ArgumentError, "not boolean: #{key}=#{value.inspect}" end unless (value = [:delay]).nil? Numeric === value or raise ArgumentError, "not numeric: delay=#{value.inspect}" end set[:listener_opts][address].merge!() end set[:listeners] << address end |
#listeners(addresses) ⇒ Object
sets listeners to the given addresses
, replacing or augmenting the current set. This is for the global listener pool shared by all worker processes. For per-worker listeners, see the after_fork example This is for internal API use only, do not use it in your Unicorn config file. Use listen instead.
294 295 296 297 298 |
# File 'lib/unicorn/configurator.rb', line 294 def listeners(addresses) # :nodoc: Array === addresses or addresses = Array(addresses) addresses.map! { |addr| (addr) } set[:listeners] = addresses end |
#logger(obj) ⇒ Object
sets object to the obj
Logger-like object. The new Logger-like object must respond to the following methods:
-
debug
-
info
-
warn
-
error
-
fatal
The default Logger will log its output to the path specified by stderr_path
. If you’re running Unicorn daemonized, then you must specify a path to prevent error messages from going to /dev/null.
143 144 145 146 147 148 149 150 |
# File 'lib/unicorn/configurator.rb', line 143 def logger(obj) %w(debug info warn error fatal).each do |m| obj.respond_to?(m) and next raise ArgumentError, "logger=#{obj} does not respond to method=#{m}" end set[:logger] = obj end |
#pid(path) ⇒ Object
sets the path
for the PID file of the unicorn master process
507 |
# File 'lib/unicorn/configurator.rb', line 507 def pid(path); set_path(:pid, path); end |
#preload_app(bool) ⇒ Object
Enabling this preloads an application before forking worker processes. This allows memory savings when using a copy-on-write-friendly GC but can cause bad things to happen when resources like sockets are opened at load time by the master process and shared by multiple children. People enabling this are highly encouraged to look at the before_fork/after_fork hooks to properly close/reopen sockets. Files opened for logging do not have to be reopened as (unbuffered-in-userspace) files opened with the File::APPEND flag are written to atomically on UNIX.
In addition to reloading the unicorn-specific config settings, SIGHUP will reload application code in the working directory/symlink when workers are gracefully restarted when preload_app=false (the default). As reloading the application sometimes requires RubyGems updates, Gem.refresh
is always called before the application is loaded (for RubyGems users).
During deployments, care should always be taken to ensure your applications are properly deployed and running. Using preload_app=false (the default) means you must check if your application is responding properly after a deployment. Improperly deployed applications can go into a spawn loop if the application fails to load. While your children are in a spawn loop, it is is possible to fix an application by properly deploying all required code and dependencies. Using preload_app=true means any application load error will cause the master process to exit with an error.
537 538 539 |
# File 'lib/unicorn/configurator.rb', line 537 def preload_app(bool) set_bool(:preload_app, bool) end |
#reload(merge_defaults = true) ⇒ Object
:nodoc:
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/unicorn/configurator.rb', line 81 def reload(merge_defaults = true) #:nodoc: if merge_defaults && @use_defaults set.merge!(DEFAULTS) if @use_defaults end instance_eval(File.read(config_file), config_file) if config_file parse_rackup_file RACKUP[:set_listener] and set[:listeners] << "#{RACKUP[:host]}:#{RACKUP[:port]}" RACKUP[:no_default_middleware] and set[:default_middleware] = false # unicorn_rails creates dirs here after working_directory is bound after_reload.call if after_reload # working_directory binds immediately (easier error checking that way), # now ensure any paths we changed are correctly set. [ :pid, :stderr_path, :stdout_path ].each do |var| String === (path = set[var]) or next path = File.(path) File.writable?(path) || File.writable?(File.dirname(path)) or \ raise ArgumentError, "directory for #{var}=#{path} not writable" end end |
#rewindable_input(bool) ⇒ Object
Toggles making env rewindable. Disabling rewindability can improve performance by lowering I/O and memory usage for applications that accept uploads. Keep in mind that the Rack 1.x spec requires env to be rewindable, but the Rack 2.x spec does not.
rewindable_input
defaults to true
for compatibility. Setting it to false
may be safe for applications and frameworks developed for Rack 2.x and later.
551 552 553 |
# File 'lib/unicorn/configurator.rb', line 551 def rewindable_input(bool) set_bool(:rewindable_input, bool) end |
#stderr_path(path) ⇒ Object
Allow redirecting $stderr to a given path. Unlike doing this from the shell, this allows the unicorn process to know the path its writing to and rotate the file if it is used for logging. The file will be opened with the File::APPEND flag and writes synchronized to the kernel (but not necessarily to disk) so multiple processes can safely append to it.
If you are daemonizing and using the default logger
, it is important to specify this as errors will otherwise be lost to /dev/null. Some applications/libraries may also triggering warnings that go to stderr, and they will end up here.
589 590 591 |
# File 'lib/unicorn/configurator.rb', line 589 def stderr_path(path) set_path(:stderr_path, path) end |
#stdout_path(path) ⇒ Object
Same as stderr_path, except for $stdout. Not many Rack applications write to $stdout, but any that do will have their output written here. It is safe to point this to the same location a stderr_path. Like stderr_path, this defaults to /dev/null when daemonized.
597 598 599 |
# File 'lib/unicorn/configurator.rb', line 597 def stdout_path(path) set_path(:stdout_path, path) end |
#timeout(seconds) ⇒ Object
sets the timeout of worker processes to seconds
. Workers handling the request/app.call/response cycle taking longer than this time period will be forcibly killed (via SIGKILL). This timeout is enforced by the master process itself and not subject to the scheduling limitations by the worker process. Due the low-complexity, low-overhead implementation, timeouts of less than 3.0 seconds can be considered inaccurate and unsafe.
For running Unicorn behind nginx, it is recommended to set “fail_timeout=0” for in your nginx configuration like this to have nginx always retry backends that may have had workers SIGKILL-ed due to timeouts.
upstream unicorn_backend {
# for UNIX domain socket setups:
server unix:/path/to/.unicorn.sock fail_timeout=0;
# for TCP setups
server 192.168.0.7:8080 fail_timeout=0;
server 192.168.0.8:8080 fail_timeout=0;
server 192.168.0.9:8080 fail_timeout=0;
}
See nginx.org/en/docs/http/ngx_http_upstream_module.html for more details on nginx upstream configuration.
244 245 246 247 248 249 |
# File 'lib/unicorn/configurator.rb', line 244 def timeout(seconds) set_int(:timeout, seconds, 3) # POSIX says 31 days is the smallest allowed maximum timeout for select() max = 30 * 60 * 60 * 24 set[:timeout] = seconds > max ? max : seconds end |
#user(user, group = nil) ⇒ Object
Runs worker processes as the specified user
and group
. The master process always stays running as the user who started it. This switch will occur after calling the after_fork hook, and only if the Worker#user method is not called in the after_fork hook group
is optional and will not change if unspecified.
Do not use Configurator#user if you rely on changing users in the after_worker_ready hook. Instead, you need to call Worker#user directly in after_worker_ready.
630 631 632 633 634 635 |
# File 'lib/unicorn/configurator.rb', line 630 def user(user, group = nil) # raises ArgumentError on invalid user/group Etc.getpwnam(user) Etc.getgrnam(group) if group set[:user] = [ user, group ] end |
#worker_exec(bool) ⇒ Object
Whether to exec in each worker process after forking. This changes the memory layout of each worker process, which is a security feature designed to defeat possible address space discovery attacks. Note that using worker_exec only makes sense if you are not preloading the application, and will result in higher memory usage.
worker_exec is only available in unicorn 5.3.0+
258 259 260 |
# File 'lib/unicorn/configurator.rb', line 258 def worker_exec(bool) set_bool(:worker_exec, bool) end |
#worker_processes(nr) ⇒ Object
sets the current number of worker_processes to nr
. Each worker process will serve exactly one client at a time. You can increment or decrement this value at runtime by sending SIGTTIN or SIGTTOU respectively to the master process without reloading the rest of your Unicorn configuration. See the SIGNALS document for more information.
268 269 270 |
# File 'lib/unicorn/configurator.rb', line 268 def worker_processes(nr) set_int(:worker_processes, nr, 1) end |
#working_directory(path) ⇒ Object
sets the working directory for Unicorn. This ensures SIGUSR2 will start a new instance of Unicorn in this directory. This may be a symlink, a common scenario for Capistrano users. Unlike all other Unicorn configuration directives, this binds immediately for error checking and cannot be undone by unsetting it in the configuration file and reloading.
607 608 609 610 611 612 613 614 615 616 617 618 619 |
# File 'lib/unicorn/configurator.rb', line 607 def working_directory(path) # just let chdir raise errors path = File.(path) if config_file && ! config_file.start_with?('/') && ! File.readable?("#{path}/#{config_file}") raise ArgumentError, "config_file=#{config_file} would not be accessible in" \ " working_directory=#{path}" end Dir.chdir(path) Unicorn::HttpServer::START_CTX[:cwd] = ENV["PWD"] = path end |