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

   1 <html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
   2           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   3                 This file is generated from xml source: DO NOT EDIT
   4           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5         --><title>mod_status- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides information on server activity and
   6 performance</td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>status_module</td></tr></table></td></tr></table><h2>Summary</h2>
   7
   8 <blockquote><table><tr><td bgcolor="#e0e5f5">
   9   <strong>Warning:</strong> This document has not been updated
  10   to take into account changes made in the 2.0 version of the
  11   Apache HTTP Server. Some of the information may still be
  12   relevant, but please use it with care.
  13 </td></tr></table></blockquote>
  14
  15     <p>The Status module allows a server administrator to find out
  16     how well their server is performing. A HTML page is presented
  17     that gives the current server statistics in an easily readable
  18     form. If required this page can be made to automatically
  19     refresh (given a compatible browser). Another page gives a
  20     simple machine-readable list of the current server state.</p>
  21
  22     <p>The details given are:</p>
  23
  24     <ul>
  25       <li>The number of children serving requests</li>
  26
  27       <li>The number of idle children</li>
  28
  29       <li>The status of each child, the number of requests that
  30       child has performed and the total number of bytes served by
  31       the child (*)</li>
  32
  33       <li>A total number of accesses and byte count served (*)</li>
  34
  35       <li>The time the server was started/restarted and the time it
  36       has been running for</li>
  37
  38       <li>Averages giving the number of requests per second, the
  39       number of bytes served per second and the average number of
  40       bytes per request (*)</li>
  41
  42       <li>The current percentage CPU used by each child and in
  43       total by Apache (*)</li>
  44
  45       <li>The current hosts and requests being processed (*)</li>
  46     </ul>
  47
  48     <p>A compile-time option must be used to display the details
  49     marked "(*)" as the instrumentation required for obtaining
  50     these statistics does not exist within standard Apache.</p>
  51 <h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
  52
  53
  54     <p>To enable status reports only for browsers from the foo.com
  55     domain add this code to your <code>httpd.conf</code>
  56     configuration file</p>
  57 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
  58     &lt;Location /server-status&gt;<br>
  59     SetHandler server-status<br>
  60 <br>
  61     Order Deny,Allow<br>
  62     Deny from all<br>
  63     Allow from .foo.com<br>
  64     &lt;/Location&gt;
  65 </code></td></tr></table></blockquote>
  66
  67     <p>You can now access server statistics by using a Web browser
  68     to access the page
  69     <code>http://your.server.name/server-status</code></p>
  70
  71     <blockquote><table><tr><td bgcolor="#e0e5f5"><p>Note that <code><a href="mod_status.html">mod_status</a></code> will only work
  72     when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
  73     <a href="core.html#servertype">inetd</a> mode.</p></td></tr></table></blockquote>
  74 <h2>Automatic Updates</h2>
  75
  76
  77     <p>You can get the status page to update itself automatically if
  78     you have a browser that supports "refresh". Access the page
  79     <code>http://your.server.name/server-status?refresh=N</code> to
  80     refresh the page every N seconds.</p>
  81
  82 <h2>Machine Readable Status File</h2>
  83
  84
  85     <p>A machine-readable version of the status file is available by
  86     accessing the page
  87     <code>http://your.server.name/server-status?auto</code>. This
  88     is useful when automatically run, see the Perl program in the
  89     <code>/support</code> directory of Apache,
  90     <code>log_server_status</code>.</p>
  91
  92     <blockquote><table><tr><td bgcolor="#e0e5f5">
  93       <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> is
  94       compiled into the server, its handler capability is available
  95       in <em>all</em> configuration files, including
  96       <em>per</em>-directory files (<em>e.g.</em>,
  97       <code>.htaccess</code>). This may have security-related
  98       ramifications for your site.</strong>
  99     </td></tr></table></blockquote>
 100
 101 <hr/><h2><a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>This directive controls whether the server keeps track of
 102 extended status information for each request. This is only
 103 useful if the status module is enabled on the server.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>ExtendedStatus On|Off</td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
 104 later.</td></tr></table></td></tr></table>
 105     <p>This setting applies to the entire server, and cannot be
 106     enabled or disabled on a virtualhost-by-virtualhost basis.</p>
 107 <hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html>