
---- mod_log_access ----------------------------------------------- 1.03 ----

SYNOPSIS

    an Apache 2.2.x module providing 
      * custom log formats
      * conditional logging (requires mod_setenvif)
      * rotation of both log files
      * update of symlinks to rotated log files


PREREQUISITES

    Apache 2.2.x installation, running on a UNIX operating system.


BUILDING & INSTALLATION

    Edit Makefile, so that APACHE_PREFIX and APACHE_VERSION are correct for
    your installation.

    Run "make" and "make install".  "make help" shows the targets.


CONFIGURATION

    Add this line in your configuration, somewhere near the start.  Replace
    /some/where/ with the httpd installation directory.

        LoadModule log_access_module    /some/where/lib/mod_log_access.so

    Remove any LoadModule lines for log_config_module.


DIRECTIVES

    LogFormat <FORMAT> [<FORMAT_NAME>]
        set default format for log files.
        define a log format called FORMAT called FORMAT_NAME

    AccessLog <FILENAME> [symlink=<LINKNAME>] [format=<FORMAT>|<FORMAT_NAME>] [<CONDITION>]
        Log to file FILENAME with format FORMAT.
        FILENAME may be in strftime(3) format.
        FILENAME may start with a '|' character, meaning that a pipe
        LINKNAME is a symbolic link to the latest incarnation of FILENAME.
        LINKNAME may contain strftime(3) escape characters.
        If CONDITION is set, events are only logged if CONDITION evaluates to true.
        CONDITION is recognised as such by the presence of an '=' character.
        If no AccessLog is given, no logging is done.

    TransferLog <FILENAME> [<LINKNAME>]
        Log transfers to FILENAME in CLF log format, unless a custom format
        is set with LogFormat.  FILENAME may be in strftime(3) format, though
        this is not backwards compatible.  If set, LINKNAME is a symbolic link
        to the latest incarnation of FILENAME.  LINKNAME may contain 
        strftime(3) escape characters, in which case it too is rotated. LINKNAME
        may not rotate more often than FILENAME.

    CookieLog <FILENAME>
        For backwards compatability with old Cookie logging module -- deprecated.

    ClfTimestamps On|Off
        CLF demands that the time for every request is logged exactly when the
        request is made, not for the original request.  Default setting is Off.


NOTES

    There may be any number of TransferLog and AccessLog commands.  Each
    request is logged to ALL the named files, in the appropriate format.

    If no TransferLog or AccessLog directives appear in a VirtualHost, the
    request is logged to the log file(s) defined outside the VirtualHost
    section.

    If a TransferLog or AccessLog directive appears in a VirtualHost section,
    the log files defined outside the VirtualHost are not used.

    This module is compatible with the CLF and config log modules, where the
    use of TransferLog inside the VirtualHost section overrides its use outside.


FILES

    ${APACHE_PREFIX}/httpd-${APACHE_VERSION}/lib/mod_log_access.so
        module shared object


SEE ALSO

    http://www.gjvc.com/software/apache/modules/


AUTHOR

    George Cox <gjvc+apache@extremis.net>


CREDITS

    Andrew Ford <a.ford@ford-mason.co.uk>
    David MacKenzie <djm@va.pubnix.com>
    Roger Beeman <beeman@cisco.com>


-- 
$Source: /home/gjvc/rnd/apache/modules/mod_log_access/mod_log_access-CURRENT/RCS/README,v $
$Id: README,v 1.6 2007/01/21 23:24:11 gjvc Exp $
