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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_status - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <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" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <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.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_status</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" title="English"> en </a> |
30 <a href="../es/mod/mod_status.html" hreflang="es" rel="alternate" title="Español"> es </a> |
31 <a href="../fr/mod/mod_status.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
32 <a href="../ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
33 <a href="../ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
34 <a href="../tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
36 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides information on server activity and
38 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
39 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>status_module</td></tr>
40 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_status.c</td></tr></table>
43 <p>The Status module allows a server administrator to find out
44 how well their server is performing. A HTML page is presented
45 that gives the current server statistics in an easily readable
46 form. If required this page can be made to automatically
47 refresh (given a compatible browser). Another page gives a
48 simple machine-readable list of the current server state.</p>
50 <p>The details given are:</p>
53 <li>The number of worker serving requests</li>
55 <li>The number of idle worker</li>
57 <li>The status of each worker, the number of requests that
58 worker has performed and the total number of bytes served by
61 <li>A total number of accesses and byte count served (*)</li>
63 <li>The time the server was started/restarted and the time it
64 has been running for</li>
66 <li>Averages giving the number of requests per second, the
67 number of bytes served per second and the average number of
68 bytes per request (*)</li>
70 <li>The current percentage CPU used by each worker and in
71 total by all workers combined (*)</li>
73 <li>The current hosts and requests being processed (*)</li>
76 <p>The lines marked "(*)" are only available if
77 <code class="directive"><a href="../mod/core.html#extendedstatus">ExtendedStatus</a></code>
78 is <code>On</code>. In version 2.3.6, loading mod_status will
79 toggle <code class="directive"><a href="../mod/core.html#extendedstatus">ExtendedStatus</a></code> On
83 <strong>It should be noted that if <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> is
84 loaded into the server, its handler capability is available
85 in <em>all</em> configuration files, including
86 <em>per</em>-directory files (<em>e.g.</em>,
87 <code>.htaccess</code>). This may have security-related
88 ramifications for your site.</strong>
92 <div id="quickview"><h3>Topics</h3>
94 <li><img alt="" src="../images/down.gif" /> <a href="#enable">Enabling Status Support</a></li>
95 <li><img alt="" src="../images/down.gif" /> <a href="#autoupdate">Automatic Updates</a></li>
96 <li><img alt="" src="../images/down.gif" /> <a href="#machinereadable">Machine Readable Status File</a></li>
97 <li><img alt="" src="../images/down.gif" /> <a href="#troubleshoot">Using server-status to troubleshoot</a></li>
98 </ul><h3 class="directives">Directives</h3>
99 <p>This module provides no
101 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_status">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_status">Report a bug</a></li></ul><h3>See also</h3>
103 <li><a href="#comments_section">Comments</a></li></ul></div>
104 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
105 <div class="section">
106 <h2><a name="enable" id="enable">Enabling Status Support</a><a title="Permanent link" href="#enable" class="permalink">¶</a></h2>
109 <p>To enable status reports only for browsers from the example.com
110 domain add this code to your <code>httpd.conf</code>
111 configuration file</p>
112 <pre class="prettyprint lang-config"><Location "/server-status">
113 SetHandler server-status
114 Require host example.com
115 </Location></pre>
118 <p>You can now access server statistics by using a Web browser
120 <code>http://your.server.name/server-status</code></p>
121 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
122 <div class="section">
123 <h2><a name="autoupdate" id="autoupdate">Automatic Updates</a><a title="Permanent link" href="#autoupdate" class="permalink">¶</a></h2>
126 <p>You can get the status page to update itself automatically if
127 you have a browser that supports "refresh". Access the page
128 <code>http://your.server.name/server-status?refresh=N</code> to
129 refresh the page every N seconds.</p>
131 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
132 <div class="section">
133 <h2><a name="machinereadable" id="machinereadable">Machine Readable Status File</a><a title="Permanent link" href="#machinereadable" class="permalink">¶</a></h2>
136 <p>A machine-readable version of the status file is available by
138 <code>http://your.server.name/server-status?auto</code>. This
139 is useful when automatically run, see the Perl program
140 <code>log_server_status</code>, which you will find in the
141 <code>/support</code> directory of your Apache HTTP Server installation.</p>
143 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
144 <div class="section">
145 <h2><a name="troubleshoot" id="troubleshoot">Using server-status to troubleshoot</a><a title="Permanent link" href="#troubleshoot" class="permalink">¶</a></h2>
148 <p>The <code>server-status</code> page may be used as a starting
149 place for troubleshooting a situation where your server is consuming
150 all available resources (CPU or memory), and you wish to identify
151 which requests or clients are causing the problem.</p>
153 <p>First, ensure that you have <code class="directive"><a href="../mod/core.html#extendedstatus">ExtendedStatus</a></code> set on, so that you can see
154 the full request and client information for each child or
157 <p>Now look in your process list (using <code>top</code>, or similar
158 process viewing utility) to identify the specific processes that are
159 the main culprits. Order the output of <code>top</code> by CPU
160 usage, or memory usage, depending on what problem you're trying to
163 <p>Reload the <code>server-status</code> page, and look for those process
164 ids, and you'll be able to see what request is being served by that
165 process, for what client. Requests are transient, so you may need to
166 try several times before you catch it in the act, so to speak.</p>
168 <p>This process <em>should</em> give you some idea what client, or
169 what type of requests, are primarily responsible for your load
170 problems. Often you will identify a particular web application that
171 is misbehaving, or a particular client that is attacking your
176 <div class="bottomlang">
177 <p><span>Available Languages: </span><a href="../en/mod/mod_status.html" title="English"> en </a> |
178 <a href="../es/mod/mod_status.html" hreflang="es" rel="alternate" title="Español"> es </a> |
179 <a href="../fr/mod/mod_status.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
180 <a href="../ja/mod/mod_status.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
181 <a href="../ko/mod/mod_status.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
182 <a href="../tr/mod/mod_status.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
183 </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>
184 <script type="text/javascript"><!--//--><![CDATA[//><!--
185 var comments_shortname = 'httpd';
186 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_status.html';
188 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
189 d.write('<div id="comments_thread"><\/div>');
190 var s = d.createElement('script');
191 s.type = 'text/javascript';
193 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
194 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
197 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
199 })(window, document);
200 //--><!]]></script></div><div id="footer">
201 <p class="apache">Copyright 2018 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>
202 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
203 if (typeof(prettyPrint) !== 'undefined') {