mod_status.xml revision 3e0c673f5399cfb820c3bb9f62dd746d21ba7d71
0d26a2bd71224b954baab529bbadc4d676c35b95slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
0d26a2bd71224b954baab529bbadc4d676c35b95slive<description>Provides information on server activity and
0d26a2bd71224b954baab529bbadc4d676c35b95sliveperformance</description>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>The Status module allows a server administrator to find out
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen how well their server is performing. A HTML page is presented
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen that gives the current server statistics in an easily readable
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen form. If required this page can be made to automatically
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen refresh (given a compatible browser). Another page gives a
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen simple machine-readable list of the current server state.</p>
3e0c673f5399cfb820c3bb9f62dd746d21ba7d71yoshiki <li>The status of each worker, the number of requests that
3e0c673f5399cfb820c3bb9f62dd746d21ba7d71yoshiki worker has performed and the total number of bytes served by
3e0c673f5399cfb820c3bb9f62dd746d21ba7d71yoshiki the worker (*)</li>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>A total number of accesses and byte count served (*)</li>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The time the server was started/restarted and the time it
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen has been running for</li>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>Averages giving the number of requests per second, the
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen number of bytes served per second and the average number of
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen bytes per request (*)</li>
3e0c673f5399cfb820c3bb9f62dd746d21ba7d71yoshiki <li>The current percentage CPU used by each worker and in
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen total by Apache (*)</li>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <li>The current hosts and requests being processed (*)</li>
0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>A compile-time option must be used to display the details
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen marked "(*)" as the instrumentation required for obtaining
0d26a2bd71224b954baab529bbadc4d676c35b95slive these statistics does not exist within standard Apache.</p>
0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>To enable status reports only for browsers from the foo.com
0d26a2bd71224b954baab529bbadc4d676c35b95slive configuration file</p>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <Location /server-status><br />
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen SetHandler server-status<br />
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Order Deny,Allow<br />
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen Deny from all<br />
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen </Location>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>You can now access server statistics by using a Web browser
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen to access the page
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>http://your.server.name/server-status</code></p>
0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>You can get the status page to update itself automatically if
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen you have a browser that supports "refresh". Access the page
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>http://your.server.name/server-status?refresh=N</code> to
0d26a2bd71224b954baab529bbadc4d676c35b95slive refresh the page every N seconds.</p>
0d26a2bd71224b954baab529bbadc4d676c35b95slive <p>A machine-readable version of the status file is available by
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen accessing the page
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>http://your.server.name/server-status?auto</code>. This
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen is useful when automatically run, see the Perl program in the
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <strong>It should be noted that if <module>mod_status</module> is
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen compiled into the server, its handler capability is available
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <code>.htaccess</code>). This may have security-related
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen ramifications for your site.</strong>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<directivesynopsis>
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive<description>Keep track of extended status information for each
15ba1801088da1aad6d20609cf3f7b0b1eefce8asliverequest</description>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<contextlist><context>server config</context></contextlist>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen<compatibility>ExtendedStatus is only available in Apache 1.3.2 and
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowenlater.</compatibility>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen <p>This setting applies to the entire server, and cannot be
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive enabled or disabled on a virtualhost-by-virtualhost basis.
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive The collection of extended status information can slow down
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive the server.</p>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</directivesynopsis>
3b40d219e6e756e68d1b7a4dd9489f9ef7bdbabcrbowen</modulesynopsis>