mod_status.xml revision d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacd
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen Copyright 2002-2004 Apache Software Foundation
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen Licensed under the Apache License, Version 2.0 (the "License");
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen you may not use this file except in compliance with the License.
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen You may obtain a copy of the License at
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen Unless required by applicable law or agreed to in writing, software
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen distributed under the License is distributed on an "AS IS" BASIS,
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen See the License for the specific language governing permissions and
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen limitations under the License.
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<modulesynopsis metafile="mod_status.xml.meta">
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<description>Provides information on server activity and
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainenperformance</description>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>The Status module allows a server administrator to find out
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen how well their server is performing. A HTML page is presented
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen that gives the current server statistics in an easily readable
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen form. If required this page can be made to automatically
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen refresh (given a compatible browser). Another page gives a
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen simple machine-readable list of the current server state.</p>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <li>The number of worker serving requests</li>
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen <li>The status of each worker, the number of requests that
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen worker has performed and the total number of bytes served by
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen the worker (*)</li>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <li>A total number of accesses and byte count served (*)</li>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <li>The time the server was started/restarted and the time it
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen has been running for</li>
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen <li>Averages giving the number of requests per second, the
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen number of bytes served per second and the average number of
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen bytes per request (*)</li>
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen <li>The current percentage CPU used by each worker and in
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen total by Apache (*)</li>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <li>The current hosts and requests being processed (*)</li>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>A compile-time option must be used to display the details
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen marked "(*)" as the instrumentation required for obtaining
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen these statistics does not exist within standard Apache.</p>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>To enable status reports only for browsers from the foo.com
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen domain add this code to your <code>httpd.conf</code>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen configuration file</p>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <Location /server-status><br />
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen SetHandler server-status<br />
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen Order Deny,Allow<br />
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen Deny from all<br />
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen </Location>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>You can now access server statistics by using a Web browser
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen to access the page
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <code>http://your.server.name/server-status</code></p>
529dc11f24090a1f8d273c81a5118a359e5b2346Timo Sirainen <p>You can get the status page to update itself automatically if
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen you have a browser that supports "refresh". Access the page
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <code>http://your.server.name/server-status?refresh=N</code> to
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen refresh the page every N seconds.</p>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>A machine-readable version of the status file is available by
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen accessing the page
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <code>http://your.server.name/server-status?auto</code>. This
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen is useful when automatically run, see the Perl program in the
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <strong>It should be noted that if <module>mod_status</module> is
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen compiled into the server, its handler capability is available
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen in <em>all</em> configuration files, including
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <code>.htaccess</code>). This may have security-related
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen ramifications for your site.</strong>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<directivesynopsis>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<description>Keep track of extended status information for each
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainenrequest</description>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<contextlist><context>server config</context></contextlist>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen<compatibility>ExtendedStatus is only available in Apache 1.3.2 and
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainenlater.</compatibility>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen <p>This setting applies to the entire server, and cannot be
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen enabled or disabled on a virtualhost-by-virtualhost basis.
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen The collection of extended status information can slow down
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen the server.</p>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen</directivesynopsis>
447e086422f1ab7cc16833583ed70a4af7a84bc5Timo Sirainen</modulesynopsis>