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