Drop the micro benchmarks
[unicorn.git] / test / benchmark / README
blob1d3cdd0ec522faa940388ff860315c5c6552968e
1 = Performance
3 Unicorn is pretty fast, and we want it to get faster.  Unicorn strives
4 to get HTTP requests to your application and write HTTP responses back
5 as quickly as possible.  Unicorn does not do any background processing
6 while your app runs, so your app will get all the CPU time provided to
7 it by your OS kernel.
9 A gentle reminder: Unicorn is NOT for serving clients over slow network
10 connections.  Use nginx (or something similar) to complement Unicorn if
11 you have slow clients.
13 == dd.ru
15 This is a pure I/O benchmark.  In the context of Unicorn, this is the
16 only one that matters.  It is a standard rackup-compatible .ru file and
17 may be used with other Rack-compatible servers.
19   unicorn -E none dd.ru
21 You can change the size and number of chunks in the response with
22 the "bs" and "count" environment variables.   The following command
23 will cause dd.ru to return 4 chunks of 16384 bytes each, leading to
24 65536 byte response:
26   bs=16384 count=4 unicorn -E none dd.ru
28 Or if you want to add logging (small performance impact):
30   unicorn -E deployment dd.ru
32 Eric runs then runs clients on a LAN it in several different ways:
34   client@host1 -> unicorn@host1(tcp)
35   client@host2 -> unicorn@host1(tcp)
36   client@host3 -> nginx@host1 -> unicorn@host1(tcp)
37   client@host3 -> nginx@host1 -> unicorn@host1(unix)
38   client@host3 -> nginx@host2 -> unicorn@host1(tcp)
40 The benchmark client is usually httperf.
42 Another gentle reminder: performance with slow networks/clients
43 is NOT our problem.  That is the job of nginx (or similar).
45 == Contributors
47 This directory is maintained independently in the "benchmark" branch
48 based against v0.1.0.  Only changes to this directory (test/benchmarks)
49 are committed to this branch although the master branch may merge this
50 branch occassionaly.