mod_status.html revision 1b55e9e0a3c5fb40d9e46d3e6f711516a9a807fa
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke SmithXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith This file is generated from xml source: DO NOT EDIT
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke SmithXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai--><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>This module provides information on server activity and
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desaiperformance.</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><tr><td align="left" valign="top"><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td><compatibility>Available in Apache 1.1 and later</compatibility></td></tr></table></td></tr></table><h2>Summary</h2><summary>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <strong>Warning:</strong> This document has not been updated
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai to take into account changes made in the 2.0 version of the
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai Apache HTTP Server. Some of the information may still be
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai relevant, but please use it with care.
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <p>The Status module allows a server administrator to find out
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai how well their server is performing. A HTML page is presented
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith that gives the current server statistics in an easily readable
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai form. If required this page can be made to automatically
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai refresh (given a compatible browser). Another page gives a
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai simple machine-readable list of the current server state.</p>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <li>The number of children serving requests</li>
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith <li>The status of each child, the number of requests that
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai child has performed and the total number of bytes served by
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai the child (*)</li>
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith <li>A total number of accesses and byte count served (*)</li>
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith <li>The time the server was started/restarted and the time it
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith has been running for</li>
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith <li>Averages giving the number of requests per second, the
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai number of bytes served per second and the average number of
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith bytes per request (*)</li>
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith <li>The current percentage CPU used by each child and in
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai total by Apache (*)</li>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <li>The current hosts and requests being processed (*)</li>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai A compile-time option must be used to display the details
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai marked "(*)" as the instrumentation required for obtaining
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai these statistics does not exist within standard Apache.
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai</summary><h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai To enable status reports only for browsers from the foo.com
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai domain add this code to your <code>httpd.conf</code>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai configuration file
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <Location /server-status><br>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai SetHandler server-status<br>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai Order Deny,Allow<br>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai Deny from all<br>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai </Location>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <p>You can now access server statistics by using a Web browser
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai to access the page
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <code>http://your.server.name/server-status</code></p>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <blockquote><table><tr><td bgcolor="#e0e5f5"><p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <a href="core.html#servertype">inetd</a> mode.</p></td></tr></table></blockquote>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai You can get the status page to update itself automatically if
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai you have a browser that supports "refresh". Access the page
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <code>http://your.server.name/server-status?refresh=N</code> to
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai refresh the page every N seconds.
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai A machine-readable version of the status file is available by
00cf03a1ca1624dac1fecc85f43fc34f8806aff9Luke Smith accessing the page
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <code>http://your.server.name/server-status?auto</code>. This
4a5f24116202d9475862e022628fa2919d990842Satyen Desai is useful when automatically run, see the Perl program in the
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai compiled into the server, its handler capability is available
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <code>.htaccess</code>). This may have security-related
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai ramifications for your site.</strong>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai<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
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desaiextended status information for each request. This is only
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desaiuseful 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
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desailater.</td></tr></table></td></tr></table><usage>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai <p>This setting applies to the entire server, and cannot be
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai enabled or disabled on a virtualhost-by-virtualhost basis.</p>
d3c5729464159cab52ada7ff4b6c26b91bd4dcb4Satyen Desai</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>
