d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<?xml version="1.0"?>

dc3d394636ca76fbf40c460225e6dcd3be90e6acAutomatic Updater<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

499b34cea04a46823d003d4c0520c8b03e8513cbBrian Wellington<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<modulesynopsis metafile="mod_status.xml.meta">

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<name>mod_status</name>

32babe43eb479d2ae8736f9985a84d1b9d95a33aScott Mann<description>Provides information on server activity and

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Huntperformance</description>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<status>Base</status>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<sourcefile>mod_status.c</sourcefile>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<identifier>status_module</identifier>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<summary>

40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence <p>The Status module allows a server administrator to find out

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence how well their server is performing. A HTML page is presented

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence that gives the current server statistics in an easily readable

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence form. If required this page can be made to automatically

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence refresh (given a compatible browser). Another page gives a

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence simple machine-readable list of the current server state.</p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <p>The details given are:</p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <ul>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <li>The number of worker serving requests</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <li>The number of idle worker</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <li>The status of each worker, the number of requests that

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence worker has performed and the total number of bytes served by

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence the worker (*)</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <li>A total number of accesses and byte count served (*)</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <li>The time the server was started/restarted and the time it

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence has been running for</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <li>Averages giving the number of requests per second, the

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence number of bytes served per second and the average number of

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence bytes per request (*)</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <li>The current percentage CPU used by each worker and in

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence total by Apache (*)</li>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <li>The current hosts and requests being processed (*)</li>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt </ul>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <p>The lines marked "(*)" are only available if

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <directive module="mod_status">ExtendedStatus</directive>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt is <code>On</code>.</p>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt</summary>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt<section id="enable">

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <title>Enabling Status Support</title>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt <p>To enable status reports only for browsers from the foo.com

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt domain add this code to your <code>httpd.conf</code>

31707708c585c53b61ca1edb2e224e6bb1b985a5Evan Hunt configuration file</p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<example>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence &lt;Location /server-status&gt;<br />

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence SetHandler server-status<br />

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<br />

40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence Order Deny,Allow<br />

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence Deny from all<br />

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence Allow from .foo.com<br />

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence &lt;/Location&gt;

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence</example>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <p>You can now access server statistics by using a Web browser

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence to access the page

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>http://your.server.name/server-status</code></p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence</section>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<section id="autoupdate">

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <title>Automatic Updates</title>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <p>You can get the status page to update itself automatically if

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence you have a browser that supports "refresh". Access the page

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>http://your.server.name/server-status?refresh=N</code> to

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence refresh the page every N seconds.</p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence</section>

40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<section id="machinereadable">

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <title>Machine Readable Status File</title>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <p>A machine-readable version of the status file is available by

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence accessing the page

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>http://your.server.name/server-status?auto</code>. This

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence is useful when automatically run, see the Perl program in the

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>/support</code> directory of Apache,

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>log_server_status</code>.</p>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <note>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <strong>It should be noted that if <module>mod_status</module> is

40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence compiled into the server, its handler capability is available

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence in <em>all</em> configuration files, including

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <em>per</em>-directory files (<em>e.g.</em>,

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <code>.htaccess</code>). This may have security-related

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence ramifications for your site.</strong>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence </note>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence</section>

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt<directivesynopsis>

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt<name>ExtendedStatus</name>

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt<description>Keep track of extended status information for each

e5bf06eedc08179fb93a09799915139370d08055Evan Huntrequest</description>

e5bf06eedc08179fb93a09799915139370d08055Evan Hunt<syntax>ExtendedStatus On|Off</syntax>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<default>ExtendedStatus Off</default>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<contextlist><context>server config</context></contextlist>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<usage>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence <p>This setting applies to the entire server, and cannot be

9ddf371552b3554a22632996acc41ef9917a30f4Mark Andrews enabled or disabled on a virtualhost-by-virtualhost basis.

9ddf371552b3554a22632996acc41ef9917a30f4Mark Andrews The collection of extended status information can slow down

9ddf371552b3554a22632996acc41ef9917a30f4Mark Andrews the server.</p>

9ddf371552b3554a22632996acc41ef9917a30f4Mark Andrews</usage>

9ddf371552b3554a22632996acc41ef9917a30f4Mark Andrews

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence</directivesynopsis>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<directivesynopsis>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<name>SeeRequestTail</name>

d8e34837cd6c88c42b3ecdb9107a43ecf8252e79David Lawrence<description>Determine if mod_status displays the first 63 characters

of a request or the last 63, assuming the request itself is greater than

63 chars.</description>

<syntax>SeeRequestTail On|Off</syntax>

<default>SeeRequestTail Off</default>

<contextlist><context>server config</context></contextlist>

<compatibility>SeeRequestTail is only available in Apache 2.2.7 and

later.</compatibility>

<usage>

<p>mod_status with ExtendedStatus On displays the actual request being

handled. For historical purposes, only 63 characters of the request

are actually stored for display purposes. This directive

controls whether the 1st 63 characters are stored (the previous

behavior and the default) or if the last 63 characters are. This

is only applicable, of course, if the length of the request is

64 characters or greater.</p>

</usage>

</directivesynopsis>

</modulesynopsis>