mod_status.html revision 240a5b8962329911d02566b600be6226e1f857ae
5690d2f46bf6dedb53d41f888e290df0526f32b1kess<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
5690d2f46bf6dedb53d41f888e290df0526f32b1kessXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5690d2f46bf6dedb53d41f888e290df0526f32b1kess This file is generated from xml source: DO NOT EDIT
5690d2f46bf6dedb53d41f888e290df0526f32b1kessXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5690d2f46bf6dedb53d41f888e290df0526f32b1kess--><title>mod_status - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides information on server activity and
5690d2f46bf6dedb53d41f888e290df0526f32b1kessperformance</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module Identifier:</a></td><td>status_module</td></tr></table></td></tr></table><h2>Summary</h2>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <strong>Warning:</strong> This document has not been updated
5690d2f46bf6dedb53d41f888e290df0526f32b1kess to take into account changes made in the 2.0 version of the
5690d2f46bf6dedb53d41f888e290df0526f32b1kess Apache HTTP Server. Some of the information may still be
5690d2f46bf6dedb53d41f888e290df0526f32b1kess relevant, but please use it with care.
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>The Status module allows a server administrator to find out
5690d2f46bf6dedb53d41f888e290df0526f32b1kess how well their server is performing. A HTML page is presented
5690d2f46bf6dedb53d41f888e290df0526f32b1kess that gives the current server statistics in an easily readable
5690d2f46bf6dedb53d41f888e290df0526f32b1kess form. If required this page can be made to automatically
5690d2f46bf6dedb53d41f888e290df0526f32b1kess refresh (given a compatible browser). Another page gives a
5690d2f46bf6dedb53d41f888e290df0526f32b1kess simple machine-readable list of the current server state.</p>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>The status of each child, the number of requests that
5690d2f46bf6dedb53d41f888e290df0526f32b1kess child has performed and the total number of bytes served by
5690d2f46bf6dedb53d41f888e290df0526f32b1kess the child (*)</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>A total number of accesses and byte count served (*)</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>The time the server was started/restarted and the time it
5690d2f46bf6dedb53d41f888e290df0526f32b1kess has been running for</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>Averages giving the number of requests per second, the
5690d2f46bf6dedb53d41f888e290df0526f32b1kess number of bytes served per second and the average number of
5690d2f46bf6dedb53d41f888e290df0526f32b1kess bytes per request (*)</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>The current percentage CPU used by each child and in
5690d2f46bf6dedb53d41f888e290df0526f32b1kess total by Apache (*)</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <li>The current hosts and requests being processed (*)</li>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>A compile-time option must be used to display the details
5690d2f46bf6dedb53d41f888e290df0526f32b1kess marked "(*)" as the instrumentation required for obtaining
5690d2f46bf6dedb53d41f888e290df0526f32b1kess these statistics does not exist within standard Apache.</p>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess<h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>To enable status reports only for browsers from the foo.com
5690d2f46bf6dedb53d41f888e290df0526f32b1kess configuration file</p>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <Location /server-status><br/>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess SetHandler server-status<br/>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess Order Deny,Allow<br/>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess Deny from all<br/>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess </Location>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>You can now access server statistics by using a Web browser
5690d2f46bf6dedb53d41f888e290df0526f32b1kess to access the page
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <blockquote><table><tr><td bgcolor="#e0e5f5"><p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
5690d2f46bf6dedb53d41f888e290df0526f32b1kess when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <a href="core.html#servertype">inetd</a> mode.</p></td></tr></table></blockquote>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>You can get the status page to update itself automatically if
5690d2f46bf6dedb53d41f888e290df0526f32b1kess you have a browser that supports "refresh". Access the page
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <code>http://your.server.name/server-status?refresh=N</code> to
5690d2f46bf6dedb53d41f888e290df0526f32b1kess refresh the page every N seconds.</p>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>A machine-readable version of the status file is available by
5690d2f46bf6dedb53d41f888e290df0526f32b1kess accessing the page
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <code>http://your.server.name/server-status?auto</code>. This
5690d2f46bf6dedb53d41f888e290df0526f32b1kess is useful when automatically run, see the Perl program in the
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
5690d2f46bf6dedb53d41f888e290df0526f32b1kess compiled into the server, its handler capability is available
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <code>.htaccess</code>). This may have security-related
5690d2f46bf6dedb53d41f888e290df0526f32b1kess ramifications for your site.</strong>
5690d2f46bf6dedb53d41f888e290df0526f32b1kess<hr/><h2><a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
5690d2f46bf6dedb53d41f888e290df0526f32b1kessextended status information for each request. This is only
5690d2f46bf6dedb53d41f888e290df0526f32b1kessuseful if the status module is enabled on the server.</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ExtendedStatus On|Off</td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>ExtendedStatus Off</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_status</td></tr><tr><td valign="top" align="left"><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
5690d2f46bf6dedb53d41f888e290df0526f32b1kess <p>This setting applies to the entire server, and cannot be
5690d2f46bf6dedb53d41f888e290df0526f32b1kess enabled or disabled on a virtualhost-by-virtualhost basis.</p>
