Module mod_status

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 children serving requests

The number of idle children

The status of each child, the number of requests that
child has performed and the total number of bytes served by
the child (*)

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 child and in
total by Apache (*)

Directives

Enabling Status Support

To enable status reports only for browsers from the foo.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 .foo.com
</Location>

You can now access server statistics by using a Web browser
to access the page
http://your.server.name/server-status

Alternatively, if you have lynx installed, you can
also get a server statics report from the command line by running
the command apachectl status, or, for the extended
status report, apachectl fullstatus. See the apachectl documentation for
additional details.

Note that mod_status will only work when you are running
Apache in standalone mode
and not inetd mode.

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.

It should be noted that if 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.