mod_status.html revision 2eaf662cbc81e823e8d9aeb8d54e69e63032493e
0N/A<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
430N/A "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
0N/A
0N/A<html xmlns="http://www.w3.org/1999/xhtml">
0N/A <head>
0N/A <meta name="generator" content="HTML Tidy, see www.w3.org" />
0N/A
0N/A <title>Apache module mod_status</title>
0N/A </head>
0N/A <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0N/A
0N/A <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
0N/A vlink="#000080" alink="#FF0000">
0N/A <!--#include virtual="header.html" -->
0N/A
0N/A <blockquote>
0N/A <strong>Warning:</strong> This document has not been updated
0N/A to take into account changes made in the 2.0 version of the
0N/A Apache HTTP Server. Some of the information may still be
0N/A relevant, but please use it with care.
0N/A </blockquote>
0N/A
0N/A <h1 align="CENTER">Module mod_status</h1>
0N/A
0N/A <p>This module provides information on server activity and
0N/A performance.</p>
0N/A
0N/A <p><a href="module-dict.html#Status"
430N/A rel="Help"><strong>Status:</strong></a> Base<br />
0N/A <a href="module-dict.html#SourceFile"
0N/A rel="Help"><strong>Source File:</strong></a> mod_status.c<br />
0N/A <a href="module-dict.html#ModuleIdentifier"
0N/A rel="Help"><strong>Module Identifier:</strong></a>
0N/A status_module<br />
0N/A <a href="module-dict.html#Compatibility"
0N/A rel="Help"><strong>Compatibility:</strong></a> Available in
0N/A Apache 1.1 and later.</p>
0N/A
0N/A <h2>Summary</h2>
0N/A
0N/A <p>The Status module allows a server administrator to find out
0N/A how well their server is performing. A HTML page is presented
0N/A that gives the current server statistics in an easily readable
0N/A form. If required this page can be made to automatically
0N/A refresh (given a compatible browser). Another page gives a
0N/A simple machine-readable list of the current server state.</p>
0N/A
0N/A <p>The details given are:</p>
0N/A
0N/A <ul>
0N/A <li>The number of children serving requests</li>
0N/A
0N/A <li>The number of idle children</li>
0N/A
0N/A <li>The status of each child, the number of requests that
0N/A child has performed and the total number of bytes served by
0N/A the child (*)</li>
0N/A
0N/A <li>A total number of accesses and byte count served (*)</li>
0N/A
0N/A <li>The time the server was started/restarted and the time it
0N/A has been running for</li>
430N/A
0N/A <li>Averages giving the number of requests per second, the
0N/A number of bytes served per second and the average number of
0N/A bytes per request (*)</li>
0N/A
0N/A <li>The current percentage CPU used by each child and in
0N/A total by Apache (*)</li>
0N/A
0N/A <li>The current hosts and requests being processed (*)</li>
0N/A </ul>
0N/A A compile-time option must be used to display the details
0N/A marked "(*)" as the instrumentation required for obtaining
0N/A these statistics does not exist within standard Apache.
0N/A
0N/A <h2>Directives</h2>
0N/A
0N/A <ul>
0N/A <li><a href="#extendedstatus">ExtendedStatus</a></li>
0N/A </ul>
0N/A
0N/A <h2>Enabling Status Support</h2>
0N/A To enable status reports only for browsers from the foo.com
0N/A domain add this code to your <code>access.conf</code>
0N/A configuration file
0N/A<pre>
0N/A &lt;Location /server-status&gt;
0N/A SetHandler server-status
0N/A
0N/A Order Deny,Allow
0N/A Deny from all
0N/A Allow from .foo.com
0N/A &lt;/Location&gt;
0N/A</pre>
0N/A
0N/A <p>You can now access server statistics by using a Web browser
0N/A to access the page
0N/A <code>http://your.server.name/server-status</code></p>
0N/A
0N/A <p>Note that mod_status will only work when you are running
0N/A Apache in <a href="core.html#servertype">standalone</a> mode
0N/A and not <a href="core.html#servertype">inetd</a> mode.</p>
0N/A
0N/A <h3>Automatic Updates</h3>
0N/A You can get the status page to update itself automatically if
0N/A you have a browser that supports "refresh". Access the page
0N/A <code>http://your.server.name/server-status?refresh=N</code> to
0N/A refresh the page every N seconds.
0N/A
0N/A <h3>Machine Readable Status File</h3>
0N/A A machine-readable version of the status file is available by
0N/A accessing the page
0N/A <code>http://your.server.name/server-status?auto</code>. This
0N/A is useful when automatically run, see the Perl program in the
0N/A <code>/support</code> directory of Apache,
0N/A <code>log_server_status</code>.
0N/A
0N/A <blockquote>
0N/A <strong>It should be noted that if <samp>mod_status</samp> is
0N/A compiled into the server, its handler capability is available
0N/A in <em>all</em> configuration files, including
0N/A <em>per</em>-directory files (<em>e.g.</em>,
0N/A <samp>.htaccess</samp>). This may have security-related
0N/A ramifications for your site.</strong>
0N/A </blockquote>
0N/A <hr />
0N/A
0N/A <h2><a id="extendedstatus" name="extendedstatus">ExtendedStatus
0N/A directive</a></h2>
0N/A <!--%plaintext &lt;?INDEX {\tt ExtendedStatus} directive&gt; -->
0N/A <a href="directive-dict.html#Syntax"
0N/A rel="Help"><strong>Syntax:</strong></a> ExtendedStatus
0N/A On|Off<br />
0N/A <a href="directive-dict.html#Default"
0N/A rel="Help"><strong>Default:</strong></a> <code>ExtendedStatus
0N/A Off</code><br />
0N/A <a href="directive-dict.html#Context"
0N/A rel="Help"><strong>Context:</strong></a> server config <br />
0N/A <a href="directive-dict.html#Status"
0N/A rel="Help"><strong>Status:</strong></a> Base<br />
0N/A <a href="directive-dict.html#Module"
0N/A rel="Help"><strong>Module:</strong></a> mod_status<br />
0N/A <a href="directive-dict.html#Compatibility"
0N/A rel="Help"><strong>Compatibility:</strong></a> ExtendedStatus
0N/A is only available in Apache 1.3.2 and later.
0N/A
0N/A <p>This directive controls whether the server keeps track of
0N/A extended status information for each request. This is only
0N/A useful if the status module is enabled on the server.</p>
0N/A
0N/A <p>This setting applies to the entire server, and cannot be
0N/A enabled or disabled on a virtualhost-by-virtualhost basis.</p>
0N/A <!--#include virtual="footer.html" -->
0N/A </body>
0N/A</html>
0N/A
0N/A