Unicorn::Configurator

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)

   # drop permissions to "www-data" in the worker
   # generally there's no reason to start Unicorn as a priviledged user
   # as it is not recommended to expose Unicorn to public clients.
   worker.user('www-data', 'www-data') if Process.euid == 0
 end

     # File lib/unicorn/configurator.rb, line 109
109:     def after_fork(*args, &block)
110:       set_hook(:after_fork, block_given? ? block : args[0])
111:     end

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).

     # File lib/unicorn/configurator.rb, line 126
126:     def before_exec(*args, &block)
127:       set_hook(:before_exec, block_given? ? block : args[0], 1)
128:     end

sets before_fork got be a given Proc object. This Proc object will be called by the master process before forking each worker.

     # File lib/unicorn/configurator.rb, line 116
116:     def before_fork(*args, &block)
117:       set_hook(:before_fork, block_given? ? block : args[0])
118:     end

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“

     # File lib/unicorn/configurator.rb, line 353
353:     def expand_addr(address) #:nodoc
354:       return "0.0.0.0:#{address}" if Integer === address
355:       return address unless String === address
356: 
357:       case address
358:       when %r{\Aunix:(.*)\z}
359:         File.expand_path($1)
360:       when %r{\A~}
361:         File.expand_path(address)
362:       when %r{\A(?:\*:)?(\d+)\z}
363:         "0.0.0.0:#$1"
364:       when %r{\A(.*):(\d+)\z}
365:         # canonicalize the name
366:         packed = Socket.pack_sockaddr_in($2.to_i, $1)
367:         Socket.unpack_sockaddr_in(packed).reverse!.join(':')
368:       else
369:         address
370:       end
371:     end

adds an address to the existing listener set.

The following options may be specified (but are generally not needed):

:backlog: 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

:rcvbuf, :sndbuf: maximum receive and send buffer sizes 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: disables Nagle’s algorithm on TCP sockets

This has no effect on UNIX sockets.

Default: operating system defaults (usually Nagle’s algorithm enabled)

:tcp_nopush: enables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD

This will prevent partial TCP frames from being sent out. Enabling tcp_nopush is generally not needed or recommended as controlling tcp_nodelay already provides sufficient latency reduction whereas Unicorn does not know when the best times are for flushing corked sockets.

This has no effect on UNIX sockets.

:tries: 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 to wait between successive tries

Default: 0.5 seconds

:umask: sets the file mode creation mask for UNIX sockets

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: 0 (world read/writable)

     # File lib/unicorn/configurator.rb, line 259
259:     def listen(address, opt = {})
260:       address = expand_addr(address)
261:       if String === address
262:         [ :umask, :backlog, :sndbuf, :rcvbuf, :tries ].each do |key|
263:           value = opt[key] or next
264:           Integer === value or
265:             raise ArgumentError, "not an integer: #{key}=#{value.inspect}"
266:         end
267:         [ :tcp_nodelay, :tcp_nopush ].each do |key|
268:           (value = opt[key]).nil? and next
269:           TrueClass === value || FalseClass === value or
270:             raise ArgumentError, "not boolean: #{key}=#{value.inspect}"
271:         end
272:         unless (value = opt[:delay]).nil?
273:           Numeric === value or
274:             raise ArgumentError, "not numeric: delay=#{value.inspect}"
275:         end
276:         set[:listener_opts][address].merge!(opt)
277:       end
278: 
279:       set[:listeners] << address
280:     end

sets object to the new Logger-like object. The new logger-like object must respond to the following methods:

 +debug+, +info+, +warn+, +error+, +fatal+, +close+

    # File lib/unicorn/configurator.rb, line 81
81:     def logger(new)
82:       %w(debug info warn error fatal close).each do |m|
83:         new.respond_to?(m) and next
84:         raise ArgumentError, "logger=#{new} does not respond to method=#{m}"
85:       end
86: 
87:       set[:logger] = new
88:     end

sets the path for the PID file of the unicorn master process

     # File lib/unicorn/configurator.rb, line 283
283:     def pid(path); set_path(:pid, path); end

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.

     # File lib/unicorn/configurator.rb, line 298
298:     def preload_app(bool)
299:       case bool
300:       when TrueClass, FalseClass
301:         set[:preload_app] = bool
302:       else
303:         raise ArgumentError, "preload_app=#{bool.inspect} not a boolean"
304:       end
305:     end

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.

     # File lib/unicorn/configurator.rb, line 313
313:     def stderr_path(path)
314:       set_path(:stderr_path, path)
315:     end

Same as stderr_path, except for $stdout

     # File lib/unicorn/configurator.rb, line 318
318:     def stdout_path(path)
319:       set_path(:stdout_path, path)
320:     end

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.

   # See http://wiki.nginx.org/NginxHttpUpstreamModule for more details
   # on nginx upstream configuration:
   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;
   }

     # File lib/unicorn/configurator.rb, line 154
154:     def timeout(seconds)
155:       Numeric === seconds or raise ArgumentError,
156:                                   "not numeric: timeout=#{seconds.inspect}"
157:       seconds >= 3 or raise ArgumentError,
158:                                   "too low: timeout=#{seconds.inspect}"
159:       set[:timeout] = seconds
160:     end

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

     # File lib/unicorn/configurator.rb, line 343
343:     def user(user, group = nil)
344:       # raises ArgumentError on invalid user/group
345:       Etc.getpwnam(user)
346:       Etc.getgrnam(group) if group
347:       set[:user] = [ user, group ]
348:     end

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.

     # File lib/unicorn/configurator.rb, line 168
168:     def worker_processes(nr)
169:       Integer === nr or raise ArgumentError,
170:                              "not an integer: worker_processes=#{nr.inspect}"
171:       nr >= 0 or raise ArgumentError,
172:                              "not non-negative: worker_processes=#{nr.inspect}"
173:       set[:worker_processes] = nr
174:     end

sets the working directory for Unicorn. This ensures USR2 will start a new instance of Unicorn in this directory. This may be a symlink.

     # File lib/unicorn/configurator.rb, line 325
325:     def working_directory(path)
326:       # just let chdir raise errors
327:       path = File.expand_path(path)
328:       if config_file &&
329:          config_file[0] != ?/ &&
330:          ! test(?r, "#{path}/#{config_file}")
331:         raise ArgumentError,
332:               "config_file=#{config_file} would not be accessible in" \
333:               " working_directory=#{path}"
334:       end
335:       Dir.chdir(path)
336:       HttpServer::START_CTX[:cwd] = ENV["PWD"] = path
337:     end