.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (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
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Logger 3"
.TH Mail::SpamAssassin::Logger 3 2024-09-01 "perl v5.40.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
Mail::SpamAssassin::Logger \- SpamAssassin logging module
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mail::SpamAssassin::Logger;
\&
\&  $SIG{_\|_WARN_\|_} = sub {
\&    log_message("warn", $_[0]);
\&  };
\&
\&  $SIG{_\|_DIE_\|_} = sub {
\&    log_message("error", $_[0])  if !$^S;
\&  };
.Ve
.SH METHODS
.IX Header "METHODS"
.IP add_facilities(facilities) 4
.IX Item "add_facilities(facilities)"
Enable debug logging for specific facilities.  Each facility is the area
of code to debug.  Facilities can be specified as a hash reference (the
key names are used), an array reference, an array, or a comma-separated
scalar string. Facility names are case-sensitive.
.Sp
If "all" is listed, then all debug facilities are implicitly enabled,
except for those explicitly disabled.  A facility name may be preceded
by a "no" (case-insensitive), which explicitly disables it, overriding
the "all".  For example: all,norules,noconfig,nodcc.  When facility names
are given as an ordered list (array or scalar, not a hash), the last entry
applies, e.g. 'nodcc,dcc,dcc,noddc' is equivalent to 'nodcc'.  Note that
currently no facility name starts with a "no", it is advised to keep this
practice with newly added facility names to make life easier.
.Sp
Higher priority informational messages that are suitable for logging in
normal circumstances are available with an area of "info".  Some very
verbose messages require the facility to be specifically enabled (see
\&\f(CW\*(C`would_log\*(C'\fR below).
.ie n .IP "log_message($level, @message)" 4
.el .IP "log_message($level, \f(CW@message\fR)" 4
.IX Item "log_message($level, @message)"
Log a message at a specific level.  Levels are specified as strings:
"warn", "error", "info", and "dbg".  The first element of the message
must be prefixed with a facility name followed directly by a colon.
.IP "dbg(""facility: message"")" 4
.IX Item "dbg(""facility: message"")"
This is used for all low priority debugging messages.
.IP "info(""facility: message"")" 4
.IX Item "info(""facility: message"")"
This is used for informational messages indicating a normal, but
significant, condition.  This should be infrequently called.  These
messages are typically logged when SpamAssassin is run as a daemon.
.ie n .IP "add(method => 'syslog', socket => $socket, facility => $facility, escape => $escape)" 4
.el .IP "add(method => 'syslog', socket => \f(CW$socket\fR, facility => \f(CW$facility\fR, escape => \f(CW$escape\fR)" 4
.IX Item "add(method => 'syslog', socket => $socket, facility => $facility, escape => $escape)"
\&\f(CW\*(C`socket\*(C'\fR is the type the syslog ("unix" or "inet").  \f(CW\*(C`facility\*(C'\fR is the
syslog facility (typically "mail").
.Sp
If optional \f(CW\*(C`escape\*(C'\fR is true, all non-ascii characters are escaped for safe
output: backslashes change to \e\e and non-ascii chars to \ex{XX} or \ex{XXXX}
(Unicode).  If not defined, pre\-4.0 style sanitizing is used
( tr/\ex09\ex20\ex00\-\ex1f/_/s ).
.Sp
Escape value can be overridden with environment variable
\&\f(CW\*(C`SA_LOGGER_ESCAPE\*(C'\fR.
.ie n .IP "add(method => 'file', filename => $file, escape => $escape)" 4
.el .IP "add(method => 'file', filename => \f(CW$file\fR, escape => \f(CW$escape\fR)" 4
.IX Item "add(method => 'file', filename => $file, escape => $escape)"
\&\f(CW\*(C`filename\*(C'\fR is the name of the log file.  \f(CW\*(C`escape\*(C'\fR works as described
above.
.ie n .IP "add(method => 'stderr', escape => $escape)" 4
.el .IP "add(method => 'stderr', escape => \f(CW$escape\fR)" 4
.IX Item "add(method => 'stderr', escape => $escape)"
No options are needed for stderr logging, just don't close stderr first. 
\&\f(CW\*(C`escape\*(C'\fR works as described above.
.IP remove(method) 4
.IX Item "remove(method)"
Remove a logging method.  Only the method name needs to be passed as a
scalar.
.ie n .IP "would_log($level, $facility)" 4
.el .IP "would_log($level, \f(CW$facility\fR)" 4
.IX Item "would_log($level, $facility)"
Returns false if a message at the given level and with the given facility
would not be logged.  Returns 1 if a message at a given level and facility
would be logged normally.  Returns 2 if the facility was specifically
enabled.
.Sp
The facility argument is optional.
.IP \fBclose_log()\fR 4
.IX Item "close_log()"
Close all logs.