mod_status.html revision 72d8c9a30f25171e5c85eeae21e0b87331bac2d9
2N/A<html>
2N/A<head>
2N/A<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
2N/A<!--
2N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2N/A This file is generated from xml source: DO NOT EDIT
2N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2N/A-->
2N/A<title>mod_status - Apache HTTP Server</title>
2N/A<link href="/style/manual.css" type="text/css" rel="stylesheet">
2N/A</head>
2N/A<body>
2N/A<blockquote>
2N/A<div align="center">
2N/A<img alt="[APACHE DOCUMENTATION]" src="/images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
2N/A</div>
2N/A<h1 align="center">Apache Module mod_status</h1>
2N/A<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
2N/A<tr>
2N/A<td>
2N/A<table bgcolor="#ffffff">
2N/A<tr>
2N/A<td><span class="help">Description:</span></td><td>
2N/A<description>This module provides information on server activity and
2N/Aperformance.</description>
2N/A</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>status_module</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
2N/A<compatibility>Available in Apache 1.1 and later</compatibility>
2N/A</td>
2N/A</tr>
2N/A</table>
2N/A</td>
2N/A</tr>
2N/A</table>
2N/A<h2>Summary</h2>
2N/A<summary>
2N/A
2N/A
2N/A<blockquote>
2N/A<table>
2N/A<tr>
2N/A<td bgcolor="#e0e5f5">
2N/A <strong>Warning:</strong> This document has not been updated
2N/A to take into account changes made in the 2.0 version of the
2N/A Apache HTTP Server. Some of the information may still be
2N/A relevant, but please use it with care.
2N/A</td>
2N/A</tr>
2N/A</table>
2N/A</blockquote>
2N/A
2N/A
2N/A<p>The Status module allows a server administrator to find out
2N/A how well their server is performing. A HTML page is presented
2N/A that gives the current server statistics in an easily readable
2N/A form. If required this page can be made to automatically
2N/A refresh (given a compatible browser). Another page gives a
2N/A simple machine-readable list of the current server state.</p>
2N/A
2N/A
2N/A<p>The details given are:</p>
2N/A
2N/A
2N/A<ul>
2N/A
2N/A<li>The number of children serving requests</li>
2N/A
2N/A
2N/A<li>The number of idle children</li>
2N/A
2N/A
2N/A<li>The status of each child, the number of requests that
2N/A child has performed and the total number of bytes served by
2N/A the child (*)</li>
2N/A
2N/A
2N/A<li>A total number of accesses and byte count served (*)</li>
2N/A
2N/A
2N/A<li>The time the server was started/restarted and the time it
2N/A has been running for</li>
2N/A
2N/A
2N/A<li>Averages giving the number of requests per second, the
2N/A number of bytes served per second and the average number of
2N/A bytes per request (*)</li>
2N/A
2N/A
2N/A<li>The current percentage CPU used by each child and in
2N/A total by Apache (*)</li>
2N/A
2N/A
2N/A<li>The current hosts and requests being processed (*)</li>
2N/A
2N/A</ul>
2N/A
2N/A A compile-time option must be used to display the details
2N/A marked "(*)" as the instrumentation required for obtaining
2N/A these statistics does not exist within standard Apache.
2N/A</summary>
2N/A<h2>Directives</h2>
2N/A<ul>
2N/A<li>
2N/A<a href="#extendedstatus">ExtendedStatus</a>
2N/A</li>
2N/A</ul>
2N/A<h2>Enabling Status Support</h2>
2N/A
2N/A
2N/A To enable status reports only for browsers from the foo.com
2N/A domain add this code to your <code>httpd.conf</code>
2N/A configuration file
2N/A<blockquote>
2N/A<table cellpadding="10">
2N/A<tr>
2N/A<td bgcolor="#eeeeee"><code>
2N/A &lt;Location /server-status&gt;<br>
2N/A SetHandler server-status<br>
2N/A
2N/A<br>
2N/A Order Deny,Allow<br>
2N/A Deny from all<br>
2N/A Allow from .foo.com<br>
2N/A &lt;/Location&gt;
2N/A</code></td>
2N/A</tr>
2N/A</table>
2N/A</blockquote>
2N/A
2N/A
2N/A<p>You can now access server statistics by using a Web browser
2N/A to access the page
2N/A <code>http://your.server.name/server-status</code>
2N/A</p>
2N/A
2N/A
2N/A<blockquote>
2N/A<table>
2N/A<tr>
2N/A<td bgcolor="#e0e5f5">
2N/A<p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
2N/A when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
2N/A <a href="core.html#servertype">inetd</a> mode.</p>
2N/A</td>
2N/A</tr>
2N/A</table>
2N/A</blockquote>
2N/A
2N/A<h2>Automatic Updates</h2>
2N/A
2N/A
2N/A You can get the status page to update itself automatically if
2N/A you have a browser that supports "refresh". Access the page
2N/A <code>http://your.server.name/server-status?refresh=N</code> to
2N/A refresh the page every N seconds.
2N/A
2N/A<h2>Machine Readable Status File</h2>
2N/A
2N/A
2N/A A machine-readable version of the status file is available by
2N/A accessing the page
2N/A <code>http://your.server.name/server-status?auto</code>. This
2N/A is useful when automatically run, see the Perl program in the
2N/A <code>/support</code> directory of Apache,
2N/A <code>log_server_status</code>.
2N/A
2N/A <blockquote>
2N/A<table>
2N/A<tr>
2N/A<td bgcolor="#e0e5f5">
2N/A <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
2N/A compiled into the server, its handler capability is available
2N/A in <em>all</em> configuration files, including
2N/A <em>per</em>-directory files (<em>e.g.</em>,
2N/A <code>.htaccess</code>). This may have security-related
2N/A ramifications for your site.</strong>
2N/A </td>
2N/A</tr>
2N/A</table>
2N/A</blockquote>
2N/A
2N/A
2N/A<hr>
2N/A<h2>
2N/A<a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a>
2N/A</h2>
2N/A<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
2N/A<tr>
2N/A<td>
2N/A<table width="100%" bgcolor="#ffffff">
2N/A<tr>
2N/A<td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
2N/Aextended status information for each request. This is only
2N/Auseful if the status module is enabled on the server.</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
2N/A<syntax>ExtendedStatus On|Off</syntax>
2N/A</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td>
2N/A</tr>
2N/A<tr>
2N/A<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
2N/Alater.</td>
2N/A</tr>
2N/A</table>
2N/A</td>
2N/A</tr>
2N/A</table>
2N/A<usage>
2N/A
2N/A<p>This setting applies to the entire server, and cannot be
2N/A enabled or disabled on a virtualhost-by-virtualhost basis.</p>
2N/A
2N/A</usage>
2N/A<hr>
2N/A<h3 align="center">Apache HTTP Server Version 2.0</h3>
2N/A<a href="./"><img alt="Index" src="/images/index.gif"></a><a href="../"><img alt="Home" src="/images/home.gif"></a>
2N/A</blockquote>
2N/A</body>
2N/A</html>
2N/A