summaryrefslogtreecommitdiff
path: root/docs/manual/mod/mod_status.html.en
diff options
context:
space:
mode:
authorJoshua Slive <slive@apache.org>2002-05-23 14:23:51 +0000
committerJoshua Slive <slive@apache.org>2002-05-23 14:23:51 +0000
commit700dc34d7c5ebc8c847d38671c70ded3f9a56a1e (patch)
treee61383e7c4f09556afa12321b88ccaa006f7202e /docs/manual/mod/mod_status.html.en
parentdc4ff3c1c7a35ce49f0ba036ea298242976044af (diff)
downloadhttpd-700dc34d7c5ebc8c847d38671c70ded3f9a56a1e.tar.gz
No change here except the filename extensions. Sorry for the massic commit.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95240 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_status.html.en')
-rw-r--r--docs/manual/mod/mod_status.html.en107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/manual/mod/mod_status.html.en b/docs/manual/mod/mod_status.html.en
new file mode 100644
index 0000000000..aa7bf37f10
--- /dev/null
+++ b/docs/manual/mod/mod_status.html.en
@@ -0,0 +1,107 @@
+<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ --><title>mod_status- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_status</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides information on server activity and
+performance</td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>status_module</td></tr></table></td></tr></table><h2>Summary</h2>
+
+<blockquote><table><tr><td bgcolor="#e0e5f5">
+ <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.
+</td></tr></table></blockquote>
+
+ <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:</p>
+
+ <ul>
+ <li>The number of children serving requests</li>
+
+ <li>The number of idle children</li>
+
+ <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>
+
+ <li>A total number of accesses and byte count served (*)</li>
+
+ <li>The time the server was started/restarted and the time it
+ has been running for</li>
+
+ <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>
+
+ <li>The current percentage CPU used by each child and in
+ total by Apache (*)</li>
+
+ <li>The current hosts and requests being processed (*)</li>
+ </ul>
+
+ <p>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.</p>
+<h2>Directives</h2><ul><li><a href="#extendedstatus">ExtendedStatus</a></li></ul><h2>Enabling Status Support</h2>
+
+
+ <p>To enable status reports only for browsers from the foo.com
+ domain add this code to your <code>httpd.conf</code>
+ configuration file</p>
+<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
+ &lt;Location /server-status&gt;<br>
+ SetHandler server-status<br>
+<br>
+ Order Deny,Allow<br>
+ Deny from all<br>
+ Allow from .foo.com<br>
+ &lt;/Location&gt;
+</code></td></tr></table></blockquote>
+
+ <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>
+
+ <blockquote><table><tr><td bgcolor="#e0e5f5"><p>Note that <code><a href="mod_status.html">mod_status</a></code> 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.</p></td></tr></table></blockquote>
+<h2>Automatic Updates</h2>
+
+
+ <p>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.</p>
+
+<h2>Machine Readable Status File</h2>
+
+
+ <p>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>.</p>
+
+ <blockquote><table><tr><td bgcolor="#e0e5f5">
+ <strong>It should be noted that if <code><a href="mod_status.html">mod_status</a></code> 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>,
+ <code>.htaccess</code>). This may have security-related
+ ramifications for your site.</strong>
+ </td></tr></table></blockquote>
+
+<hr/><h2><a name="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>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.</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>ExtendedStatus On|Off</td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ExtendedStatus Off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_status</td></tr><tr><td align="left" valign="top"><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>ExtendedStatus is only available in Apache 1.3.2 and
+later.</td></tr></table></td></tr></table>
+ <p>This setting applies to the entire server, and cannot be
+ enabled or disabled on a virtualhost-by-virtualhost basis.</p>
+<hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="../images/index.gif" alt="Index"/></a><a href="../"><img src="../images/home.gif" alt="Home"/></a></body></html> \ No newline at end of file