mirror of
https://github.com/apache/httpd.git
synced 2025-10-31 19:10:37 +03:00
3404634c64
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87505 13f79535-47bb-0310-9956-ffa450edef68
174 lines
5.1 KiB
HTML
174 lines
5.1 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Apache module mod_status</TITLE>
|
|
</HEAD>
|
|
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
|
|
<BODY
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#000080"
|
|
ALINK="#FF0000"
|
|
>
|
|
|
|
<!--#include virtual="header.html" -->
|
|
|
|
<blockquote><strong>Warning:</strong>
|
|
This document has not been updated to take into account changes
|
|
made in the 2.0 version of the Apache HTTP Server. Some of the
|
|
information may still be relevant, but please use it
|
|
with care.
|
|
</blockquote>
|
|
|
|
<H1 ALIGN="CENTER">Module mod_status</H1>
|
|
|
|
<p>This module provides information on server activity and
|
|
performance.</p>
|
|
|
|
<P><A
|
|
HREF="module-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base
|
|
<BR>
|
|
<A
|
|
HREF="module-dict.html#SourceFile"
|
|
REL="Help"
|
|
><STRONG>Source File:</STRONG></A> mod_status.c
|
|
<BR>
|
|
<A
|
|
HREF="module-dict.html#ModuleIdentifier"
|
|
REL="Help"
|
|
><STRONG>Module Identifier:</STRONG></A> status_module
|
|
<BR>
|
|
<A
|
|
HREF="module-dict.html#Compatibility"
|
|
REL="Help"
|
|
><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
|
|
</P>
|
|
|
|
|
|
<H2>Summary</H2>
|
|
|
|
<p>The Status module allows a server administrator to find out how well
|
|
their server is performing. A HTML page is presented that gives
|
|
the current server statistics in an easily readable form. If required
|
|
this page can be made to automatically refresh (given a compatible
|
|
browser). Another page gives a simple machine-readable list of the current
|
|
server state.</p>
|
|
|
|
<P>
|
|
The details given are:
|
|
<UL>
|
|
<LI>The number of children serving requests
|
|
<LI>The number of idle children
|
|
<LI>The status of each child, the number of requests that child has
|
|
performed and the total number of bytes served by the child (*)
|
|
<LI>A total number of accesses and byte count served (*)
|
|
<LI>The time the server was started/restarted and the
|
|
time it has been running for
|
|
<LI>Averages giving the number of requests per second,
|
|
the number of bytes served per second and the average number
|
|
of bytes per request (*)
|
|
<LI>The current percentage CPU used by each child and in total by
|
|
Apache (*)
|
|
<LI>The current hosts and requests being processed (*)
|
|
</UL>
|
|
|
|
A compile-time option must be used to display the details marked "(*)" as
|
|
the instrumentation required for obtaining these statistics does not
|
|
exist within standard Apache.
|
|
|
|
<h2>Directives</h2>
|
|
|
|
<ul>
|
|
<li><a href="#extendedstatus">ExtendedStatus</a></li>
|
|
</ul>
|
|
|
|
|
|
<H2>Enabling Status Support</H2>
|
|
|
|
To enable status reports only for browsers from the foo.com
|
|
domain add this code to your <CODE>access.conf</CODE> configuration file
|
|
<PRE>
|
|
<Location /server-status>
|
|
SetHandler server-status
|
|
|
|
Order Deny,Allow
|
|
Deny from all
|
|
Allow from .foo.com
|
|
</Location>
|
|
</PRE>
|
|
<P>
|
|
You can now access server statistics by using a Web browser to access the
|
|
page <CODE>http://your.server.name/server-status</CODE>
|
|
<P>
|
|
Note that mod_status will only work when you are running Apache in
|
|
<A HREF="core.html#servertype">standalone</A> mode and not
|
|
<A HREF="core.html#servertype">inetd</A> mode.
|
|
|
|
<H3>Automatic Updates</H3>
|
|
You can get the status page to update itself automatically if you have
|
|
a browser that supports "refresh". Access the page
|
|
<CODE>http://your.server.name/server-status?refresh=N</CODE> to refresh the
|
|
page every N seconds.
|
|
<H3>Machine Readable Status File</H3>
|
|
A machine-readable version of the status file is available by accessing the
|
|
page <CODE>http://your.server.name/server-status?auto</CODE>. This is useful
|
|
when automatically run, see the Perl program in the <CODE>/support</CODE>
|
|
directory of Apache, <CODE>log_server_status</CODE>.
|
|
|
|
<BLOCKQUOTE>
|
|
<STRONG>
|
|
It should be noted that if <SAMP>mod_status</SAMP> is compiled into
|
|
the server, its handler capability is available in <EM>all</EM>
|
|
configuration files, including <EM>per</EM>-directory files
|
|
(<EM>e.g.</EM>, <SAMP>.htaccess</SAMP>). This may have
|
|
security-related ramifications for your site.
|
|
</STRONG>
|
|
</BLOCKQUOTE>
|
|
|
|
<hr>
|
|
|
|
<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
|
|
<!--%plaintext <?INDEX {\tt ExtendedStatus} directive> -->
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> ExtendedStatus On|Off<BR>
|
|
<A
|
|
HREF="directive-dict.html#Default"
|
|
REL="Help"
|
|
><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config <BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_status<BR>
|
|
<A
|
|
HREF="directive-dict.html#Compatibility"
|
|
REL="Help"
|
|
><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
|
|
in Apache 1.3.2 and later.
|
|
|
|
<P>
|
|
This directive controls whether the server keeps track of extended
|
|
status information for each request. This is only useful if the status module
|
|
is enabled on the server.
|
|
</P>
|
|
<P>
|
|
This setting applies to the entire server, and cannot be enabled or
|
|
disabled on a virtualhost-by-virtualhost basis.
|
|
</P>
|
|
|
|
<!--#include virtual="footer.html" -->
|
|
</BODY>
|
|
</HTML>
|