mod_status.html revision 4dd8c368372e679c9e9a2efb98c2ce2818646e4a
742N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
742N/A<HTML>
742N/A <HEAD>
742N/A <TITLE>Apache module mod_status</TITLE>
742N/A </HEAD>
742N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
742N/A<BODY
742N/A BGCOLOR="#FFFFFF"
742N/A TEXT="#000000"
742N/A LINK="#0000FF"
742N/A VLINK="#000080"
742N/A ALINK="#FF0000"
742N/A>
742N/A
742N/A<!--#include virtual="header.html" -->
742N/A<H1 ALIGN="CENTER">Module mod_status</H1>
742N/A
742N/AThe Status Module is only available in Apache 1.1 and later.<P>
742N/A
742N/A<H2>Function</H2>
742N/A
2852N/AThe Status module allows a server administrator to find out how well
742N/Atheir server is performing. A HTML page is presented that gives
742N/Athe current server statistics in an easily readable form. If required
2946N/Athis page can be made to automatically refresh (given a compatible
1116N/Abrowser). Another page gives a simple machine-readable list of the current
1116N/Aserver state.
1116N/A<P>
1116N/AThe details given are:
1116N/A<UL>
2662N/A<LI>The number of children serving requests
742N/A<LI>The number of idle children
1116N/A<LI>The status of each child, the number of requests that child has
742N/Aperformed and the total number of bytes served by the child (*)
742N/A<LI>A total number of accesses and byte count served (*)
742N/A<LI>The time the server was started/restarted and the
742N/Atime it has been running for
742N/A<LI>Averages giving the number of requests per second,
742N/Athe number of bytes served per second and the average number
2852N/Aof bytes per request (*)
742N/A<LI>The current percentage CPU used by each child and in total by
742N/AApache (*)
742N/A<LI>The current hosts and requests being processed (*)
742N/A</UL>
1116N/A
1116N/AA compile-time option must be used to display the details marked "(*)" as
1116N/Athe instrumentation required for obtaining these statistics does not
1116N/Aexist within standard Apache.
1116N/A
1116N/A<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
1116N/A<!--%plaintext &lt;?INDEX {\tt ExtendedStatus} directive&gt; -->
1116N/A<A
1116N/A HREF="directive-dict.html#Syntax"
1116N/A REL="Help"
1116N/A><STRONG>Syntax:</STRONG></A> ExtendedStatus <EM>On|Off</EM><BR>
1116N/A<A
1116N/A HREF="directive-dict.html#Default"
1116N/A REL="Help"
1116N/A><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
1116N/A<A
1116N/A HREF="directive-dict.html#Context"
1116N/A REL="Help"
1116N/A><STRONG>Context:</STRONG></A> server config <BR>
1116N/A<A
1116N/A HREF="directive-dict.html#Status"
1116N/A REL="Help"
1116N/A><STRONG>Status:</STRONG></A> Base<BR>
1116N/A <A
1431N/A HREF="directive-dict.html#Module"
1431N/A REL="Help"
1431N/A ><STRONG>Module:</STRONG></A> mod_status<BR>
1431N/A<A
1431N/A HREF="directive-dict.html#Compatibility"
1431N/A REL="Help"
1431N/A><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
1116N/A in Apache 1.3 and later
1116N/A
1116N/A<P>
1116N/AThis directive controls whether the server keeps track of extended
1116N/Astatus information for each request. This is only useful if the status module
1116N/Ais enabled on the server.
1116N/A</P>
1116N/A<P>
1116N/AThis setting applies to the entire server, and cannot be enabled or
1116N/Adisabled on a virtualhost-by-virtualhost basis.
1116N/A</P>
1116N/A
1116N/A<H2>Enabling Status Support</H2>
1116N/A
1116N/ATo enable status reports only for browsers from the foo.com
1116N/Adomain add this code to your <CODE>access.conf</CODE> configuration file
1116N/A<PRE>
1116N/A &lt;Location /server-status&gt;
1116N/A SetHandler server-status
1116N/A
1116N/A order deny,allow
1116N/A deny from all
1116N/A allow from .foo.com
1116N/A &lt;/Location&gt;
1116N/A</PRE>
1116N/A<P>
1116N/AYou can now access server statistics by using a Web browser to access the
1116N/Apage <CODE>http://your.server.name/server-status</CODE>
1116N/A<P>
1116N/ANote that mod_status will only work when you are running Apache in
1116N/A<A HREF="core.html#servertype">standalone</A> mode and not
1116N/A<A HREF="core.html#servertype">inetd</A> mode.
1116N/A
1116N/A<H3>Automatic Updates</H3>
1116N/AYou can get the status page to update itself automatically if you have
1116N/Aa browser that supports "refresh". Access the page
1116N/A<CODE>http://your.server.name/server-status?refresh=N</CODE> to refresh the
1116N/Apage every N seconds.
1116N/A<H3>Machine Readable Status File</H3>
1116N/AA machine-readable version of the status file is available by accessing the
2946N/Apage <CODE>http://your.server.name/server-status?auto</CODE>. This is useful
2028N/Awhen automatically run, see the Perl program in the <CODE>/support</CODE>
2028N/Adirectory of Apache, <CODE>log_server_status</CODE>.
2028N/A
1116N/A<BLOCKQUOTE>
1116N/A <STRONG>
2028N/A It should be noted that if <SAMP>mod_status</SAMP> is compiled into
1116N/A the server, its handler capability is available in <EM>all</EM>
1116N/A configuration files, including <EM>per</EM>-directory files
1116N/A (<EM>e.g.</EM>, <SAMP>.htaccess</SAMP>). This may have
1116N/A security-related ramifications for your site.
1116N/A </STRONG>
1116N/A</BLOCKQUOTE>
1116N/A<!--#include virtual="footer.html" -->
1116N/A</BODY>
1116N/A</HTML>
1116N/A