home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252785_mod_status.xml < prev    next >
Extensible Markup Language  |  2003-04-17  |  5KB  |  139 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. <modulesynopsis metafile="mod_status.xml.meta">
  5.  
  6. <name>mod_status</name>
  7. <description>Provides information on server activity and
  8. performance</description>
  9. <status>Base</status>
  10. <sourcefile>mod_status.c</sourcefile>
  11. <identifier>status_module</identifier>
  12.  
  13.  
  14. <summary>
  15.  
  16. <note>
  17.   <strong>Warning:</strong> This document has not been updated
  18.   to take into account changes made in the 2.0 version of the
  19.   Apache HTTP Server. Some of the information may still be
  20.   relevant, but please use it with care.
  21. </note>
  22.  
  23.     <p>The Status module allows a server administrator to find out
  24.     how well their server is performing. A HTML page is presented
  25.     that gives the current server statistics in an easily readable
  26.     form. If required this page can be made to automatically
  27.     refresh (given a compatible browser). Another page gives a
  28.     simple machine-readable list of the current server state.</p>
  29.  
  30.     <p>The details given are:</p>
  31.  
  32.     <ul>
  33.       <li>The number of children serving requests</li>
  34.  
  35.       <li>The number of idle children</li>
  36.  
  37.       <li>The status of each child, the number of requests that
  38.       child has performed and the total number of bytes served by
  39.       the child (*)</li>
  40.  
  41.       <li>A total number of accesses and byte count served (*)</li>
  42.  
  43.       <li>The time the server was started/restarted and the time it
  44.       has been running for</li>
  45.  
  46.       <li>Averages giving the number of requests per second, the
  47.       number of bytes served per second and the average number of
  48.       bytes per request (*)</li>
  49.  
  50.       <li>The current percentage CPU used by each child and in
  51.       total by Apache (*)</li>
  52.  
  53.       <li>The current hosts and requests being processed (*)</li>
  54.     </ul>
  55.  
  56.     <p>A compile-time option must be used to display the details
  57.     marked "(*)" as the instrumentation required for obtaining
  58.     these statistics does not exist within standard Apache.</p>
  59. </summary>
  60.  
  61. <section id="enable">
  62.     <title>Enabling Status Support</title>
  63.  
  64.     <p>To enable status reports only for browsers from the foo.com
  65.     domain add this code to your <code>httpd.conf</code>
  66.     configuration file</p>
  67. <example>
  68.     <Location /server-status><br />
  69.     SetHandler server-status<br />
  70. <br />
  71.     Order Deny,Allow<br />
  72.     Deny from all<br />
  73.     Allow from .foo.com<br />
  74.     </Location>
  75. </example>
  76.  
  77.     <p>You can now access server statistics by using a Web browser
  78.     to access the page
  79.     <code>http://your.server.name/server-status</code></p>
  80.  
  81.     <note><p>Note that <module>mod_status</module> will only work
  82.     when you are running Apache in <a 
  83.     href="core.html#servertype">standalone</a> mode and not
  84.     <a href="core.html#servertype">inetd</a> mode.</p></note>
  85. </section>
  86.  
  87. <section id="autoupdate">
  88.  
  89.     <title>Automatic Updates</title>
  90.     <p>You can get the status page to update itself automatically if
  91.     you have a browser that supports "refresh". Access the page
  92.     <code>http://your.server.name/server-status?refresh=N</code> to
  93.     refresh the page every N seconds.</p>
  94.  
  95. </section>
  96.  
  97. <section id="machinereadable">
  98.  
  99.     <title>Machine Readable Status File</title>
  100.     <p>A machine-readable version of the status file is available by
  101.     accessing the page
  102.     <code>http://your.server.name/server-status?auto</code>. This
  103.     is useful when automatically run, see the Perl program in the
  104.     <code>/support</code> directory of Apache,
  105.     <code>log_server_status</code>.</p>
  106.  
  107.     <note>
  108.       <strong>It should be noted that if <module>mod_status</module> is
  109.       compiled into the server, its handler capability is available
  110.       in <em>all</em> configuration files, including
  111.       <em>per</em>-directory files (<em>e.g.</em>,
  112.       <code>.htaccess</code>). This may have security-related
  113.       ramifications for your site.</strong>
  114.     </note>
  115.  
  116. </section>
  117.  
  118. <directivesynopsis>
  119.  
  120. <name>ExtendedStatus</name>
  121. <description>Keep track of extended status information for each 
  122. request</description>
  123. <syntax>ExtendedStatus On|Off</syntax>
  124. <default>ExtendedStatus Off</default>
  125. <contextlist><context>server config</context></contextlist>
  126. <compatibility>ExtendedStatus is only available in Apache 1.3.2 and 
  127. later.</compatibility>
  128.  
  129. <usage>
  130.     <p>This setting applies to the entire server, and cannot be
  131.     enabled or disabled on a virtualhost-by-virtualhost basis.
  132.     The collection of extended status information can slow down
  133.     the server.</p>
  134. </usage>
  135.  
  136. </directivesynopsis>
  137. </modulesynopsis>
  138.  
  139.