mod_status.html revision a236c0fe4abe4c5682c11c706c2399fbc90adbba
<html><head>
<title>Apache module mod_status</title>
</head><body>
<!--#include virtual="header.html" -->
<h1>Module mod_status</h1>
The Status Module is only available in Apache 1.1 and later.<p>
<h2>Function</h2>
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>
The details given are:
<ul>
<li>The number of children serving requests
<li>The number of idle children
<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>A total number of accesses and byte count served (*)
time it has been running for
<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>The current percentage CPU used by each child and in total by
Apache (*)
<li>The current hosts and requests being processed (*)
</ul>
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.
<h2>Enabling Status Support</h2>
To enable status reports only for browsers from the foo.com
<pre>
<Location /server-status>
SetHandler server-status
order deny,allow
deny from all
allow from .foo.com
</Location>
</pre>
<p>
You can now access server statistics by using a Web browser to access the
<h3>Automatic Updates</h3>
You can get the status page to update itself automatically if you have
a browser that supports "refresh". Access the page
every N seconds.
<h3>Machine Readable Status File</h3>
A machine-readable version of the status file is available by accessing the
when automatically run, see the Perl program in the <code>/support</code>
directory of Apache, <code>log_server_status</code>.
<h2>Full Instrumentation</h2>
To obtain full statistics you must compile Apache with a special
directive. On some machines there may be a small performance loss
if you do this. Try full statistics and see if you notice any
difference. If you do please contact <a href="mailto:mark@ukweb.com">
mark@ukweb.com</a> and tell me your configuration.
<p>
Do this by adding the following to the AUX_CFLAGS line in the
"Configuration" file and then recompiling as usual.
<pre>
AUX_CFLAGS= (something) -DSTATUS
</pre>
<BLOCKQUOTE>
<STRONG>
It should be noted that if <SAMP>mod_status</SAMP> is compiled into
the server, its handler capability is available in <EM>all</EM>
configuration files, including <EM>per</EM>-directory files
security-related ramifications for your site.
</STRONG>
</BLOCKQUOTE>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>