mod_status.xml revision 3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabc
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen<?xml-stylesheet type="text/xsl" href="/style/manual.xsl"?>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen<modulesynopsis>
7ed711d973b319320da100d3e905ef7b99ed69d6Timo Sirainen<compatibility>Available in Apache 1.1 and later</compatibility>
7ed711d973b319320da100d3e905ef7b99ed69d6Timo Sirainen<description>This module provides information on server activity and
381daab1e3b56a0bc94d2191cf62beba0df51af9Pascal Volkperformance.</description>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <strong>Warning:</strong> This document has not been updated
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen to take into account changes made in the 2.0 version of the
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen Apache HTTP Server. Some of the information may still be
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen relevant, but please use it with care.
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <p>The Status module allows a server administrator to find out
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen how well their server is performing. A HTML page is presented
678d0463849ba777106eb7875f27db07a5d8e3dfTimo Sirainen that gives the current server statistics in an easily readable
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen form. If required this page can be made to automatically
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen refresh (given a compatible browser). Another page gives a
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen simple machine-readable list of the current server state.</p>
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen <li>The number of children serving requests</li>
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen <li>The status of each child, the number of requests that
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen child has performed and the total number of bytes served by
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen the child (*)</li>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <li>A total number of accesses and byte count served (*)</li>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <li>The time the server was started/restarted and the time it
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen has been running for</li>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <li>Averages giving the number of requests per second, the
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen number of bytes served per second and the average number of
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen bytes per request (*)</li>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <li>The current percentage CPU used by each child and in
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen total by Apache (*)</li>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <li>The current hosts and requests being processed (*)</li>
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen A compile-time option must be used to display the details
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen marked "(*)" as the instrumentation required for obtaining
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen these statistics does not exist within standard Apache.
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen To enable status reports only for browsers from the foo.com
ffcf7f97c7d82b895bbb745031042ee8c378c6b6Timo Sirainen domain add this code to your <code>httpd.conf</code>
ffcf7f97c7d82b895bbb745031042ee8c378c6b6Timo Sirainen configuration file
e48f289d2e5b2546a2c5dcc90f7ab624cc58cca2Stephan Bosch <Location /server-status><br />
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen SetHandler server-status<br />
2fa41e3cd6393ce4b5f7e6f6048d7706aa93ac0dTimo Sirainen Order Deny,Allow<br />
2fa41e3cd6393ce4b5f7e6f6048d7706aa93ac0dTimo Sirainen Deny from all<br />
2fa41e3cd6393ce4b5f7e6f6048d7706aa93ac0dTimo Sirainen </Location>
2fa41e3cd6393ce4b5f7e6f6048d7706aa93ac0dTimo Sirainen <p>You can now access server statistics by using a Web browser
c93aca832ee532010ead91b85fa9f614132e1be2Stephan Bosch to access the page
c93aca832ee532010ead91b85fa9f614132e1be2Stephan Bosch <code>http://your.server.name/server-status</code></p>
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen <note><p>Note that <module>mod_status</module> will only work
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen when you are running Apache in <a
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen href="core.html#servertype">standalone</a> mode and not
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen <a href="core.html#servertype">inetd</a> mode.</p></note>
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen You can get the status page to update itself automatically if
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen you have a browser that supports "refresh". Access the page
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen <code>http://your.server.name/server-status?refresh=N</code> to
21ca7aedc1bf136d9e3f9a63aacfa77c7e9c6af0Timo Sirainen refresh the page every N seconds.
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen A machine-readable version of the status file is available by
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen accessing the page
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen <code>http://your.server.name/server-status?auto</code>. This
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen is useful when automatically run, see the Perl program in the
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <strong>It should be noted that if <module>mod_status</module> is
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen compiled into the server, its handler capability is available
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen in <em>all</em> configuration files, including
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen <code>.htaccess</code>). This may have security-related
c68ba18d99f3e4fead1e259b9dc50cb139e0b1c7Timo Sirainen ramifications for your site.</strong>
52ffa11d672a9bd150ae3e758a19f1cc4f01471bTimo Sirainen<directivesynopsis>
381daab1e3b56a0bc94d2191cf62beba0df51af9Pascal Volk<description>This directive controls whether the server keeps track of
381daab1e3b56a0bc94d2191cf62beba0df51af9Pascal Volkextended status information for each request. This is only
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomiuseful if the status module is enabled on the server.</description>
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomi<contextlist><context>server config</context></contextlist>
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomi<compatibility>ExtendedStatus is only available in Apache 1.3.2 and
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomilater.</compatibility>
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomi <p>This setting applies to the entire server, and cannot be
381daab1e3b56a0bc94d2191cf62beba0df51af9Pascal Volk enabled or disabled on a virtualhost-by-virtualhost basis.</p>
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomi</directivesynopsis>
a7fc192e2177fd869bca779e9f6014f7149cda2dAki Tuomi</modulesynopsis>