.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Log::Report::Dispatcher::Log4perl 3"
.TH Log::Report::Dispatcher::Log4perl 3 2025-12-12 "perl v5.42.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Log::Report::Dispatcher::Log4perl \- send messages to Log::Log4perl back\-end
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Dispatcher::Log4perl
\&   is a Log::Report::Dispatcher
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&  # start using log4perl via a config file
\&  # The name of the dispatcher is the name of the default category.
\&  dispatcher LOG4PERL => \*(Aqlogger\*(Aq,
\&    accept => \*(AqNOTICE\-\*(Aq,
\&    config => "$ENV{HOME}/.log.conf";
\&
\&  # disable default dispatcher
\&  dispatcher close => \*(Aqlogger\*(Aq;
\&
\&  # configuration inline, not in file: adapted from the Log4perl manpage
\&  my $name    = \*(Aqlogger\*(Aq;
\&  my $outfile = \*(Aq/tmp/a.log\*(Aq;
\&  my $config  = <<_\|_CONFIG;
\&  log4perl.category.$name            = INFO, Logfile
\&  log4perl.logger.Logfile          = Log::Log4perl::Appender::File
\&  log4perl.logger.Logfile.filename = $outfn
\&  log4perl.logger.Logfile.layout   = Log::Log4perl::Layout::PatternLayout
\&  log4perl.logger.Logfile.layout.ConversionPattern = %d %F{1} %L> %m
\&  _\|_CONFIG
\&
\&  dispatcher LOG4PERL => $name, config => \e$config;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This dispatchers produces output tot syslog, based on the \f(CW\*(C`Sys::Log4perl\*(C'\fR
module (which will not be automatically installed for you).
.PP
Extends "DESCRIPTION" in Log::Report::Dispatcher.
.SS "Reasons <\-\-> Levels"
.IX Subsection "Reasons <--> Levels"
The REASONs for a message in Log::Report are names quite similar to
the log levels used by Log::Log4perl.  The default mapping is list
below.  You can change the mapping using new(to_level).
.PP
.Vb 6
\&  TRACE   => $DEBUG    ERROR   => $ERROR
\&  ASSERT  => $DEBUG    FAULT   => $ERROR
\&  INFO    => $INFO     ALERT   => $FATAL
\&  NOTICE  => $INFO     FAILURE => $FATAL
\&  WARNING => $WARN     PANIC   => $FATAL
\&  MISTAKE => $WARN
.Ve
.SS Categories
.IX Subsection "Categories"
\&\f(CW\*(C`Log::Report\*(C'\fR uses text\-domains for translation tables.  These are
also used as categories for the Log4perl infrastructure.  So, typically
every module start with:
.PP
.Vb 1
\&  use Log::Report \*(Aqmy\-text\-domain\*(Aq, %more_options;
.Ve
.PP
Now, if there is a logger inside the log4perl configuration which is
named \*(Aqmy\-text\-domain\*(Aq, that will be used.  Otherwise, the name of the
dispatcher is used to select the logger.
.PP
\fILimitiations\fR
.IX Subsection "Limitiations"
.PP
The global \f(CW$caller_depth\fR concept of Log::Log4perl is broken.
That variable is used to find the filename and line number of the logged
messages.  But these messages may have been caught, rerouted, eval\*(Aqed, and
otherwise followed a unpredictable multi\-leveled path before it reached
the Log::Log4perl dispatcher.  This means that layout patterns \f(CW%F\fR
and \f(CW%L\fR are not useful in the generic case, maybe in your specific case.
.SH METHODS
.IX Header "METHODS"
Extends "METHODS" in Log::Report::Dispatcher.
.SS Constructors
.IX Subsection "Constructors"
Extends "Constructors" in Log::Report::Dispatcher.
.ie n .IP "$class\->\fBnew\fR($type, $name, %options)" 4
.el .IP "\f(CW$class\fR\->\fBnew\fR($type, \f(CW$name\fR, \f(CW%options\fR)" 4
.IX Item "$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 \f(CW$name\fR.
Improves base, see "Constructors" in Log::Report::Dispatcher
.Sp
.Vb 8
\& \-Option       \-\-Defined in             \-\-Default
\&  accept         Log::Report::Dispatcher  \*(AqALL\*(Aq
\&  charset        Log::Report::Dispatcher  undef
\&  config                                  <C<undef>>
\&  format_reason  Log::Report::Dispatcher  \*(AqLOWERCASE\*(Aq
\&  locale         Log::Report::Dispatcher  <system locale>
\&  mode           Log::Report::Dispatcher  \*(AqNORMAL\*(Aq
\&  to_level                                []
.Ve
.RS 4
.ie n .IP "accept => $reasons|\e@reasons" 2
.el .IP "accept => \f(CW$reasons\fR|\e@reasons" 2
.IX Item "accept => $reasons|@reasons"
.PD 0
.IP "charset => CHARSET" 2
.IX Item "charset => CHARSET"
.IP "config => FILENAME|SCALAR" 2
.IX Item "config => FILENAME|SCALAR"
.PD
When a SCALAR reference is passed in, that must refer to a string which
contains the configuration text.  Otherwise, specify an existing FILENAME.
.Sp
By default, it is expected that Log::Log4perl has been initialized
externally.  That module uses global variables to communicate, which
should be present before any logging is attempted.
.IP "format_reason => \*(AqUPPERCASE\*(Aq|\*(AqLOWERCASE\*(Aq|\*(AqUCFIRST\*(Aq|\*(AqIGNORE\*(Aq|CODE" 2
.IX Item "format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE"
.PD 0
.IP "locale => LOCALE" 2
.IX Item "locale => LOCALE"
.IP "mode => \*(AqNORMAL\*(Aq|\*(AqVERBOSE\*(Aq|\*(AqASSERT\*(Aq|\*(AqDEBUG\*(Aq|0..3" 2
.IX Item "mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3"
.IP "to_level => ARRAY\-of\-PAIRS" 2
.IX Item "to_level => ARRAY-of-PAIRS"
.PD
See \fBreasonToLevel()\fR.
.RE
.RS 4
.RE
.SS Accessors
.IX Subsection "Accessors"
Extends "Accessors" in Log::Report::Dispatcher.
.ie n .IP $obj\->\fBisDisabled\fR() 4
.el .IP \f(CW$obj\fR\->\fBisDisabled\fR() 4
.IX Item "$obj->isDisabled()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBlogger\fR( [$domain] )" 4
.el .IP "\f(CW$obj\fR\->\fBlogger\fR( [$domain] )" 4
.IX Item "$obj->logger( [$domain] )"
Returns the Log::Log4perl::Logger object which is used for logging.
When there is no specific logger for this \f(CW$domain\fR (logger with the exact
name of the \f(CW$domain\fR) the default logger is being used, with the name of
this dispatcher.
.ie n .IP $obj\->\fBmode\fR() 4
.el .IP \f(CW$obj\fR\->\fBmode\fR() 4
.IX Item "$obj->mode()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBname\fR() 4
.el .IP \f(CW$obj\fR\->\fBname\fR() 4
.IX Item "$obj->name()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBneeds\fR( [$reason] )" 4
.el .IP "\f(CW$obj\fR\->\fBneeds\fR( [$reason] )" 4
.IX Item "$obj->needs( [$reason] )"
Inherited, see "Accessors" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBtype\fR() 4
.el .IP \f(CW$obj\fR\->\fBtype\fR() 4
.IX Item "$obj->type()"
Inherited, see "Accessors" in Log::Report::Dispatcher
.SS Logging
.IX Subsection "Logging"
Extends "Logging" in Log::Report::Dispatcher.
.ie n .IP $any\->\fBaddSkipStack\fR(@CODE) 4
.el .IP \f(CW$any\fR\->\fBaddSkipStack\fR(@CODE) 4
.IX Item "$any->addSkipStack(@CODE)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBclose\fR() 4
.el .IP \f(CW$obj\fR\->\fBclose\fR() 4
.IX Item "$obj->close()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBcollectLocation\fR() 4
.el .IP \f(CW$any\fR\->\fBcollectLocation\fR() 4
.IX Item "$any->collectLocation()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$any\->\fBcollectStack\fR( [$maxdepth] )" 4
.el .IP "\f(CW$any\fR\->\fBcollectStack\fR( [$maxdepth] )" 4
.IX Item "$any->collectStack( [$maxdepth] )"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBlog\fR(\e%options, $reason, $message, $domain)" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR, \f(CW$domain\fR)" 4
.IX Item "$obj->log(%options, $reason, $message, $domain)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $obj\->\fBreasonToLevel\fR($reason) 4
.el .IP \f(CW$obj\fR\->\fBreasonToLevel\fR($reason) 4
.IX Item "$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).
.Sp
» example:
.Sp
.Vb 1
\&  use Log::Log4perl     qw/:levels/;
\&
\&  # by default, ALERTs are output as $FATAL
\&  dispatcher Log::Log4perl => \*(Aqlogger\*(Aq,
\&    to_level => [ ALERT => $ERROR, ],
\&    ...;
.Ve
.ie n .IP $obj\->\fBskipStack\fR() 4
.el .IP \f(CW$obj\fR\->\fBskipStack\fR() 4
.IX Item "$obj->skipStack()"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP $any\->\fBstackTraceLine\fR(%options) 4
.el .IP \f(CW$any\fR\->\fBstackTraceLine\fR(%options) 4
.IX Item "$any->stackTraceLine(%options)"
Inherited, see "Logging" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBtranslate\fR(\e%options, $reason, $message)" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR(\e%options, \f(CW$reason\fR, \f(CW$message\fR)" 4
.IX Item "$obj->translate(%options, $reason, $message)"
Inherited, see "Logging" in Log::Report::Dispatcher
.SH DETAILS
.IX Header "DETAILS"
Extends "DETAILS" in Log::Report::Dispatcher.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
.IP "Error: Log4perl level \*(Aq$level\*(Aq must be in 0\-5" 4
.IX Item "Error: Log4perl level '$level' must be in 0-5"
Cast by \f(CWnew()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log\-Report version 1.43,
built on December 05, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH LICENSE
.IX Header "LICENSE"
For contributors see file ChangeLog.
.PP
This software is copyright (c) 2007\-2025 by Mark Overmeer.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.