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

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4
   5 <!--
   6  Copyright 2002-2004 The Apache Software Foundation
   7
   8  Licensed under the Apache License, Version 2.0 (the "License");
   9  you may not use this file except in compliance with the License.
  10  You may obtain a copy of the License at
  11
  12      http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS,
  16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  See the License for the specific language governing permissions and
  18  limitations under the License.
  19 -->
  20
  21 <modulesynopsis metafile="mod_status.xml.meta">
  22
  23 <name>mod_status</name>
  24 <description>Provides information on server activity and
  25 performance</description>
  26 <status>Base</status>
  27 <sourcefile>mod_status.c</sourcefile>
  28 <identifier>status_module</identifier>
  29
  30
  31 <summary>
  32     <p>The Status module allows a server administrator to find out
  33     how well their server is performing. A HTML page is presented
  34     that gives the current server statistics in an easily readable
  35     form. If required this page can be made to automatically
  36     refresh (given a compatible browser). Another page gives a
  37     simple machine-readable list of the current server state.</p>
  38
  39     <p>The details given are:</p>
  40
  41     <ul>
  42       <li>The number of worker serving requests</li>
  43
  44       <li>The number of idle worker</li>
  45
  46       <li>The status of each worker, the number of requests that
  47       worker has performed and the total number of bytes served by
  48       the worker (*)</li>
  49
  50       <li>A total number of accesses and byte count served (*)</li>
  51
  52       <li>The time the server was started/restarted and the time it
  53       has been running for</li>
  54
  55       <li>Averages giving the number of requests per second, the
  56       number of bytes served per second and the average number of
  57       bytes per request (*)</li>
  58
  59       <li>The current percentage CPU used by each worker and in
  60       total by Apache (*)</li>
  61
  62       <li>The current hosts and requests being processed (*)</li>
  63     </ul>
  64
  65     <p>A compile-time option must be used to display the details
  66     marked "(*)" as the instrumentation required for obtaining
  67     these statistics does not exist within standard Apache.</p>
  68 </summary>
  69
  70 <section id="enable">
  71     <title>Enabling Status Support</title>
  72
  73     <p>To enable status reports only for browsers from the foo.com
  74     domain add this code to your <code>httpd.conf</code>
  75     configuration file</p>
  76 <example>
  77     &lt;Location /server-status&gt;<br />
  78     SetHandler server-status<br />
  79 <br />
  80     Order Deny,Allow<br />
  81     Deny from all<br />
  82     Allow from .foo.com<br />
  83     &lt;/Location&gt;
  84 </example>
  85
  86     <p>You can now access server statistics by using a Web browser
  87     to access the page
  88     <code>http://your.server.name/server-status</code></p>
  89 </section>
  90
  91 <section id="autoupdate">
  92
  93     <title>Automatic Updates</title>
  94     <p>You can get the status page to update itself automatically if
  95     you have a browser that supports "refresh". Access the page
  96     <code>http://your.server.name/server-status?refresh=N</code> to
  97     refresh the page every N seconds.</p>
  98
  99 </section>
 100
 101 <section id="machinereadable">
 102
 103     <title>Machine Readable Status File</title>
 104     <p>A machine-readable version of the status file is available by
 105     accessing the page
 106     <code>http://your.server.name/server-status?auto</code>. This
 107     is useful when automatically run, see the Perl program in the
 108     <code>/support</code> directory of Apache,
 109     <code>log_server_status</code>.</p>
 110
 111     <note>
 112       <strong>It should be noted that if <module>mod_status</module> is
 113       compiled into the server, its handler capability is available
 114       in <em>all</em> configuration files, including
 115       <em>per</em>-directory files (<em>e.g.</em>,
 116       <code>.htaccess</code>). This may have security-related
 117       ramifications for your site.</strong>
 118     </note>
 119
 120 </section>
 121
 122 <directivesynopsis>
 123
 124 <name>ExtendedStatus</name>
 125 <description>Keep track of extended status information for each
 126 request</description>
 127 <syntax>ExtendedStatus On|Off</syntax>
 128 <default>ExtendedStatus Off</default>
 129 <contextlist><context>server config</context></contextlist>
 130 <compatibility>ExtendedStatus is only available in Apache 1.3.2 and
 131 later.</compatibility>
 132
 133 <usage>
 134     <p>This setting applies to the entire server, and cannot be
 135     enabled or disabled on a virtualhost-by-virtualhost basis.
 136     The collection of extended status information can slow down
 137     the server.</p>
 138 </usage>
 139
 140 </directivesynopsis>
 141 </modulesynopsis>
 142