diff options
Diffstat (limited to 'usr.sbin/httpd/htdocs/manual/mod/mod_status.html')
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/mod/mod_status.html | 182 |
1 files changed, 120 insertions, 62 deletions
diff --git a/usr.sbin/httpd/htdocs/manual/mod/mod_status.html b/usr.sbin/httpd/htdocs/manual/mod/mod_status.html index f88c38c00b8..8cf0ae1a550 100644 --- a/usr.sbin/httpd/htdocs/manual/mod/mod_status.html +++ b/usr.sbin/httpd/htdocs/manual/mod/mod_status.html @@ -1,7 +1,9 @@ <!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) --> +<HTML> + <HEAD> + <TITLE>Apache module mod_status</TITLE> + </HEAD> +<!-- Background white, links blue (unvisited), navy (visited), red (active) --> <BODY BGCOLOR="#FFFFFF" TEXT="#000000" @@ -13,91 +15,105 @@ <DIV ALIGN="CENTER"> <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> <H3> - Apache HTTP Server Version 1.2 + Apache HTTP Server Version 1.3 </H3> </DIV> -<h1 ALIGN="CENTER">Module mod_status</h1> - -The Status Module is only available in Apache 1.1 and later.<p> - -<h2>Function</h2> - -The Status module allows a server administrator to find out how well +<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> +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 +<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 +<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, +<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 +<LI>The current percentage CPU used by each child and in total by Apache (*) -<li>The current hosts and requests being processed (*) +<LI>The current hosts and requests being processed (*) +</UL> + +<P>Details marked "(*)" are only available with +<CODE>ExtendedStatus On</CODE>. + +<h2>Directives</h2> + +<ul> +<li><a href="#extendedstatus">ExtendedStatus</a></li> </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>Enabling Status Support</h2> +<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> +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 + + Order Deny,Allow + Deny from all + Allow from .foo.com </Location> -</pre> -<p> +</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 +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> +<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> +<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>. - -<h2>Full Instrumentation</h2> - -To obtain full statistics you must compile Apache with a special -directive. On some machines there may be a small performance loss -if you do this. Try full statistics and see if you notice any -difference. If you do please contact <a href="mailto:mark@ukweb.com"> -mark@ukweb.com</a> and tell me your configuration. - -<p> - -Do this by adding the following to the AUX_CFLAGS line in the -"Configuration" file and then recompiling as usual. -<pre> - AUX_CFLAGS= (something) -DSTATUS -</pre> +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> @@ -108,9 +124,51 @@ Do this by adding the following to the AUX_CFLAGS line in the 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 <EM>On|Off</EM><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> + <HR> + <H3 ALIGN="CENTER"> - Apache HTTP Server Version 1.2 + Apache HTTP Server Version 1.3 </H3> <A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> |