mod_status.html.en revision 4b22542f6f38567cae7873b176188a6622f67eb0
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_status - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body>
<div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
<p class="apache">Apache HTTP Server Version 2.3</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_status</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/mod/mod_status.html" title="English"> en </a> |
<a href="/ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="/ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides information on server activity and
performance</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>status_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_status.c</td></tr></table>
<h3>Summary</h3>
<p>The Status module allows a server administrator to find out
how well their server is performing. A HTML page is presented
that gives the current server statistics in an easily readable
form. If required this page can be made to automatically
refresh (given a compatible browser). Another page gives a
simple machine-readable list of the current server state.</p>
<p>The details given are:</p>
<ul>
<li>The number of worker serving requests</li>
<li>The number of idle worker</li>
<li>The status of each worker, the number of requests that
worker has performed and the total number of bytes served by
the worker (*)</li>
<li>A total number of accesses and byte count served (*)</li>
has been running for</li>
<li>Averages giving the number of requests per second, the
number of bytes served per second and the average number of
bytes per request (*)</li>
<li>The current percentage CPU used by each worker and in
total by Apache (*)</li>
<li>The current hosts and requests being processed (*)</li>
</ul>
<p>A compile-time option must be used to display the details
marked "(*)" as the instrumentation required for obtaining
these statistics does not exist within standard Apache.</p>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
</ul>
<h3>Topics</h3>
<ul id="topics">
<li><img alt="" src="/images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li>
</ul></div>
<div class="section">
<h2><a name="enable" id="enable">Enabling Status Support</a></h2>
<p>To enable status reports only for browsers from the foo.com
configuration file</p>
<div class="example"><p><code>
<Location /server-status><br />
SetHandler server-status<br />
<br />
Order Deny,Allow<br />
Deny from all<br />
Allow from .foo.com<br />
</Location>
</code></p></div>
<p>You can now access server statistics by using a Web browser
to access the page
<div class="section">
<h2><a name="autoupdate" id="autoupdate">Automatic Updates</a></h2>
<p>You can get the status page to update itself automatically if
you have a browser that supports "refresh". Access the page
refresh the page every N seconds.</p>
<div class="section">
<h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a></h2>
<p>A machine-readable version of the status file is available by
accessing the page
is useful when automatically run, see the Perl program in the
<code>/support</code> directory of Apache,
<code>log_server_status</code>.</p>
<div class="note">
<strong>It should be noted that if <code class="module"><a href="/mod/mod_status.html">mod_status</a></code> is
compiled into the server, its handler capability is available
in <em>all</em> configuration files, including
<code>.htaccess</code>). This may have security-related
ramifications for your site.</strong>
</div>
</div>
<div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
request</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off</code></td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ExtendedStatus is only available in Apache 1.3.2 and
later.</td></tr>
</table>
<p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.
The collection of extended status information can slow down
the server.</p>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_status.html" title="English"> en </a> |
<a href="/ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="/ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div><div id="footer">
<p class="apache">Copyright 2006 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>