Apache HTTP Server Version 2.2
Apache Module mod_status
| Description: | Provides information on server activity and performance |
|---|---|
| Status: | Base |
| Module Identifier: | status_module |
| Source File: | mod_status.c |
Summary
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.
The details given are:
- The number of worker serving requests
- The number of idle worker
- The status of each worker, the number of requests that worker has performed and the total number of bytes served by the worker (*)
- A total number of accesses and byte count served (*)
- The time the server was started/restarted and the time it has been running for
- Averages giving the number of requests per second, the number of bytes served per second and the average number of bytes per request (*)
- The current percentage CPU used by each worker and in total by Apache (*)
- The current hosts and requests being processed (*)
The lines marked "(*)" are only available if
ExtendedStatus
is On.
Enabling Status Support
To enable status reports only for browsers from the example.com
domain add this code to your httpd.conf
configuration file
<Location /server-status>
SetHandler server-status
Order Deny,Allow
Deny from all
Allow from .example.com
</Location>
You can now access server statistics by using a Web browser
to access the page
http://your.server.name/server-status
Automatic Updates
You can get the status page to update itself automatically if
you have a browser that supports "refresh". Access the page
http://your.server.name/server-status?refresh=N to
refresh the page every N seconds.
Machine Readable Status File
A machine-readable version of the status file is available by
accessing the page
http://your.server.name/server-status?auto. This
is useful when automatically run, see the Perl program in the
/support directory of Apache,
log_server_status.
mod_status is
compiled into the server, its handler capability is available
in all configuration files, including
per-directory files (e.g.,
.htaccess). This may have security-related
ramifications for your site.
ExtendedStatus Directive
| Description: | Keep track of extended status information for each request |
|---|---|
| Syntax: | ExtendedStatus On|Off |
| Default: | ExtendedStatus Off |
| Context: | server config |
| Status: | Base |
| Module: | mod_status |
| Compatibility: | ExtendedStatus is only available in Apache 1.3.2 and later. |
This setting applies to the entire server, and cannot be enabled or disabled on a virtualhost-by-virtualhost basis. The collection of extended status information can slow down the server.
SeeRequestTail Directive
| Description: | Determine if mod_status displays the first 63 characters of a request or the last 63, assuming the request itself is greater than 63 chars. |
|---|---|
| Syntax: | SeeRequestTail On|Off |
| Default: | SeeRequestTail Off |
| Context: | server config |
| Status: | Base |
| Module: | mod_status |
| Compatibility: | Available in Apache 2.2.7 and later. |
mod_status with ExtendedStatus On
displays the actual request being handled.
For historical purposes, only 63 characters of the request
are actually stored for display purposes. This directive
controls whether the 1st 63 characters are stored (the previous
behavior and the default) or if the last 63 characters are. This
is only applicable, of course, if the length of the request is
64 characters or greater.
If Apache is handling GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1 mod_status displays as follows:
| Off (default) | GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples |
|---|---|
| On | orage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1 |