1 # -*- encoding: binary -*-
4 # Implements a simple DSL for configuring a \Unicorn server.
6 # See http://unicorn.bogomips.org/examples/unicorn.conf.rb and
7 # http://unicorn.bogomips.org/examples/unicorn.conf.minimal.rb
8 # example configuration files. An example config file for use with
9 # nginx is also available at
10 # http://unicorn.bogomips.org/examples/nginx.conf
12 # See the link:/TUNING.html document for more information on tuning unicorn.
13 class Unicorn::Configurator
17 attr_accessor :set, :config_file, :after_reload
19 # used to stash stuff for deferred processing of cli options in
20 # config.ru after "working_directory" is bound. Do not rely on
21 # this being around later on...
24 :host => Unicorn::Const::DEFAULT_HOST,
25 :port => Unicorn::Const::DEFAULT_PORT,
26 :set_listener => false,
27 :options => { :listeners => [] }
30 # Default settings for Unicorn
33 :logger => Logger.new($stderr),
34 :worker_processes => 1,
35 :after_fork => lambda { |server, worker|
36 server.logger.info("worker=#{worker.nr} spawned pid=#{$$}")
38 :before_fork => lambda { |server, worker|
39 server.logger.info("worker=#{worker.nr} spawning...")
41 :before_exec => lambda { |server|
42 server.logger.info("forked child re-executing...")
45 :preload_app => false,
46 :check_client_connection => false,
47 :rewindable_input => true, # for Rack 2.x: (Rack::VERSION[0] <= 1),
48 :client_body_buffer_size => Unicorn::Const::MAX_BODY,
52 def initialize(defaults = {}) #:nodoc:
53 self.set = Hash.new(:unset)
54 @use_defaults = defaults.delete(:use_defaults)
55 self.config_file = defaults.delete(:config_file)
57 # after_reload is only used by unicorn_rails, unsupported otherwise
58 self.after_reload = defaults.delete(:after_reload)
60 set.merge!(DEFAULTS) if @use_defaults
61 defaults.each { |key, value| self.__send__(key, value) }
62 Hash === set[:listener_opts] or
63 set[:listener_opts] = Hash.new { |hash,key| hash[key] = {} }
64 Array === set[:listeners] or set[:listeners] = []
68 def reload(merge_defaults = true) #:nodoc:
69 if merge_defaults && @use_defaults
70 set.merge!(DEFAULTS) if @use_defaults
72 instance_eval(File.read(config_file), config_file) if config_file
76 RACKUP[:set_listener] and
77 set[:listeners] << "#{RACKUP[:host]}:#{RACKUP[:port]}"
79 # unicorn_rails creates dirs here after working_directory is bound
80 after_reload.call if after_reload
82 # working_directory binds immediately (easier error checking that way),
83 # now ensure any paths we changed are correctly set.
84 [ :pid, :stderr_path, :stdout_path ].each do |var|
85 String === (path = set[var]) or next
86 path = File.expand_path(path)
87 File.writable?(path) || File.writable?(File.dirname(path)) or \
88 raise ArgumentError, "directory for #{var}=#{path} not writable"
92 def commit!(server, options = {}) #:nodoc:
93 skip = options[:skip] || []
94 if ready_pipe = RACKUP.delete(:ready_pipe)
95 server.ready_pipe = ready_pipe
97 if set[:check_client_connection]
98 set[:listeners].each do |address|
99 if set[:listener_opts][address][:tcp_nopush] == true
101 "check_client_connection is incompatible with tcp_nopush:true"
105 set.each do |key, value|
106 value == :unset and next
107 skip.include?(key) and next
108 server.__send__("#{key}=", value)
112 def [](key) # :nodoc:
116 # sets object to the +obj+ Logger-like object. The new Logger-like
117 # object must respond to the following methods:
123 # The default Logger will log its output to the path specified
124 # by +stderr_path+. If you're running Unicorn daemonized, then
125 # you must specify a path to prevent error messages from going
128 %w(debug info warn error fatal).each do |m|
129 obj.respond_to?(m) and next
130 raise ArgumentError, "logger=#{obj} does not respond to method=#{m}"
136 # sets after_fork hook to a given block. This block will be called by
137 # the worker after forking. The following is an example hook which adds
138 # a per-process listener to every worker:
140 # after_fork do |server,worker|
141 # # per-process listener ports for debugging/admin:
142 # addr = "127.0.0.1:#{9293 + worker.nr}"
144 # # the negative :tries parameter indicates we will retry forever
145 # # waiting on the existing process to exit with a 5 second :delay
146 # # Existing options for Unicorn::Configurator#listen such as
147 # # :backlog, :rcvbuf, :sndbuf are available here as well.
148 # server.listen(addr, :tries => -1, :delay => 5, :backlog => 128)
150 def after_fork(*args, &block)
151 set_hook(:after_fork, block_given? ? block : args[0])
154 # sets before_fork got be a given Proc object. This Proc
155 # object will be called by the master process before forking
157 def before_fork(*args, &block)
158 set_hook(:before_fork, block_given? ? block : args[0])
161 # sets the before_exec hook to a given Proc object. This
162 # Proc object will be called by the master process right
163 # before exec()-ing the new unicorn binary. This is useful
164 # for freeing certain OS resources that you do NOT wish to
165 # share with the reexeced child process.
166 # There is no corresponding after_exec hook (for obvious reasons).
167 def before_exec(*args, &block)
168 set_hook(:before_exec, block_given? ? block : args[0], 1)
171 # sets the timeout of worker processes to +seconds+. Workers
172 # handling the request/app.call/response cycle taking longer than
173 # this time period will be forcibly killed (via SIGKILL). This
174 # timeout is enforced by the master process itself and not subject
175 # to the scheduling limitations by the worker process. Due the
176 # low-complexity, low-overhead implementation, timeouts of less
177 # than 3.0 seconds can be considered inaccurate and unsafe.
179 # For running Unicorn behind nginx, it is recommended to set
180 # "fail_timeout=0" for in your nginx configuration like this
181 # to have nginx always retry backends that may have had workers
182 # SIGKILL-ed due to timeouts.
184 # # See http://wiki.nginx.org/NginxHttpUpstreamModule for more details
185 # # on nginx upstream configuration:
186 # upstream unicorn_backend {
187 # # for UNIX domain socket setups:
188 # server unix:/path/to/.unicorn.sock fail_timeout=0;
191 # server 192.168.0.7:8080 fail_timeout=0;
192 # server 192.168.0.8:8080 fail_timeout=0;
193 # server 192.168.0.9:8080 fail_timeout=0;
196 set_int(:timeout, seconds, 3)
197 # POSIX says 31 days is the smallest allowed maximum timeout for select()
198 max = 30 * 60 * 60 * 24
199 set[:timeout] = seconds > max ? max : seconds
202 # sets the current number of worker_processes to +nr+. Each worker
203 # process will serve exactly one client at a time. You can
204 # increment or decrement this value at runtime by sending SIGTTIN
205 # or SIGTTOU respectively to the master process without reloading
206 # the rest of your Unicorn configuration. See the SIGNALS document
207 # for more information.
208 def worker_processes(nr)
209 set_int(:worker_processes, nr, 1)
212 # sets listeners to the given +addresses+, replacing or augmenting the
213 # current set. This is for the global listener pool shared by all
214 # worker processes. For per-worker listeners, see the after_fork example
215 # This is for internal API use only, do not use it in your Unicorn
216 # config file. Use listen instead.
217 def listeners(addresses) # :nodoc:
218 Array === addresses or addresses = Array(addresses)
219 addresses.map! { |addr| expand_addr(addr) }
220 set[:listeners] = addresses
223 # Adds an +address+ to the existing listener set. May be specified more
224 # than once. +address+ may be an Integer port number for a TCP port, an
225 # "IP_ADDRESS:PORT" for TCP listeners or a pathname for UNIX domain sockets.
227 # listen 3000 # listen to port 3000 on all TCP interfaces
228 # listen "127.0.0.1:3000" # listen to port 3000 on the loopback interface
229 # listen "/path/to/.unicorn.sock" # listen on the given Unix domain socket
230 # listen "[::1]:3000" # listen to port 3000 on the IPv6 loopback interface
232 # When using Unix domain sockets, be sure:
233 # 1) the path matches the one used by nginx
234 # 2) uses the same filesystem namespace as the nginx process
235 # For systemd users using PrivateTmp=true (for either nginx or unicorn),
236 # this means Unix domain sockets must not be placed in /tmp
238 # The following options may be specified (but are generally not needed):
240 # [:backlog => number of clients]
242 # This is the backlog of the listen() syscall.
244 # Some operating systems allow negative values here to specify the
245 # maximum allowable value. In most cases, this number is only
246 # recommendation and there are other OS-specific tunables and
247 # variables that can affect this number. See the listen(2)
248 # syscall documentation of your OS for the exact semantics of
251 # If you are running unicorn on multiple machines, lowering this number
252 # can help your load balancer detect when a machine is overloaded
253 # and give requests to a different machine.
257 # [:rcvbuf => bytes, :sndbuf => bytes]
259 # Maximum receive and send buffer sizes (in bytes) of sockets.
261 # These correspond to the SO_RCVBUF and SO_SNDBUF settings which
262 # can be set via the setsockopt(2) syscall. Some kernels
263 # (e.g. Linux 2.4+) have intelligent auto-tuning mechanisms and
264 # there is no need (and it is sometimes detrimental) to specify them.
266 # See the socket API documentation of your operating system
267 # to determine the exact semantics of these settings and
268 # other operating system-specific knobs where they can be
271 # Defaults: operating system defaults
273 # [:tcp_nodelay => true or false]
275 # Disables Nagle's algorithm on TCP sockets if +true+.
277 # Setting this to +true+ can make streaming responses in Rails 3.1
278 # appear more quickly at the cost of slightly higher bandwidth usage.
279 # The effect of this option is most visible if nginx is not used,
280 # but nginx remains highly recommended with \Unicorn.
282 # This has no effect on UNIX sockets.
284 # Default: +true+ (Nagle's algorithm disabled) in \Unicorn,
285 # +true+ in Rainbows! This defaulted to +false+ in \Unicorn
288 # [:tcp_nopush => true or false]
290 # Enables/disables TCP_CORK in Linux or TCP_NOPUSH in FreeBSD
292 # This prevents partial TCP frames from being sent out and reduces
293 # wakeups in nginx if it is on a different machine. Since \Unicorn
294 # is only designed for applications that send the response body
295 # quickly without keepalive, sockets will always be flushed on close
298 # This has no effect on UNIX sockets.
301 # This defaulted to +true+ in \Unicorn 3.4 - 3.7
303 # [:ipv6only => true or false]
305 # This option makes IPv6-capable TCP listeners IPv6-only and unable
306 # to receive IPv4 queries on dual-stack systems. A separate IPv4-only
307 # listener is required if this is true.
309 # This option is only available for Ruby 1.9.2 and later.
311 # Enabling this option for the IPv6-only listener and having a
312 # separate IPv4 listener is recommended if you wish to support IPv6
313 # on the same TCP port. Otherwise, the value of \env[\"REMOTE_ADDR\"]
314 # will appear as an ugly IPv4-mapped-IPv6 address for IPv4 clients
315 # (e.g ":ffff:10.0.0.1" instead of just "10.0.0.1").
317 # Default: Operating-system dependent
319 # [:reuseport => true or false]
321 # This enables multiple, independently-started unicorn instances to
322 # bind to the same port (as long as all the processes enable this).
324 # This option must be used when unicorn first binds the listen socket.
325 # It cannot be enabled when a socket is inherited via SIGUSR2
326 # (but it will remain on if inherited), and it cannot be enabled
327 # directly via SIGHUP.
329 # Note: there is a chance of connections being dropped if
330 # one of the unicorn instances is stopped while using this.
332 # This is supported on *BSD systems and Linux 3.9 or later.
334 # ref: https://lwn.net/Articles/542629/
336 # Default: false (unset)
338 # [:tries => Integer]
340 # Times to retry binding a socket if it is already in use
342 # A negative number indicates we will retry indefinitely, this is
343 # useful for migrations and upgrades when individual workers
344 # are binding to different ports.
348 # [:delay => seconds]
350 # Seconds to wait between successive +tries+
352 # Default: 0.5 seconds
356 # Sets the file mode creation mask for UNIX sockets. If specified,
357 # this is usually in octal notation.
359 # Typically UNIX domain sockets are created with more liberal
360 # file permissions than the rest of the application. By default,
361 # we create UNIX domain sockets to be readable and writable by
362 # all local users to give them the same accessibility as
363 # locally-bound TCP listeners.
365 # This has no effect on TCP listeners.
367 # Default: 0000 (world-read/writable)
369 # [:tcp_defer_accept => Integer]
371 # Defer accept() until data is ready (Linux-only)
373 # For Linux 2.6.32 and later, this is the number of retransmits to
374 # defer an accept() for if no data arrives, but the client will
375 # eventually be accepted after the specified number of retransmits
376 # regardless of whether data is ready.
378 # For Linux before 2.6.32, this is a boolean option, and
379 # accepts are _always_ deferred indefinitely if no data arrives.
380 # This is similar to <code>:accept_filter => "dataready"</code>
383 # Specifying +true+ is synonymous for the default value(s) below,
384 # and +false+ or +nil+ is synonymous for a value of zero.
386 # A value of +1+ is a good optimization for local networks
387 # and trusted clients. For Rainbows! and Zbatery users, a higher
388 # value (e.g. +60+) provides more protection against some
389 # denial-of-service attacks. There is no good reason to ever
390 # disable this with a +zero+ value when serving HTTP.
392 # Default: 1 retransmit for \Unicorn, 60 for Rainbows! 0.95.0\+
394 # [:accept_filter => String]
396 # defer accept() until data is ready (FreeBSD-only)
398 # This enables either the "dataready" or (default) "httpready"
399 # accept() filter under FreeBSD. This is intended as an
400 # optimization to reduce context switches with common GET/HEAD
401 # requests. For Rainbows! and Zbatery users, this provides
402 # some protection against certain denial-of-service attacks, too.
404 # There is no good reason to change from the default.
406 # Default: "httpready"
407 def listen(address, options = {})
408 address = expand_addr(address)
409 if String === address
410 [ :umask, :backlog, :sndbuf, :rcvbuf, :tries ].each do |key|
411 value = options[key] or next
413 raise ArgumentError, "not an integer: #{key}=#{value.inspect}"
415 [ :tcp_nodelay, :tcp_nopush, :ipv6only, :reuseport ].each do |key|
416 (value = options[key]).nil? and next
417 TrueClass === value || FalseClass === value or
418 raise ArgumentError, "not boolean: #{key}=#{value.inspect}"
420 unless (value = options[:delay]).nil?
422 raise ArgumentError, "not numeric: delay=#{value.inspect}"
424 set[:listener_opts][address].merge!(options)
427 set[:listeners] << address
430 # sets the +path+ for the PID file of the unicorn master process
431 def pid(path); set_path(:pid, path); end
433 # Enabling this preloads an application before forking worker
434 # processes. This allows memory savings when using a
435 # copy-on-write-friendly GC but can cause bad things to happen when
436 # resources like sockets are opened at load time by the master
437 # process and shared by multiple children. People enabling this are
438 # highly encouraged to look at the before_fork/after_fork hooks to
439 # properly close/reopen sockets. Files opened for logging do not
440 # have to be reopened as (unbuffered-in-userspace) files opened with
441 # the File::APPEND flag are written to atomically on UNIX.
443 # In addition to reloading the unicorn-specific config settings,
444 # SIGHUP will reload application code in the working
445 # directory/symlink when workers are gracefully restarted when
446 # preload_app=false (the default). As reloading the application
447 # sometimes requires RubyGems updates, +Gem.refresh+ is always
448 # called before the application is loaded (for RubyGems users).
450 # During deployments, care should _always_ be taken to ensure your
451 # applications are properly deployed and running. Using
452 # preload_app=false (the default) means you _must_ check if
453 # your application is responding properly after a deployment.
454 # Improperly deployed applications can go into a spawn loop
455 # if the application fails to load. While your children are
456 # in a spawn loop, it is is possible to fix an application
457 # by properly deploying all required code and dependencies.
458 # Using preload_app=true means any application load error will
459 # cause the master process to exit with an error.
461 def preload_app(bool)
462 set_bool(:preload_app, bool)
465 # Toggles making \env[\"rack.input\"] rewindable.
466 # Disabling rewindability can improve performance by lowering
467 # I/O and memory usage for applications that accept uploads.
468 # Keep in mind that the Rack 1.x spec requires
469 # \env[\"rack.input\"] to be rewindable, so this allows
470 # intentionally violating the current Rack 1.x spec.
472 # +rewindable_input+ defaults to +true+ when used with Rack 1.x for
473 # Rack conformance. When Rack 2.x is finalized, this will most
474 # likely default to +false+ while still conforming to the newer
475 # (less demanding) spec.
476 def rewindable_input(bool)
477 set_bool(:rewindable_input, bool)
480 # The maximum size (in +bytes+) to buffer in memory before
481 # resorting to a temporary file. Default is 112 kilobytes.
482 # This option has no effect if "rewindable_input" is set to
484 def client_body_buffer_size(bytes)
485 set_int(:client_body_buffer_size, bytes, 0)
488 # When enabled, unicorn will check the client connection by writing
489 # the beginning of the HTTP headers before calling the application.
491 # This will prevent calling the application for clients who have
492 # disconnected while their connection was queued.
494 # This only affects clients connecting over Unix domain sockets
495 # and TCP via loopback (127.*.*.*). It is unlikely to detect
496 # disconnects if the client is on a remote host (even on a fast LAN).
498 # This option cannot be used in conjunction with :tcp_nopush.
499 def check_client_connection(bool)
500 set_bool(:check_client_connection, bool)
503 # Allow redirecting $stderr to a given path. Unlike doing this from
504 # the shell, this allows the unicorn process to know the path its
505 # writing to and rotate the file if it is used for logging. The
506 # file will be opened with the File::APPEND flag and writes
507 # synchronized to the kernel (but not necessarily to _disk_) so
508 # multiple processes can safely append to it.
510 # If you are daemonizing and using the default +logger+, it is important
511 # to specify this as errors will otherwise be lost to /dev/null.
512 # Some applications/libraries may also triggering warnings that go to
513 # stderr, and they will end up here.
514 def stderr_path(path)
515 set_path(:stderr_path, path)
518 # Same as stderr_path, except for $stdout. Not many Rack applications
519 # write to $stdout, but any that do will have their output written here.
520 # It is safe to point this to the same location a stderr_path.
521 # Like stderr_path, this defaults to /dev/null when daemonized.
522 def stdout_path(path)
523 set_path(:stdout_path, path)
526 # sets the working directory for Unicorn. This ensures SIGUSR2 will
527 # start a new instance of Unicorn in this directory. This may be
528 # a symlink, a common scenario for Capistrano users. Unlike
529 # all other Unicorn configuration directives, this binds immediately
530 # for error checking and cannot be undone by unsetting it in the
531 # configuration file and reloading.
532 def working_directory(path)
533 # just let chdir raise errors
534 path = File.expand_path(path)
536 config_file[0] != ?/ &&
537 ! File.readable?("#{path}/#{config_file}")
539 "config_file=#{config_file} would not be accessible in" \
540 " working_directory=#{path}"
543 Unicorn::HttpServer::START_CTX[:cwd] = ENV["PWD"] = path
546 # Runs worker processes as the specified +user+ and +group+.
547 # The master process always stays running as the user who started it.
548 # This switch will occur after calling the after_fork hook, and only
549 # if the Worker#user method is not called in the after_fork hook
550 # +group+ is optional and will not change if unspecified.
551 def user(user, group = nil)
552 # raises ArgumentError on invalid user/group
554 Etc.getgrnam(group) if group
555 set[:user] = [ user, group ]
558 # expands "unix:path/to/foo" to a socket relative to the current path
559 # expands pathnames of sockets if relative to "~" or "~username"
560 # expands "*:port and ":port" to "0.0.0.0:port"
561 def expand_addr(address) #:nodoc:
562 return "0.0.0.0:#{address}" if Integer === address
563 return address unless String === address
566 when %r{\Aunix:(.*)\z}
569 File.expand_path(address)
570 when %r{\A(?:\*:)?(\d+)\z}
572 when %r{\A\[([a-fA-F0-9:]+)\]\z}, %r/\A((?:\d+\.){3}\d+)\z/
573 canonicalize_tcp($1, 80)
574 when %r{\A\[([a-fA-F0-9:]+)\]:(\d+)\z}, %r{\A(.*):(\d+)\z}
575 canonicalize_tcp($1, $2.to_i)
582 def set_int(var, n, min) #:nodoc:
583 Integer === n or raise ArgumentError, "not an integer: #{var}=#{n.inspect}"
584 n >= min or raise ArgumentError, "too low (< #{min}): #{var}=#{n.inspect}"
588 def canonicalize_tcp(addr, port)
589 packed = Socket.pack_sockaddr_in(port, addr)
590 port, addr = Socket.unpack_sockaddr_in(packed)
591 /:/ =~ addr ? "[#{addr}]:#{port}" : "#{addr}:#{port}"
594 def set_path(var, path) #:nodoc:
596 when NilClass, String
603 def check_bool(var, bool) # :nodoc:
608 raise ArgumentError, "#{var}=#{bool.inspect} not a boolean"
611 def set_bool(var, bool) #:nodoc:
612 set[var] = check_bool(var, bool)
615 def set_hook(var, my_proc, req_arity = 2) #:nodoc:
618 arity = my_proc.arity
619 (arity == req_arity) or \
621 "#{var}=#{my_proc.inspect} has invalid arity: " \
622 "#{arity} (need #{req_arity})"
624 my_proc = DEFAULTS[var]
626 raise ArgumentError, "invalid type: #{var}=#{my_proc.inspect}"
631 # this is called _after_ working_directory is bound. This only
632 # parses the embedded switches in .ru files
633 # (for "rackup" compatibility)
634 def parse_rackup_file # :nodoc:
635 ru = RACKUP[:file] or return # we only return here in unit tests
637 # :rails means use (old) Rails autodetect
639 File.readable?('config.ru') or return
643 File.readable?(ru) or
644 raise ArgumentError, "rackup file (#{ru}) not readable"
646 # it could be a .rb file, too, we don't parse those manually
647 ru =~ /\.ru\z/ or return
649 /^#\\(.*)/ =~ File.read(ru) or return
650 RACKUP[:optparse].parse!($1.split(/\s+/))
652 if RACKUP[:daemonize]
653 # unicorn_rails wants a default pid path, (not plain 'unicorn')
656 pid('tmp/pids/unicorn.pid') if spid.nil? || spid == :unset
658 unless RACKUP[:daemonized]
659 Unicorn::Launcher.daemonize!(RACKUP[:options])
660 RACKUP[:ready_pipe] = RACKUP[:options].delete(:ready_pipe)