1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>ab - Apache HTTP server benchmarking tool - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
13 <body id="manual-page"><div id="page-header">
14 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
15 <p class="apache">Apache HTTP Server Version 2.0</p>
16 <img alt="" src="../images/feather.gif" /></div>
17 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
19 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>ab - Apache HTTP server benchmarking tool</h1>
21 <p><span>Available Languages: </span><a href="../en/programs/ab.html" title="English"> en </a> |
22 <a href="../ko/programs/ab.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
23 <a href="../tr/programs/ab.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
26 <p><code>ab</code> is a tool for benchmarking your Apache Hypertext
27 Transfer Protocol (HTTP) server. It is designed to give you an impression
28 of how your current Apache installation performs. This especially shows
29 you how many requests per second your Apache installation is capable of
32 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
33 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
34 <li><img alt="" src="../images/down.gif" /> <a href="#bugs">Bugs</a></li>
35 </ul><h3>See also</h3><ul class="seealso"><li><code class="program"><a href="../programs/httpd.html">httpd</a></code></li></ul></div>
36 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
38 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
39 <p><code><strong>ab</strong>
40 [ -<strong>A</strong> <var>auth-username</var>:<var>password</var> ]
41 [ -<strong>c</strong> <var>concurrency</var> ]
42 [ -<strong>C</strong> <var>cookie-name</var>=<var>value</var> ]
43 [ -<strong>d</strong> ]
44 [ -<strong>e</strong> <var>csv-file</var> ]
45 [ -<strong>g</strong> <var>gnuplot-file</var> ]
46 [ -<strong>h</strong> ]
47 [ -<strong>H</strong> <var>custom-header</var> ]
48 [ -<strong>i</strong> ]
49 [ -<strong>k</strong> ]
50 [ -<strong>n</strong> <var>requests</var> ]
51 [ -<strong>p</strong> <var>POST-file</var> ]
52 [ -<strong>P</strong> <var>proxy-auth-username</var>:<var>password</var> ]
53 [ -<strong>q</strong> ]
54 [ -<strong>s</strong> ]
55 [ -<strong>S</strong> ]
56 [ -<strong>t</strong> <var>timelimit</var> ]
57 [ -<strong>T</strong> <var>content-type</var> ]
58 [ -<strong>v</strong> <var>verbosity</var>]
59 [ -<strong>V</strong> ]
60 [ -<strong>w</strong> ]
61 [ -<strong>x</strong> <var><table>-attributes</var> ]
62 [ -<strong>X</strong> <var>proxy</var>[:<var>port</var>] ]
63 [ -<strong>y</strong> <var><tr>-attributes</var> ]
64 [ -<strong>z</strong> <var><td>-attributes</var> ]
65 [http://]<var>hostname</var>[:<var>port</var>]/<var>path</var></code></p>
66 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
68 <h2><a name="options" id="options">Options</a></h2>
70 <dt><code>-A <var>auth-username</var>:<var>password</var></code></dt>
71 <dd>Supply BASIC Authentication credentials to the server. The username and
72 password are separated by a single <code>:</code> and sent on the wire
73 base64 encoded. The string is sent regardless of whether the server needs
74 it (<em>i.e.</em>, has sent an 401 authentication needed).</dd>
76 <dt><code>-c <var>concurrency</var></code></dt>
77 <dd>Number of multiple requests to perform at a time. Default is one
78 request at a time.</dd>
80 <dt><code>-C <var>cookie-name</var>=<var>value</var></code></dt>
81 <dd>Add a <code>Cookie:</code> line to the request. The argument is
82 typically in the form of a <code><var>name</var>=<var>value</var></code>
83 pair. This field is repeatable.</dd>
85 <dt><code>-d</code></dt>
86 <dd>Do not display the "percentage served within XX [ms] table". (legacy
89 <dt><code>-e <var>csv-file</var></code></dt>
90 <dd>Write a Comma separated value (CSV) file which contains for each
91 percentage (from 1% to 100%) the time (in milliseconds) it took to serve
92 that percentage of the requests. This is usually more useful than the
93 'gnuplot' file; as the results are already 'binned'.</dd>
95 <dt><code>-g <var>gnuplot-file</var></code></dt>
96 <dd>Write all measured values out as a 'gnuplot' or TSV (Tab separate
97 values) file. This file can easily be imported into packages like Gnuplot,
98 IDL, Mathematica, Igor or even Excel. The labels are on the first line of
101 <dt><code>-h</code></dt>
102 <dd>Display usage information.</dd>
104 <dt><code>-H <var>custom-header</var></code></dt>
105 <dd>Append extra headers to the request. The argument is typically in
106 the form of a valid header line, containing a colon-separated field-value
107 pair (<em>i.e.</em>, <code>"Accept-Encoding: zip/zop;8bit"</code>).</dd>
109 <dt><code>-i</code></dt>
110 <dd>Do <code>HEAD</code> requests instead of <code>GET</code>.</dd>
112 <dt><code>-k</code></dt>
113 <dd>Enable the HTTP KeepAlive feature, <em>i.e.</em>, perform multiple
114 requests within one HTTP session. Default is no KeepAlive.</dd>
116 <dt><code>-n <var>requests</var></code></dt>
117 <dd>Number of requests to perform for the benchmarking session. The default
118 is to just perform a single request which usually leads to
119 non-representative benchmarking results.</dd>
121 <dt><code>-p <var>POST-file</var></code></dt>
122 <dd>File containing data to POST.</dd>
124 <dt><code>-P <var>proxy-auth-username</var>:<var>password</var></code></dt>
125 <dd>Supply BASIC Authentication credentials to a proxy en-route. The
126 username and password are separated by a single <code>:</code> and sent on
127 the wire base64 encoded. The string is sent regardless of whether the
128 proxy needs it (<em>i.e.</em>, has sent an 407 proxy authentication
131 <dt><code>-q</code></dt>
132 <dd>When processing more than 150 requests, <code>ab</code> outputs a
133 progress count on <code>stderr</code> every 10% or 100 requests or so. The
134 <code>-q</code> flag will suppress these messages.</dd>
136 <dt><code>-s</code></dt>
137 <dd>When compiled in (<code>ab -h</code> will show you) use the SSL
138 protected <code>https</code> rather than the <code>http</code> protocol.
139 This feature is experimental and <em>very</em> rudimentary. You probably
140 do not want to use it.</dd>
142 <dt><code>-S</code></dt>
143 <dd>Do not display the median and standard deviation values, nor display
144 the warning/error messages when the average and median are more than
145 one or two times the standard deviation apart. And default to the
146 min/avg/max values. (legacy support).</dd>
148 <dt><code>-t <var>timelimit</var></code></dt>
149 <dd>Maximum number of seconds to spend for benchmarking. This implies a
150 <code>-n 50000</code> internally. Use this to benchmark the server within a
151 fixed total amount of time. Per default there is no timelimit.</dd>
153 <dt><code>-T <var>content-type</var></code></dt>
154 <dd>Content-type header to use for POST data.</dd>
156 <dt><code>-v <var>verbosity</var></code></dt>
157 <dd>Set verbosity level - <code>4</code> and above prints information on
158 headers, <code>3</code> and above prints response codes (404, 200, etc.),
159 <code>2</code> and above prints warnings and info.</dd>
161 <dt><code>-V</code></dt>
162 <dd>Display version number and exit.</dd>
164 <dt><code>-w</code></dt>
165 <dd>Print out results in HTML tables. Default table is two columns wide,
166 with a white background.</dd>
168 <dt><code>-x <var><table>-attributes</var></code></dt>
169 <dd>String to use as attributes for <code><table></code>. Attributes
170 are inserted <code><table <var>here</var> ></code>.</dd>
172 <dt><code>-X <var>proxy</var>[:<var>port</var>]</code></dt>
173 <dd>Use a proxy server for the requests.</dd>
175 <dt><code>-y <var><tr>-attributes</var></code></dt>
176 <dd>String to use as attributes for <code><tr></code>.</dd>
178 <dt><code>-z <var><td>-attributes</var></code></dt>
179 <dd>String to use as attributes for <code><td></code>.</dd>
181 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
182 <div class="section">
183 <h2><a name="bugs" id="bugs">Bugs</a></h2>
184 <p>There are various statically declared buffers of fixed length. Combined
185 with the lazy parsing of the command line arguments, the response headers
186 from the server and other external inputs, this might bite you.</p>
188 <p>It does not implement HTTP/1.x fully; only accepts some 'expected' forms
189 of responses. The rather heavy use of <code>strstr(3)</code> shows up top
190 in profile, which might indicate a performance problem; <em>i.e.</em>, you
191 would measure the <code>ab</code> performance rather than the server's.</p>
193 <div class="bottomlang">
194 <p><span>Available Languages: </span><a href="../en/programs/ab.html" title="English"> en </a> |
195 <a href="../ko/programs/ab.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
196 <a href="../tr/programs/ab.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
197 </div><div id="footer">
198 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
199 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>