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