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" hreflang="en" 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
  34 <div class="note">
  35   <strong>Warning:</strong> This document has not been updated
  36   to take into account changes made in the 2.0 version of the
  37   Apache HTTP Server. Some of the information may still be
  38   relevant, but please use it with care.
  39 </div>
  40
  41     <p>The Status module allows a server administrator to find out
  42     how well their server is performing. A HTML page is presented
  43     that gives the current server statistics in an easily readable
  44     form. If required this page can be made to automatically
  45     refresh (given a compatible browser). Another page gives a
  46     simple machine-readable list of the current server state.</p>
  47
  48     <p>The details given are:</p>
  49
  50     <ul>
  51       <li>The number of children serving requests</li>
  52
  53       <li>The number of idle children</li>
  54
  55       <li>The status of each child, the number of requests that
  56       child has performed and the total number of bytes served by
  57       the child (*)</li>
  58
  59       <li>A total number of accesses and byte count served (*)</li>
  60
  61       <li>The time the server was started/restarted and the time it
  62       has been running for</li>
  63
  64       <li>Averages giving the number of requests per second, the
  65       number of bytes served per second and the average number of
  66       bytes per request (*)</li>
  67
  68       <li>The current percentage CPU used by each child and in
  69       total by Apache (*)</li>
  70
  71       <li>The current hosts and requests being processed (*)</li>
  72     </ul>
  73
  74     <p>A compile-time option must be used to display the details
  75     marked "(*)" as the instrumentation required for obtaining
  76     these statistics does not exist within standard Apache.</p>
  77 </div>
  78 <div id="quickview"><h3 class="directives">Directives</h3>
  79 <ul id="toc">
  80 <li><img alt="" src="../images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li>
  81 </ul>
  82 <h3>Topics</h3>
  83 <ul id="topics">
  84 <li><img alt="" src="../images/down.gif" /> <a href="#enable">Enabling Status Support</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#autoupdate">Automatic Updates</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li>
  87 </ul></div>
  88 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  89 <div class="section">
  90 <h2><a name="enable" id="enable">Enabling Status Support</a></h2>
  91
  92
  93     <p>To enable status reports only for browsers from the foo.com
  94     domain add this code to your <code>httpd.conf</code>
  95     configuration file</p>
  96 <div class="example"><p><code>
  97     &lt;Location /server-status&gt;<br />
  98     SetHandler server-status<br />
  99 <br />
 100     Order Deny,Allow<br />
 101     Deny from all<br />
 102     Allow from .foo.com<br />
 103     &lt;/Location&gt;
 104 </code></p></div>
 105
 106     <p>You can now access server statistics by using a Web browser
 107     to access the page
 108     <code>http://your.server.name/server-status</code></p>
 109
 110     <div class="note"><p>Note that <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> will only work
 111     when you are running Apache in <a href="core.html#servertype">standalone</a> mode and not
 112     <a href="core.html#servertype">inetd</a> mode.</p></div>
 113 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 114 <div class="section">
 115 <h2><a name="autoupdate" id="autoupdate">Automatic Updates</a></h2>
 116
 117
 118     <p>You can get the status page to update itself automatically if
 119     you have a browser that supports "refresh". Access the page
 120     <code>http://your.server.name/server-status?refresh=N</code> to
 121     refresh the page every N seconds.</p>
 122
 123 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 124 <div class="section">
 125 <h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a></h2>
 126
 127
 128     <p>A machine-readable version of the status file is available by
 129     accessing the page
 130     <code>http://your.server.name/server-status?auto</code>. This
 131     is useful when automatically run, see the Perl program in the
 132     <code>/support</code> directory of Apache,
 133     <code>log_server_status</code>.</p>
 134
 135     <div class="note">
 136       <strong>It should be noted that if <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> is
 137       compiled into the server, its handler capability is available
 138       in <em>all</em> configuration files, including
 139       <em>per</em>-directory files (<em>e.g.</em>,
 140       <code>.htaccess</code>). This may have security-related
 141       ramifications for your site.</strong>
 142     </div>
 143
 144 </div>
 145 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 146 <div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
 147 <table class="directive">
 148 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
 149 request</td></tr>
 150 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
 151 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off</code></td></tr>
 152 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 153 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 154 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_status</td></tr>
 155 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ExtendedStatus is only available in Apache 1.3.2 and
 156 later.</td></tr>
 157 </table>
 158     <p>This setting applies to the entire server, and cannot be
 159     enabled or disabled on a virtualhost-by-virtualhost basis.
 160     The collection of extended status information can slow down
 161     the server.</p>
 162
 163 </div>
 164 </div>
 165 <div class="bottomlang">
 166 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" hreflang="en" title="English">&nbsp;en&nbsp;</a></p>
 167 </div><div id="footer">
 168 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
 169 <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>
 170 </body></html>