granicus.if.org Git - apache/blob - docs/manual/mod/mod_status.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_status - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_status</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides information on server activity and
  27 performance</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>status_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_status.c</td></tr></table>
  31 <h3>Summary</h3>
  32
  33     <p>The Status module allows a server administrator to find out
  34     how well their server is performing. A HTML page is presented
  35     that gives the current server statistics in an easily readable
  36     form. If required this page can be made to automatically
  37     refresh (given a compatible browser). Another page gives a
  38     simple machine-readable list of the current server state.</p>
  39
  40     <p>The details given are:</p>
  41
  42     <ul>
  43       <li>The number of worker serving requests</li>
  44
  45       <li>The number of idle worker</li>
  46
  47       <li>The status of each worker, the number of requests that
  48       worker has performed and the total number of bytes served by
  49       the worker (*)</li>
  50
  51       <li>A total number of accesses and byte count served (*)</li>
  52
  53       <li>The time the server was started/restarted and the time it
  54       has been running for</li>
  55
  56       <li>Averages giving the number of requests per second, the
  57       number of bytes served per second and the average number of
  58       bytes per request (*)</li>
  59
  60       <li>The current percentage CPU used by each worker and in
  61       total by Apache (*)</li>
  62
  63       <li>The current hosts and requests being processed (*)</li>
  64     </ul>
  65
  66     <p>A compile-time option must be used to display the details
  67     marked "(*)" as the instrumentation required for obtaining
  68     these statistics does not exist within standard Apache.</p>
  69 </div>
  70 <div id="quickview"><h3 class="directives">Directives</h3>
  71 <ul id="toc">
  72 <li><img alt="" src="../images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li>
  73 </ul>
  74 <h3>Topics</h3>
  75 <ul id="topics">
  76 <li><img alt="" src="../images/down.gif" /> <a href="#enable">Enabling Status Support</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#autoupdate">Automatic Updates</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li>
  79 </ul></div>
  80 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81 <div class="section">
  82 <h2><a name="enable" id="enable">Enabling Status Support</a></h2>
  83
  84
  85     <p>To enable status reports only for browsers from the foo.com
  86     domain add this code to your <code>httpd.conf</code>
  87     configuration file</p>
  88 <div class="example"><p><code>
  89     &lt;Location /server-status&gt;<br />
  90     SetHandler server-status<br />
  91 <br />
  92     Order Deny,Allow<br />
  93     Deny from all<br />
  94     Allow from .foo.com<br />
  95     &lt;/Location&gt;
  96 </code></p></div>
  97
  98     <p>You can now access server statistics by using a Web browser
  99     to access the page
 100     <code>http://your.server.name/server-status</code></p>
 101 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 102 <div class="section">
 103 <h2><a name="autoupdate" id="autoupdate">Automatic Updates</a></h2>
 104
 105
 106     <p>You can get the status page to update itself automatically if
 107     you have a browser that supports "refresh". Access the page
 108     <code>http://your.server.name/server-status?refresh=N</code> to
 109     refresh the page every N seconds.</p>
 110
 111 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 112 <div class="section">
 113 <h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a></h2>
 114
 115
 116     <p>A machine-readable version of the status file is available by
 117     accessing the page
 118     <code>http://your.server.name/server-status?auto</code>. This
 119     is useful when automatically run, see the Perl program in the
 120     <code>/support</code> directory of Apache,
 121     <code>log_server_status</code>.</p>
 122
 123     <div class="note">
 124       <strong>It should be noted that if <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> is
 125       compiled into the server, its handler capability is available
 126       in <em>all</em> configuration files, including
 127       <em>per</em>-directory files (<em>e.g.</em>,
 128       <code>.htaccess</code>). This may have security-related
 129       ramifications for your site.</strong>
 130     </div>
 131
 132 </div>
 133 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 134 <div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
 135 <table class="directive">
 136 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
 137 request</td></tr>
 138 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
 139 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off</code></td></tr>
 140 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 141 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 142 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_status</td></tr>
 143 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ExtendedStatus is only available in Apache 1.3.2 and
 144 later.</td></tr>
 145 </table>
 146     <p>This setting applies to the entire server, and cannot be
 147     enabled or disabled on a virtualhost-by-virtualhost basis.
 148     The collection of extended status information can slow down
 149     the server.</p>
 150
 151 </div>
 152 </div>
 153 <div class="bottomlang">
 154 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" title="English">&nbsp;en&nbsp;</a></p>
 155 </div><div id="footer">
 156 <p class="apache">Copyright 1999-2004 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>
 157 <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>
 158 </body></html>