.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\" ========================================================================
.\"
.IX Title "Log::Report::Dispatcher::Syslog 3pm"
.TH Log::Report::Dispatcher::Syslog 3pm "2023-10-29" "perl v5.36.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::Syslog \- send messages to syslog
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Log::Report::Dispatcher::Syslog
\&   is a Log::Report::Dispatcher
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\& # add syslog dispatcher
\& dispatcher SYSLOG => \*(Aqsyslog\*(Aq, accept => \*(AqNOTICE\-\*(Aq
\&   , format_reason => \*(AqIGNORE\*(Aq
\&   , to_prio => [ \*(AqALERT\-\*(Aq => \*(Aqerr\*(Aq ];
\&
\& # disable default dispatcher, when daemon
\& dispatcher close => \*(Aqdefault\*(Aq;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This dispatchers produces output to syslog, based on the Sys::Syslog
module (which will \s-1NOT\s0 be automatically installed for you, because some
systems have a problem with this dependency).
.PP
The \s-1REASON\s0 for a message often uses names which are quite similar to
the log-levels used by syslog.  However: they have a different purpose.
The \s-1REASON\s0 is used by the programmer to indicate the cause of the message:
whether it was able to handle a certain situation.  The syslog levels
are there for the user's of the program (with syslog usually the
system administrators).  It is not unusual to see a \*(L"normal\*(R" error
or mistake as a very serious situation in a production environment. So,
you may wish to translate any message above reason \s-1MISTAKE\s0 into a \s-1LOG_CRIT.\s0
.PP
The default translation table is list below.  You can change the mapping
using new(to_prio).  See example in \s-1SYNOPSIS.\s0
.PP
.Vb 6
\&  TRACE   => LOG_DEBUG    ERROR   => LOG_ERR
\&  ASSERT  => LOG_DEBUG    FAULT   => LOG_ERR
\&  INFO    => LOG_INFO     ALERT   => LOG_ALERT
\&  NOTICE  => LOG_NOTICE   FAILURE => LOG_EMERG
\&  WARNING => LOG_WARNING  PANIC   => LOG_CRIT
\&  MISTAKE => LOG_WARNING
.Ve
.PP
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Log::Report::Dispatcher.
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in Log::Report::Dispatcher.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" 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 \*(L"Constructors\*(R" in Log::Report::Dispatcher
.ie n .IP "Log::Report::Dispatcher::Syslog\->\fBnew\fR($type, $name, %options)" 4
.el .IP "Log::Report::Dispatcher::Syslog\->\fBnew\fR($type, \f(CW$name\fR, \f(CW%options\fR)" 4
.IX Item "Log::Report::Dispatcher::Syslog->new($type, $name, %options)"
With syslog, people tend not to include the \s-1REASON\s0 of the message
in the logs, because that is already used to determine the destination
of the message.
.Sp
.Vb 10
\& \-Option        \-\-Defined in             \-\-Default
\&  accept          Log::Report::Dispatcher  depend on mode
\&  charset                                  \*(Aqutf8\*(Aq
\&  facility                                 \*(Aquser\*(Aq
\&  flags                                    \*(Aqpid,nowait\*(Aq
\&  format                                   <unchanged>
\&  format_reason   Log::Report::Dispatcher  \*(AqIGNORE\*(Aq
\&  identity                                 <basename $0>
\&  include_domain                           <false>
\&  locale          Log::Report::Dispatcher  <system locale>
\&  logsocket                                undef
\&  mode            Log::Report::Dispatcher  \*(AqNORMAL\*(Aq
\&  to_prio                                  []
.Ve
.RS 4
.IP "accept => \s-1REASONS\s0" 2
.IX Item "accept => REASONS"
.PD 0
.IP "charset => \s-1CHARSET\s0" 2
.IX Item "charset => CHARSET"
.PD
Translate the text-strings into the specified charset, otherwise the
sysadmin may get unreadable text.
.IP "facility => \s-1STRING\s0" 2
.IX Item "facility => STRING"
The possible values for this depend (a little) on the system.  \s-1POSIX\s0
only defines \f(CW\*(C`user\*(C'\fR, and \f(CW\*(C`local0\*(C'\fR up to \f(CW\*(C`local7\*(C'\fR.
.IP "flags => \s-1STRING\s0" 2
.IX Item "flags => STRING"
Any combination of flags as defined by Sys::Syslog, for instance
\&\f(CW\*(C`pid\*(C'\fR, \f(CW\*(C`ndelay\*(C'\fR, and \f(CW\*(C`nowait\*(C'\fR.
.IP "format => \s-1CODE\s0" 2
.IX Item "format => CODE"
[1.10] With a \s-1CODE\s0 reference you get your hands on the text before
it gets sent to syslog.  The three parameters are: the (translated) text,
the related text domain object, and the message object.  You may want to
use context information from the latter.
.Sp
[1.19] After the three positional parameters, there may be a list of
pairs (named parameters) with additional info.  This may contain a
\&\f(CW\*(C`location\*(C'\fR with an \s-1ARRAY\s0 of information produced by \fBcaller()\fR about the
origin of the exception.
.IP "format_reason => '\s-1UPPERCASE\s0'|'\s-1LOWERCASE\s0'|'\s-1UCFIRST\s0'|'\s-1IGNORE\s0'|CODE" 2
.IX Item "format_reason => 'UPPERCASE'|'LOWERCASE'|'UCFIRST'|'IGNORE'|CODE"
.PD 0
.IP "identity => \s-1STRING\s0" 2
.IX Item "identity => STRING"
.IP "include_domain => \s-1BOOLEAN\s0" 2
.IX Item "include_domain => BOOLEAN"
.PD
[1.00] Include the text-domain of the message in each logged message.
.IP "locale => \s-1LOCALE\s0" 2
.IX Item "locale => LOCALE"
.PD 0
.IP "logsocket => 'unix'|'inet'|'stream'|HASH" 2
.IX Item "logsocket => 'unix'|'inet'|'stream'|HASH"
.PD
If specified, the log socket type will be initialized to this before
\&\f(CW\*(C`openlog()\*(C'\fR is called.  If not specified, the system default is used.
.IP "mode => '\s-1NORMAL\s0'|'\s-1VERBOSE\s0'|'\s-1ASSERT\s0'|'\s-1DEBUG\s0'|0..3" 2
.IX Item "mode => 'NORMAL'|'VERBOSE'|'ASSERT'|'DEBUG'|0..3"
.PD 0
.IP "to_prio => ARRAY-of-PAIRS" 2
.IX Item "to_prio => ARRAY-of-PAIRS"
.PD
See \fBreasonToPrio()\fR.
.RE
.RS 4
.RE
.SS "Accessors"
.IX Subsection "Accessors"
Extends \*(L"Accessors\*(R" in Log::Report::Dispatcher.
.ie n .IP "$obj\->\fBformat\fR( [\s-1CODE\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBformat\fR( [\s-1CODE\s0] )" 4
.IX Item "$obj->format( [CODE] )"
Returns the \s-1CODE\s0 ref which formats the syslog line.
.ie n .IP "$obj\->\fBisDisabled\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBisDisabled\fR()" 4
.IX Item "$obj->isDisabled()"
Inherited, see \*(L"Accessors\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBmode\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBmode\fR()" 4
.IX Item "$obj->mode()"
Inherited, see \*(L"Accessors\*(R" 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 \*(L"Accessors\*(R" 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 \*(L"Accessors\*(R" 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 \*(L"Accessors\*(R" in Log::Report::Dispatcher
.SS "Logging"
.IX Subsection "Logging"
Extends \*(L"Logging\*(R" in Log::Report::Dispatcher.
.ie n .IP "$obj\->\fBaddSkipStack\fR(@CODE)" 4
.el .IP "\f(CW$obj\fR\->\fBaddSkipStack\fR(@CODE)" 4
.IX Item "$obj->addSkipStack(@CODE)"
.PD 0
.IP "Log::Report::Dispatcher::Syslog\->\fBaddSkipStack\fR(@CODE)" 4
.IX Item "Log::Report::Dispatcher::Syslog->addSkipStack(@CODE)"
.PD
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBcollectLocation\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBcollectLocation\fR()" 4
.IX Item "$obj->collectLocation()"
.PD 0
.IP "Log::Report::Dispatcher::Syslog\->\fBcollectLocation\fR()" 4
.IX Item "Log::Report::Dispatcher::Syslog->collectLocation()"
.PD
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBcollectStack\fR( [$maxdepth] )" 4
.el .IP "\f(CW$obj\fR\->\fBcollectStack\fR( [$maxdepth] )" 4
.IX Item "$obj->collectStack( [$maxdepth] )"
.PD 0
.IP "Log::Report::Dispatcher::Syslog\->\fBcollectStack\fR( [$maxdepth] )" 4
.IX Item "Log::Report::Dispatcher::Syslog->collectStack( [$maxdepth] )"
.PD
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBlog\fR(HASH\-$of\-%options, $reason, $message, $domain)" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR(HASH\-$of\-%options, \f(CW$reason\fR, \f(CW$message\fR, \f(CW$domain\fR)" 4
.IX Item "$obj->log(HASH-$of-%options, $reason, $message, $domain)"
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBreasonToPrio\fR($reason)" 4
.el .IP "\f(CW$obj\fR\->\fBreasonToPrio\fR($reason)" 4
.IX Item "$obj->reasonToPrio($reason)"
Returns a level which is understood by \fBsyslog\fR\|(3), based on a translation
table.  This can be changed with new(to_prio).
.ie n .IP "$obj\->\fBskipStack\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBskipStack\fR()" 4
.IX Item "$obj->skipStack()"
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBstackTraceLine\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBstackTraceLine\fR(%options)" 4
.IX Item "$obj->stackTraceLine(%options)"
.PD 0
.IP "Log::Report::Dispatcher::Syslog\->\fBstackTraceLine\fR(%options)" 4
.IX Item "Log::Report::Dispatcher::Syslog->stackTraceLine(%options)"
.PD
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.ie n .IP "$obj\->\fBtranslate\fR(HASH\-$of\-%options, $reason, $message)" 4
.el .IP "\f(CW$obj\fR\->\fBtranslate\fR(HASH\-$of\-%options, \f(CW$reason\fR, \f(CW$message\fR)" 4
.IX Item "$obj->translate(HASH-$of-%options, $reason, $message)"
Inherited, see \*(L"Logging\*(R" in Log::Report::Dispatcher
.SH "DETAILS"
.IX Header "DETAILS"
Extends \*(L"\s-1DETAILS\*(R"\s0 in Log::Report::Dispatcher.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 1.36,
built on October 27, 2023. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2023 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR