mod_status.html revision 5b405f3013ab021f86c42d632b87b0bc4aa2605f
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<HTML>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte <HEAD>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte <TITLE>Apache module mod_status</TITLE>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte </HEAD>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<BODY
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte BGCOLOR="#FFFFFF"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte TEXT="#000000"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte LINK="#0000FF"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte VLINK="#000080"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte ALINK="#FF0000"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!--#include virtual="header.html" -->
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<H1 ALIGN="CENTER">Module mod_status</H1>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn ForteThe Status Module is only available in Apache 1.1 and later.<P>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<H2>Function</H2>
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, Ramana
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn ForteThe Status module allows a server administrator to find out how well
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortetheir server is performing. A HTML page is presented that gives
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortethe current server statistics in an easily readable form. If required
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortethis page can be made to automatically refresh (given a compatible
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortebrowser). Another page gives a simple machine-readable list of the current
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteserver state.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<P>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn ForteThe details given are:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<UL>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The number of children serving requests
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The number of idle children
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The status of each child, the number of requests that child has
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteperformed and the total number of bytes served by the child (*)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>A total number of accesses and byte count served (*)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The time the server was started/restarted and the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortetime it has been running for
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>Averages giving the number of requests per second,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortethe number of bytes served per second and the average number
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteof bytes per request (*)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The current percentage CPU used by each child and in total by
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, RamanaApache (*)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<LI>The current hosts and requests being processed (*)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte</UL>
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, Ramana
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, RamanaA compile-time option must be used to display the details marked "(*)" as
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortethe instrumentation required for obtaining these statistics does not
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteexist within standard Apache.
a1e9eea083a8f257157edb8a1efb5bbd300eb4bfSrikanth, Ramana
fb6c52f1611001ba6d360f4bd2423829532c6030Srikanth, Ramana<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<!--%plaintext &lt;?INDEX {\tt ExtendedStatus} directive&gt; -->
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<A
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte HREF="directive-dict.html#Syntax"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte REL="Help"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte><STRONG>Syntax:</STRONG></A> ExtendedStatus <EM>On|Off</EM><BR>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<A
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte HREF="directive-dict.html#Default"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte REL="Help"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte<A
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte HREF="directive-dict.html#Context"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte REL="Help"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte><STRONG>Context:</STRONG></A> server config <BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_status<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
in Apache 1.3.2 and later.
<P>
This directive controls whether the server keeps track of extended
status information for each request. This is only useful if the status module
is enabled on the server.
</P>
<P>
This setting applies to the entire server, and cannot be enabled or
disabled on a virtualhost-by-virtualhost basis.
</P>
<H2>Enabling Status Support</H2>
To enable status reports only for browsers from the foo.com
domain add this code to your <CODE>access.conf</CODE> configuration file
<PRE>
&lt;Location /server-status&gt;
SetHandler server-status
order deny,allow
deny from all
allow from .foo.com
&lt;/Location&gt;
</PRE>
<P>
You can now access server statistics by using a Web browser to access the
page <CODE>http://your.server.name/server-status</CODE>
<P>
Note that mod_status will only work when you are running Apache in
<A HREF="core.html#servertype">standalone</A> mode and not
<A HREF="core.html#servertype">inetd</A> mode.
<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
<CODE>http://your.server.name/server-status?refresh=N</CODE> to refresh the
page every N seconds.
<H3>Machine Readable Status File</H3>
A machine-readable version of the status file is available by accessing the
page <CODE>http://your.server.name/server-status?auto</CODE>. This is useful
when automatically run, see the Perl program in the <CODE>/support</CODE>
directory of Apache, <CODE>log_server_status</CODE>.
<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
(<EM>e.g.</EM>, <SAMP>.htaccess</SAMP>). This may have
security-related ramifications for your site.
</STRONG>
</BLOCKQUOTE>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>