3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<?xml version="1.0"?>

0d26a2bd71224b954baab529bbadc4d676c35b95slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<?xml-stylesheet type="text/xsl" href="/style/manual.xsl"?>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<modulesynopsis>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<name>mod_status</name>

0d26a2bd71224b954baab529bbadc4d676c35b95slive<description>Provides information on server activity and

0d26a2bd71224b954baab529bbadc4d676c35b95sliveperformance</description>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<status>Base</status>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<sourcefile>mod_status.c</sourcefile>

0d26a2bd71224b954baab529bbadc4d676c35b95slive<identifier>status_module</identifier>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<summary>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<note>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <strong>Warning:</strong> This document has not been updated

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen to take into account changes made in the 2.0 version of the

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Apache HTTP Server. Some of the information may still be

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen relevant, but please use it with care.

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</note>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>The Status module allows a server administrator to find out

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen how well their server is performing. A HTML page is presented

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen that gives the current server statistics in an easily readable

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen form. If required this page can be made to automatically

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen refresh (given a compatible browser). Another page gives a

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen simple machine-readable list of the current server state.</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>The details given are:</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <ul>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The number of children serving requests</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The number of idle children</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The status of each child, the number of requests that

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen child has performed and the total number of bytes served by

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen the child (*)</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

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

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The time the server was started/restarted and the time it

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen has been running for</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>Averages giving the number of requests per second, the

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen number of bytes served per second and the average number of

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen bytes per request (*)</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The current percentage CPU used by each child and in

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen total by Apache (*)</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The current hosts and requests being processed (*)</li>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen </ul>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>A compile-time option must be used to display the details

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen marked "(*)" as the instrumentation required for obtaining

0d26a2bd71224b954baab529bbadc4d676c35b95slive these statistics does not exist within standard Apache.</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</summary>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <title>Enabling Status Support</title>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>To enable status reports only for browsers from the foo.com

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen domain add this code to your <code>httpd.conf</code>

0d26a2bd71224b954baab529bbadc4d676c35b95slive configuration file</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<example>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen &lt;Location /server-status&gt;<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen SetHandler server-status<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Order Deny,Allow<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Deny from all<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Allow from .foo.com<br />

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen &lt;/Location&gt;

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</example>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>You can now access server statistics by using a Web browser

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen to access the page

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>http://your.server.name/server-status</code></p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <note><p>Note that <module>mod_status</module> will only work

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen when you are running Apache in <a

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen href="core.html#servertype">standalone</a> mode and not

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <a href="core.html#servertype">inetd</a> mode.</p></note>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <title>Automatic Updates</title>

0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>You can get the status page to update itself automatically if

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen you have a browser that supports "refresh". Access the page

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

0d26a2bd71224b954baab529bbadc4d676c35b95slive refresh the page every N seconds.</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <title>Machine Readable Status File</title>

0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>A machine-readable version of the status file is available by

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen accessing the page

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>http://your.server.name/server-status?auto</code>. This

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen is useful when automatically run, see the Perl program in the

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>/support</code> directory of Apache,

0d26a2bd71224b954baab529bbadc4d676c35b95slive <code>log_server_status</code>.</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <note>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <strong>It should be noted that if <module>mod_status</module> is

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen compiled into the server, its handler capability is available

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen in <em>all</em> configuration files, including

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <em>per</em>-directory files (<em>e.g.</em>,

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>.htaccess</code>). This may have security-related

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen ramifications for your site.</strong>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen </note>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</section>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<directivesynopsis>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<name>ExtendedStatus</name>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<description>This directive controls whether the server keeps track of

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowenextended status information for each request. This is only

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowenuseful if the status module is enabled on the server.</description>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<syntax>ExtendedStatus On|Off</syntax>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<default>ExtendedStatus Off</default>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<contextlist><context>server config</context></contextlist>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<compatibility>ExtendedStatus is only available in Apache 1.3.2 and

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowenlater.</compatibility>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<usage>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>This setting applies to the entire server, and cannot be

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen enabled or disabled on a virtualhost-by-virtualhost basis.</p>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</usage>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</directivesynopsis>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</modulesynopsis>

3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen