home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278369_mod_status.xml < prev    next >
Extensible Markup Language  |  2004-09-04  |  5KB  |  144 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.4.2.6 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_status.xml.meta">
  23.  
  24. <name>mod_status</name>
  25. <description>Provides information on server activity and
  26. performance</description>
  27. <status>Base</status>
  28. <sourcefile>mod_status.c</sourcefile>
  29. <identifier>status_module</identifier>
  30.  
  31.  
  32. <summary>
  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. </summary>
  70.  
  71. <section id="enable">
  72.     <title>Enabling Status Support</title>
  73.  
  74.     <p>To enable status reports only for browsers from the foo.com
  75.     domain add this code to your <code>httpd.conf</code>
  76.     configuration file</p>
  77. <example>
  78.     <Location /server-status><br />
  79.     SetHandler server-status<br />
  80. <br />
  81.     Order Deny,Allow<br />
  82.     Deny from all<br />
  83.     Allow from .foo.com<br />
  84.     </Location>
  85. </example>
  86.  
  87.     <p>You can now access server statistics by using a Web browser
  88.     to access the page
  89.     <code>http://your.server.name/server-status</code></p>
  90. </section>
  91.  
  92. <section id="autoupdate">
  93.  
  94.     <title>Automatic Updates</title>
  95.     <p>You can get the status page to update itself automatically if
  96.     you have a browser that supports "refresh". Access the page
  97.     <code>http://your.server.name/server-status?refresh=N</code> to
  98.     refresh the page every N seconds.</p>
  99.  
  100. </section>
  101.  
  102. <section id="machinereadable">
  103.  
  104.     <title>Machine Readable Status File</title>
  105.     <p>A machine-readable version of the status file is available by
  106.     accessing the page
  107.     <code>http://your.server.name/server-status?auto</code>. This
  108.     is useful when automatically run, see the Perl program in the
  109.     <code>/support</code> directory of Apache,
  110.     <code>log_server_status</code>.</p>
  111.  
  112.     <note>
  113.       <strong>It should be noted that if <module>mod_status</module> is
  114.       compiled into the server, its handler capability is available
  115.       in <em>all</em> configuration files, including
  116.       <em>per</em>-directory files (<em>e.g.</em>,
  117.       <code>.htaccess</code>). This may have security-related
  118.       ramifications for your site.</strong>
  119.     </note>
  120.  
  121. </section>
  122.  
  123. <directivesynopsis>
  124.  
  125. <name>ExtendedStatus</name>
  126. <description>Keep track of extended status information for each 
  127. request</description>
  128. <syntax>ExtendedStatus On|Off</syntax>
  129. <default>ExtendedStatus Off</default>
  130. <contextlist><context>server config</context></contextlist>
  131. <compatibility>ExtendedStatus is only available in Apache 1.3.2 and 
  132. later.</compatibility>
  133.  
  134. <usage>
  135.     <p>This setting applies to the entire server, and cannot be
  136.     enabled or disabled on a virtualhost-by-virtualhost basis.
  137.     The collection of extended status information can slow down
  138.     the server.</p>
  139. </usage>
  140.  
  141. </directivesynopsis>
  142. </modulesynopsis>
  143.  
  144.