bottleneck testcase based on rubbos
[bottlenecks.git] / rubbos / app / httpd-2.0.64 / 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.0</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/">Documentation</a> &gt; <a href="../">Version 2.0</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" title="English">&nbsp;en&nbsp;</a> |
25 <a href="../ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
26 <a href="../ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
27 <a href="../tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
28 </div>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides information on server activity and
30 performance</td></tr>
31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>status_module</td></tr>
33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_status.c</td></tr></table>
34 <h3>Summary</h3>
35
36     <p>The Status module allows a server administrator to find out
37     how well their server is performing. A HTML page is presented
38     that gives the current server statistics in an easily readable
39     form. If required this page can be made to automatically
40     refresh (given a compatible browser). Another page gives a
41     simple machine-readable list of the current server state.</p>
42
43     <p>The details given are:</p>
44
45     <ul>
46       <li>The number of worker serving requests</li>
47
48       <li>The number of idle worker</li>
49
50       <li>The status of each worker, the number of requests that
51       worker has performed and the total number of bytes served by
52       the worker (*)</li>
53
54       <li>A total number of accesses and byte count served (*)</li>
55
56       <li>The time the server was started/restarted and the time it
57       has been running for</li>
58
59       <li>Averages giving the number of requests per second, the
60       number of bytes served per second and the average number of
61       bytes per request (*)</li>
62
63       <li>The current percentage CPU used by each worker and in
64       total by Apache (*)</li>
65
66       <li>The current hosts and requests being processed (*)</li>
67     </ul>
68
69     <p>The lines marked "(*)" are only available if 
70     <code class="directive"><a href="#extendedstatus">ExtendedStatus</a></code> 
71     is <code>On</code>.</p>
72 </div>
73 <div id="quickview"><h3 class="directives">Directives</h3>
74 <ul id="toc">
75 <li><img alt="" src="../images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li>
76 </ul>
77 <h3>Topics</h3>
78 <ul id="topics">
79 <li><img alt="" src="../images/down.gif" /> <a href="#enable">Enabling Status Support</a></li>
80 <li><img alt="" src="../images/down.gif" /> <a href="#autoupdate">Automatic Updates</a></li>
81 <li><img alt="" src="../images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li>
82 </ul></div>
83 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
84 <div class="section">
85 <h2><a name="enable" id="enable">Enabling Status Support</a></h2>
86     
87
88     <p>To enable status reports only for browsers from the foo.com
89     domain add this code to your <code>httpd.conf</code>
90     configuration file</p>
91 <div class="example"><p><code>
92     &lt;Location /server-status&gt;<br />
93     SetHandler server-status<br />
94 <br />
95     Order Deny,Allow<br />
96     Deny from all<br />
97     Allow from .foo.com<br />
98     &lt;/Location&gt;
99 </code></p></div>
100
101     <p>You can now access server statistics by using a Web browser
102     to access the page
103     <code>http://your.server.name/server-status</code></p>
104 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
105 <div class="section">
106 <h2><a name="autoupdate" id="autoupdate">Automatic Updates</a></h2>
107
108     
109     <p>You can get the status page to update itself automatically if
110     you have a browser that supports "refresh". Access the page
111     <code>http://your.server.name/server-status?refresh=N</code> to
112     refresh the page every N seconds.</p>
113
114 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
115 <div class="section">
116 <h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a></h2>
117
118     
119     <p>A machine-readable version of the status file is available by
120     accessing the page
121     <code>http://your.server.name/server-status?auto</code>. This
122     is useful when automatically run, see the Perl program in the
123     <code>/support</code> directory of Apache,
124     <code>log_server_status</code>.</p>
125
126     <div class="note">
127       <strong>It should be noted that if <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> is
128       compiled into the server, its handler capability is available
129       in <em>all</em> configuration files, including
130       <em>per</em>-directory files (<em>e.g.</em>,
131       <code>.htaccess</code>). This may have security-related
132       ramifications for your site.</strong>
133     </div>
134
135 </div>
136 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
137 <div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
138 <table class="directive">
139 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each 
140 request</td></tr>
141 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
142 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off</code></td></tr>
143 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
144 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
145 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_status</td></tr>
146 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ExtendedStatus is only available in Apache 1.3.2 and 
147 later.</td></tr>
148 </table>
149     <p>This setting applies to the entire server, and cannot be
150     enabled or disabled on a virtualhost-by-virtualhost basis.
151     The collection of extended status information can slow down
152     the server.</p>
153
154 </div>
155 </div>
156 <div class="bottomlang">
157 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" title="English">&nbsp;en&nbsp;</a> |
158 <a href="../ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
159 <a href="../ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
160 <a href="../tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
161 </div><div id="footer">
162 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
163 <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>
164 </body></html>