summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-05-02 23:40:07 -0700
committerEric Wong <normalperson@yhbt.net>2009-05-22 01:54:20 -0700
commit4b50c7d814f770347b96b8b1fa52ff41656670ec (patch)
tree6bcdd34042672a1686c5eb3cdc3e86223e05ef35
parentdf330c00577fed3c16be92129891f08f56441aef (diff)
Most of this should be applicable to Mongrel and other
web servers, too.
-rw-r--r--.document1
-rw-r--r--Manifest2
-rw-r--r--TUNING59
3 files changed, 62 insertions, 0 deletions
diff --git a/.document b/.document
index 432d4bb..e8ef088 100644
--- a/.document
+++ b/.document
@@ -1,4 +1,5 @@
 README
+TUNING
 PHILOSOPHY
 DESIGN
 CONTRIBUTORS
diff --git a/Manifest b/Manifest
index 4a9f9cf..cfc2ddb 100644
--- a/Manifest
+++ b/Manifest
@@ -11,8 +11,10 @@ README
 Rakefile
 SIGNALS
 TODO
+TUNING
 bin/unicorn
 bin/unicorn_rails
+examples/init.sh
 ext/unicorn/http11/ext_help.h
 ext/unicorn/http11/extconf.rb
 ext/unicorn/http11/http11.c
diff --git a/TUNING b/TUNING
new file mode 100644
index 0000000..c0f633b
--- /dev/null
+++ b/TUNING
@@ -0,0 +1,59 @@
+= Tuning Unicorn
+
+Unicorn performance is generally as good as a (mostly) Ruby web server
+can provide.  Most often the performance bottleneck is in the web
+application running on Unicorn rather than Unicorn itself.
+
+== Unicorn Configuration
+
+See Unicorn::Configurator for details on the config file format.
+
+* Setting a very low value for the :backlog parameter in "listen"
+  directives can allow failover to happen more quickly if your
+  cluster is configured for it.
+
+* :rcvbuf and :sndbuf parameters generally do not need to be set for TCP
+  listeners under Linux 2.6 because auto-tuning is enabled.  UNIX domain
+  sockets do not have auto-tuning buffer sizes; so increasing those will
+  allow syscalls and task switches to be saved for larger requests
+  and responses.
+
+* Setting "preload_app true" can allow copy-on-write-friendly GC to
+  be used to save memory.  It will probably not work out of the box with
+  applications that open sockets or perform random I/O on files.
+  Databases like TokyoCabinet use concurrency-safe pread()/pwrite()
+  functions for safe sharing of database file descriptors across
+  processes.
+
+* On POSIX-compliant filesystems, it is safe for multiple threads or
+  processes to append to one log file as long as all the processes are
+  have them unbuffered (File#sync = true) or they are
+  record(line)-buffered in userspace.
+
+* worker_processes should be scaled to the number of processes your
+  backend system(s) can support.  DO NOT scale it to the number of
+  external network clients your application expects to be serving.
+  Unicorn is NOT for serving slow clients, that is the job of nginx.
+
+== Kernel Parameters (Linux sysctl)
+
+WARNING: Do not change system parameters unless you know what you're doing!
+
+* net.core.rmem_max and net.core.wmem_max can increase the allowed
+  size of :rcvbuf and :sndbuf respectively. This is mostly only useful
+  for UNIX domain sockets which do not have auto-tuning buffer sizes.
+
+* If you're running out of local ports, consider lowering
+  net.ipv4.tcp_fin_timeout to 20-30 (default: 60 seconds).  Also
+  consider widening the usable port range by changing
+  net.ipv4.ip_local_port_range.
+
+* Setting net.ipv4.tcp_timestamps=1 will also allow setting
+  net.ipv4.tcp_tw_reuse=1 and net.ipv4.tcp_tw_recycle=1, which along
+  with the above settings can slow down port exhaustion.  Not all
+  networks are compatible with these settings, check with your friendly
+  network administrator before changing these.
+
+* Increasing the MTU size can reduce framing overhead for larger
+  transfers.  One often-overlooked detail is that the loopback
+  device (usually "lo") can have its MTU increased, too.