METHODS

Constructors

$obj->close
See close in Log::Report::Dispatcher.
$class->new( TYPE, NAME, OPTIONS )

The Log::Log4perl infrastructure has all settings in a configuration file. In that file, you should find a category with the NAME.

Option Defined in Default

accept

Log::Report::Dispatcher

'ALL'

charset

Log::Report::Dispatcher

<undef>

config

<required>

format_reason

Log::Report::Dispatcher

'LOWERCASE'

locale

Log::Report::Dispatcher

<system locale>

mode

Log::Report::Dispatcher

'NORMAL'

to_level

[]

accept => REASONS
charset => CHARSET
config => FILENAME|SCALAR
When a SCALAR reference is passed in, that must refer to a string which contains the configuration text. Otherwise, specify an existing FILENAME.
format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE
locale => LOCALE
mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3
to_level => ARRAY-of-PAIRS
See reasonToLevel().

Accessors

$obj->isDisabled
See isDisabled in Log::Report::Dispatcher.
$obj->logger( [DOMAIN] )

Returns the Log::Log4perl::Logger object which is used for logging. When there is no specific logger for this DOMAIN (logger with the exact name of the DOMAIN) the default logger is being used, with the name of this dispatcher.

$obj->mode
See mode in Log::Report::Dispatcher.
$obj->name
See name in Log::Report::Dispatcher.
$obj->needs( [REASON] )
See needs in Log::Report::Dispatcher.
$obj->type
See type in Log::Report::Dispatcher.

Logging

$obj->collectLocation
$class->collectLocation
See collectLocation in Log::Report::Dispatcher.
$obj->collectStack( [MAXDEPTH] )
$class->collectStack( [MAXDEPTH] )
See collectStack in Log::Report::Dispatcher.
$obj->log( HASH-of-OPTIONS, REASON, MESSAGE, DOMAIN )
See log in Log::Report::Dispatcher.
$obj->reasonToLevel( REASON )

Returns a level which is understood by Log::Dispatch, based on a translation table. This can be changed with new(to_level).

» Example:
 use Log::Log4perl     qw/:levels/;

 # by default, ALERTs are output as $FATAL
 dispatcher Log::Log4perl => 'logger'
   , to_level => [ ALERT => $ERROR, ]
   , ...;
$obj->stackTraceLine( OPTIONS )
$class->stackTraceLine( OPTIONS )
See stackTraceLine in Log::Report::Dispatcher.
$obj->translate( HASH-of-OPTIONS, REASON, MESSAGE )
See translate in Log::Report::Dispatcher.