The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Log::Dispatch::ApacheLog - Object for logging to Apache::Log objects

SYNOPSIS

  use Log::Dispatch::ApacheLog;

  my $handle = Log::Dispatch::ApacheLog->new( name      => 'apache log',
                                              min_level => 'emerg',
                                              apache    => $r );

  $handle->log( level => 'emerg', message => 'Kaboom' );

DESCRIPTION

This module allows you to pass messages Apache's log object, represented by the Apache::Log class.

METHODS

  • new(%p)

    This method takes a hash of parameters. The following options are valid:

    • name ($)

      The name of the object (not the filename!). Required.

    • min_level ($)

      The minimum logging level this object will accept. See the Log::Dispatch documentation for more information. Required.

    • max_level ($)

      The maximum logging level this obejct will accept. See the Log::Dispatch documentation for more information. This is not required. By default the maximum is the highest possible level (which means functionally that the object has no maximum).

    • apache ($)

      An object of either the Apache or Apache::Server classes.

    • callbacks( \& or [ \&, \&, ... ] )

      This parameter may be a single subroutine reference or an array reference of subroutine references. These callbacks will be called in the order they are given and passed a hash containing the following keys:

       ( message => $log_message, level => $log_level )

      The callbacks are expected to modify the message and then return a single scalar containing that modified message. These callbacks will be called when either the log or log_to methods are called and will only be applied to a given message once.

  • log_message( message => $ )

    Sends a message to the appropriate output. Generally this shouldn't be called directly but should be called through the log() method (in Log::Dispatch::Output).

AUTHOR

Dave Rolsky, <autarch@urth.org>