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

   1 <html>
   2 <head>
   3 <META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   4 <!--
   5 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   6      This file is generated from xml source: DO NOT EDIT
   7 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   8 -->
   9 <title>mod_status - Apache HTTP Server</title>
  10 <link href="../style/manual.css" type="text/css" rel="stylesheet">
  11 </head>
  12 <body>
  13 <blockquote>
  14 <div align="center">
  15 <img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
  16 </div>
  17 <h1 align="center">Apache Module mod_status</h1>
  18 <table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
  19 <tr>
  20 <td>
  21 <table bgcolor="#ffffff">
  22 <tr>
  23 <td><span class="help">Description:</span></td><td>
  24 <description>This module provides information on server activity and
  25 performance.</description>
  26 </td>
  27 </tr>
  28 <tr>
  29 <td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
  30 </tr>
  31 <tr>
  32 <td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>status_module</td>
  33 </tr>
  34 <tr>
  35 <td><a href="module-dict.html#Compatibility" class="help">Compatibility:</a></td><td>
  36 <compatibility>Available in Apache 1.1 and later</compatibility>
  37 </td>
  38 </tr>
  39 </table>
  40 </td>
  41 </tr>
  42 </table>
  43 <h2>Summary</h2>
  44 <summary>
  45
  46
  47 <blockquote>
  48 <table>
  49 <tr>
  50 <td bgcolor="#e0e5f5">
  51   <strong>Warning:</strong> This document has not been updated
  52   to take into account changes made in the 2.0 version of the
  53   Apache HTTP Server. Some of the information may still be
  54   relevant, but please use it with care.
  55 </td>
  56 </tr>
  57 </table>
  58 </blockquote>
  59
  60
  61 <p>The Status module allows a server administrator to find out
  62     how well their server is performing. A HTML page is presented
  63     that gives the current server statistics in an easily readable
  64     form. If required this page can be made to automatically
  65     refresh (given a compatible browser). Another page gives a
  66     simple machine-readable list of the current server state.</p>
  67
  68
  69 <p>The details given are:</p>
  70
  71
  72 <ul>
  73
  74 <li>The number of children serving requests</li>
  75
  76
  77 <li>The number of idle children</li>
  78
  79
  80 <li>The status of each child, the number of requests that
  81       child has performed and the total number of bytes served by
  82       the child (*)</li>
  83
  84
  85 <li>A total number of accesses and byte count served (*)</li>
  86
  87
  88 <li>The time the server was started/restarted and the time it
  89       has been running for</li>
  90
  91
  92 <li>Averages giving the number of requests per second, the
  93       number of bytes served per second and the average number of
  94       bytes per request (*)</li>
  95
  96
  97 <li>The current percentage CPU used by each child and in
  98       total by Apache (*)</li>
  99
 100
 101 <li>The current hosts and requests being processed (*)</li>
 102
 103 </ul>
 104
 105     A compile-time option must be used to display the details
 106     marked "(*)" as the instrumentation required for obtaining
 107     these statistics does not exist within standard Apache.
 108 </summary>
 109 <h2>Directives</h2>
 110 <ul>
 111 <li>
 112 <a href="#extendedstatus">ExtendedStatus</a>
 113 </li>
 114 </ul>
 115 <h2>Enabling Status Support</h2>
 116
 117
 118     To enable status reports only for browsers from the foo.com
 119     domain add this code to your <code>httpd.conf</code>
 120     configuration file
 121 <blockquote>
 122 <table cellpadding="10">
 123 <tr>
 124 <td bgcolor="#eeeeee"><code>
 125     &lt;Location /server-status&gt;<br>
 126     SetHandler server-status<br>
 127
 128 <br>
 129     Order Deny,Allow<br>
 130     Deny from all<br>
 131     Allow from .foo.com<br>
 132     &lt;/Location&gt;
 133 </code></td>
 134 </tr>
 135 </table>
 136 </blockquote>
 137
 138
 139 <p>You can now access server statistics by using a Web browser
 140     to access the page
 141     <code>http://your.server.name/server-status</code>
 142 </p>
 143
 144
 145 <blockquote>
 146 <table>
 147 <tr>
 148 <td bgcolor="#e0e5f5">
 149 <p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
 150     when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
 151     <a href="core.html#servertype">inetd</a> mode.</p>
 152 </td>
 153 </tr>
 154 </table>
 155 </blockquote>
 156
 157 <h2>Automatic Updates</h2>
 158
 159
 160     You can get the status page to update itself automatically if
 161     you have a browser that supports "refresh". Access the page
 162     <code>http://your.server.name/server-status?refresh=N</code> to
 163     refresh the page every N seconds.
 164
 165 <h2>Machine Readable Status File</h2>
 166
 167
 168     A machine-readable version of the status file is available by
 169     accessing the page
 170     <code>http://your.server.name/server-status?auto</code>. This
 171     is useful when automatically run, see the Perl program in the
 172     <code>/support</code> directory of Apache,
 173     <code>log_server_status</code>.
 174
 175     <blockquote>
 176 <table>
 177 <tr>
 178 <td bgcolor="#e0e5f5">
 179       <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
 180       compiled into the server, its handler capability is available
 181       in <em>all</em> configuration files, including
 182       <em>per</em>-directory files (<em>e.g.</em>,
 183       <code>.htaccess</code>). This may have security-related
 184       ramifications for your site.</strong>
 185     </td>
 186 </tr>
 187 </table>
 188 </blockquote>
 189
 190
 191 <hr>
 192 <h2>
 193 <a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a>
 194 </h2>
 195 <table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
 196 <tr>
 197 <td>
 198 <table width="100%" bgcolor="#ffffff">
 199 <tr>
 200 <td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
 201 extended status information for each request. This is only
 202 useful if the status module is enabled on the server.</td>
 203 </tr>
 204 <tr>
 205 <td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
 206 <syntax>ExtendedStatus On|Off</syntax>
 207 </td>
 208 </tr>
 209 <tr>
 210 <td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td>
 211 </tr>
 212 <tr>
 213 <td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td>
 214 </tr>
 215 <tr>
 216 <td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
 217 </tr>
 218 <tr>
 219 <td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td>
 220 </tr>
 221 <tr>
 222 <td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
 223 later.</td>
 224 </tr>
 225 </table>
 226 </td>
 227 </tr>
 228 </table>
 229 <usage>
 230
 231 <p>This setting applies to the entire server, and cannot be
 232     enabled or disabled on a virtualhost-by-virtualhost basis.</p>
 233
 234 </usage>
 235 <hr>
 236 <h3 align="center">Apache HTTP Server Version 2.0</h3>
 237 <a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
 238 </blockquote>
 239 </body>
 240 </html>