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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_status</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_status.html" title="English"> en </a> | 28<a href="/ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 29<a href="/ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 30<a href="/tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p> 31</div> 32<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides information on server activity and 33performance</td></tr> 34<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> 35<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>status_module</td></tr> 36<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_status.c</td></tr></table> 37<h3>Summary</h3> 38 39 <p>The Status module allows a server administrator to find out 40 how well their server is performing. A HTML page is presented 41 that gives the current server statistics in an easily readable 42 form. If required this page can be made to automatically 43 refresh (given a compatible browser). Another page gives a 44 simple machine-readable list of the current server state.</p> 45 46 <p>The details given are:</p> 47 48 <ul> 49 <li>The number of worker serving requests</li> 50 51 <li>The number of idle worker</li> 52 53 <li>The status of each worker, the number of requests that 54 worker has performed and the total number of bytes served by 55 the worker (*)</li> 56 57 <li>A total number of accesses and byte count served (*)</li> 58 59 <li>The time the server was started/restarted and the time it 60 has been running for</li> 61 62 <li>Averages giving the number of requests per second, the 63 number of bytes served per second and the average number of 64 bytes per request (*)</li> 65 66 <li>The current percentage CPU used by each worker and in 67 total by Apache (*)</li> 68 69 <li>The current hosts and requests being processed (*)</li> 70 </ul> 71 72 <p>The lines marked "(*)" are only available if 73 <code class="directive"><a href="#extendedstatus">ExtendedStatus</a></code> 74 is <code>On</code>.</p> 75</div> 76<div id="quickview"><h3 class="directives">Directives</h3> 77<ul id="toc"> 78<li><img alt="" src="/images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li> 79<li><img alt="" src="/images/down.gif" /> <a href="#seerequesttail">SeeRequestTail</a></li> 80</ul> 81<h3>Topics</h3> 82<ul id="topics"> 83<li><img alt="" src="/images/down.gif" /> <a href="#enable">Enabling Status Support</a></li> 84<li><img alt="" src="/images/down.gif" /> <a href="#autoupdate">Automatic Updates</a></li> 85<li><img alt="" src="/images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li> 86</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 87<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 88<div class="section"> 89<h2><a name="enable" id="enable">Enabling Status Support</a></h2> 90 91 92 <p>To enable status reports only for browsers from the example.com 93 domain add this code to your <code>httpd.conf</code> 94 configuration file</p> 95<div class="example"><p><code> 96 <Location /server-status><br /> 97 SetHandler server-status<br /> 98<br /> 99 Order Deny,Allow<br /> 100 Deny from all<br /> 101 Allow from .example.com<br /> 102 </Location> 103</code></p></div> 104 105 <p>You can now access server statistics by using a Web browser 106 to access the page 107 <code>http://your.server.name/server-status</code></p> 108</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 109<div class="section"> 110<h2><a name="autoupdate" id="autoupdate">Automatic Updates</a></h2> 111 112 113 <p>You can get the status page to update itself automatically if 114 you have a browser that supports "refresh". Access the page 115 <code>http://your.server.name/server-status?refresh=N</code> to 116 refresh the page every N seconds.</p> 117 118</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 119<div class="section"> 120<h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a></h2> 121 122 123 <p>A machine-readable version of the status file is available by 124 accessing the page 125 <code>http://your.server.name/server-status?auto</code>. This 126 is useful when automatically run, see the Perl program in the 127 <code>/support</code> directory of Apache, 128 <code>log_server_status</code>.</p> 129 130 <div class="note"> 131 <strong>It should be noted that if <code class="module"><a href="/mod/mod_status.html">mod_status</a></code> is 132 compiled into the server, its handler capability is available 133 in <em>all</em> configuration files, including 134 <em>per</em>-directory files (<em>e.g.</em>, 135 <code>.htaccess</code>). This may have security-related 136 ramifications for your site.</strong> 137 </div> 138 139</div> 140<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 141<div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2> 142<table class="directive"> 143<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each 144request</td></tr> 145<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr> 146<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off</code></td></tr> 147<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 148<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 149<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_status</td></tr> 150<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>ExtendedStatus is only available in Apache 1.3.2 and 151later.</td></tr> 152</table> 153 <p>This setting applies to the entire server, and cannot be 154 enabled or disabled on a virtualhost-by-virtualhost basis. 155 The collection of extended status information can slow down 156 the server.</p> 157 158</div> 159<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 160<div class="directive-section"><h2><a name="SeeRequestTail" id="SeeRequestTail">SeeRequestTail</a> <a name="seerequesttail" id="seerequesttail">Directive</a></h2> 161<table class="directive"> 162<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine if mod_status displays the first 63 characters 163of a request or the last 63, assuming the request itself is greater than 16463 chars.</td></tr> 165<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SeeRequestTail On|Off</code></td></tr> 166<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SeeRequestTail Off</code></td></tr> 167<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> 168<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 169<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_status</td></tr> 170<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.7 and later.</td></tr> 171</table> 172 <p>mod_status with <code>ExtendedStatus On</code> 173 displays the actual request being handled. 174 For historical purposes, only 63 characters of the request 175 are actually stored for display purposes. This directive 176 controls whether the 1st 63 characters are stored (the previous 177 behavior and the default) or if the last 63 characters are. This 178 is only applicable, of course, if the length of the request is 179 64 characters or greater.</p> 180 181 <p>If Apache is handling <code>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</code> mod_status displays as follows: 182 </p> 183 184 <table class="bordered"> 185 <tr> 186 <th>Off (default)</th> 187 <td>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples</td> 188 </tr> 189 <tr> 190 <th>On</th> 191 <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</td> 192 </tr> 193 </table> 194 195 196</div> 197</div> 198<div class="bottomlang"> 199<p><span>Available Languages: </span><a href="/en/mod/mod_status.html" title="English"> en </a> | 200<a href="/ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 201<a href="/ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 202<a href="/tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p> 203</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 204<script type="text/javascript"><!--//--><![CDATA[//><!-- 205var comments_shortname = 'httpd'; 206var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_status.html'; 207(function(w, d) { 208 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 209 d.write('<div id="comments_thread"><\/div>'); 210 var s = d.createElement('script'); 211 s.type = 'text/javascript'; 212 s.async = true; 213 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 214 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 215 } 216 else { 217 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 218 } 219})(window, document); 220//--><!]]></script></div><div id="footer"> 221<p class="apache">Copyright 2013 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> 222<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 223if (typeof(prettyPrint) !== 'undefined') { 224 prettyPrint(); 225} 226//--><!]]></script> 227</body></html>
