mod_status.html revision ec3a8771bd47a71bb4863e152b9fb26554832313
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
f65e61c04bc28ffd6bda04619c84330b420450b5ahrens<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
fa9e4066f08beec538e775443c5be79dd423fcabahrens BGCOLOR="#FFFFFF"
fa9e4066f08beec538e775443c5be79dd423fcabahrens TEXT="#000000"
fa9e4066f08beec538e775443c5be79dd423fcabahrens LINK="#0000FF"
fa9e4066f08beec538e775443c5be79dd423fcabahrens VLINK="#000080"
fa9e4066f08beec538e775443c5be79dd423fcabahrens ALINK="#FF0000"
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!--#include virtual="header.html" -->
fa9e4066f08beec538e775443c5be79dd423fcabahrensThe Status Module is only available in Apache 1.1 and later.<P>
47cb52daa729f19e298c85a84e8df069365c5232Jeff BonwickThe Status module allows a server administrator to find out how well
ae9727953cac4bd427aafd9f27458e401590bcb5Matthew Ahrenstheir server is performing. A HTML page is presented that gives
bc9014e6a81272073b9854d9f65dd59e18d18c35Justin Gibbsthe current server statistics in an easily readable form. If required
fa9e4066f08beec538e775443c5be79dd423fcabahrensthis page can be made to automatically refresh (given a compatible
fa9e4066f08beec538e775443c5be79dd423fcabahrensbrowser). Another page gives a simple machine-readable list of the current
fa9e4066f08beec538e775443c5be79dd423fcabahrensserver state.
fa9e4066f08beec538e775443c5be79dd423fcabahrensThe details given are:
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>The number of children serving requests
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>The number of idle children
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>The status of each child, the number of requests that child has
fa9e4066f08beec538e775443c5be79dd423fcabahrensperformed and the total number of bytes served by the child (*)
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>A total number of accesses and byte count served (*)
fa9e4066f08beec538e775443c5be79dd423fcabahrenstime it has been running for
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>Averages giving the number of requests per second,
fa9e4066f08beec538e775443c5be79dd423fcabahrensthe number of bytes served per second and the average number
fa9e4066f08beec538e775443c5be79dd423fcabahrensof bytes per request (*)
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>The current percentage CPU used by each child and in total by
fa9e4066f08beec538e775443c5be79dd423fcabahrens<LI>The current hosts and requests being processed (*)
478ed9ada0b6efe1318150a700986aa47e6a926dEric TaylorA compile-time option must be used to display the details marked "(*)" as
fa9e4066f08beec538e775443c5be79dd423fcabahrensthe instrumentation required for obtaining these statistics does not
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockexist within standard Apache.
fa9e4066f08beec538e775443c5be79dd423fcabahrens<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!--%plaintext <?INDEX {\tt ExtendedStatus} directive> -->
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. Gibbs><STRONG>Syntax:</STRONG></A> ExtendedStatus <EM>On|Off</EM><BR>
fa9e4066f08beec538e775443c5be79dd423fcabahrens><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
fa9e4066f08beec538e775443c5be79dd423fcabahrens HREF="directive-dict.html#Compatibility"
fa9e4066f08beec538e775443c5be79dd423fcabahrens><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
fa9e4066f08beec538e775443c5be79dd423fcabahrens in Apache 1.3.2 and later
fa9e4066f08beec538e775443c5be79dd423fcabahrensThis directive controls whether the server keeps track of extended
fa9e4066f08beec538e775443c5be79dd423fcabahrensstatus information for each request. This is only useful if the status module
fa9e4066f08beec538e775443c5be79dd423fcabahrensis enabled on the server.
40510e8eba18690b9a9843b26393725eeb0f1dacJosef 'Jeff' SipekThis setting applies to the entire server, and cannot be enabled or
40510e8eba18690b9a9843b26393725eeb0f1dacJosef 'Jeff' Sipekdisabled on a virtualhost-by-virtualhost basis.
c1379625401dfbe1c39b79136dd384a571d47fdeJustin T. GibbsTo enable status reports only for browsers from the foo.com
fa9e4066f08beec538e775443c5be79dd423fcabahrensdomain add this code to your <CODE>access.conf</CODE> configuration file
fa9e4066f08beec538e775443c5be79dd423fcabahrens <Location /server-status>
fa9e4066f08beec538e775443c5be79dd423fcabahrens SetHandler server-status
fa9e4066f08beec538e775443c5be79dd423fcabahrens order deny,allow
fa9e4066f08beec538e775443c5be79dd423fcabahrens deny from all
f65e61c04bc28ffd6bda04619c84330b420450b5ahrens </Location>
fa9e4066f08beec538e775443c5be79dd423fcabahrensYou can now access server statistics by using a Web browser to access the
fa9e4066f08beec538e775443c5be79dd423fcabahrenspage <CODE>http://your.server.name/server-status</CODE>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwNote that mod_status will only work when you are running Apache in
b24ab6762772a3f6a89393947930c7fa61306783Jeff Bonwick<A HREF="core.html#servertype">standalone</A> mode and not
f65e61c04bc28ffd6bda04619c84330b420450b5ahrensYou can get the status page to update itself automatically if you have
fa9e4066f08beec538e775443c5be79dd423fcabahrensa browser that supports "refresh". Access the page
fa9e4066f08beec538e775443c5be79dd423fcabahrens<CODE>http://your.server.name/server-status?refresh=N</CODE> to refresh the
fa9e4066f08beec538e775443c5be79dd423fcabahrenspage every N seconds.
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockA machine-readable version of the status file is available by accessing the
47cb52daa729f19e298c85a84e8df069365c5232Jeff Bonwickpage <CODE>http://your.server.name/server-status?auto</CODE>. This is useful
fa9e4066f08beec538e775443c5be79dd423fcabahrenswhen automatically run, see the Perl program in the <CODE>/support</CODE>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<BLOCKQUOTE>
de8267e0f723ed2c38ea9def92d465f69a300f56timh It should be noted that if <SAMP>mod_status</SAMP> is compiled into
fa9e4066f08beec538e775443c5be79dd423fcabahrens the server, its handler capability is available in <EM>all</EM>
fa9e4066f08beec538e775443c5be79dd423fcabahrens configuration files, including <EM>per</EM>-directory files
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock (<EM>e.g.</EM>, <SAMP>.htaccess</SAMP>). This may have
fa9e4066f08beec538e775443c5be79dd423fcabahrens security-related ramifications for your site.
fa9e4066f08beec538e775443c5be79dd423fcabahrens</BLOCKQUOTE>
fa9e4066f08beec538e775443c5be79dd423fcabahrens<!--#include virtual="footer.html" -->