.\" 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 "Rex::Logger 3pm"
.TH Rex::Logger 3pm "2023-08-09" "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"
Rex::Logger \- Logging Module
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is the logging module. You can define custom logformats.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& $Rex::Logger::format = \*(Aq[%D] %s\*(Aq;
\& # will output something like
\& # [2012\-04\-12 18:35:12] Installing package vim
\&
\& $Rex::Logger::format = \*(Aq%h \- %D \- %s\*(Aq;
\& # will output something like
\& # srv001 \- 2012\-04\-12 18:35:12 \- Installing package vim
.Ve
.SH "VARIABLES"
.IX Header "VARIABLES"
.ie n .IP "$debug" 4
.el .IP "\f(CW$debug\fR" 4
.IX Item "$debug"
Setting this variable to 1 will enable debug logging.
.Sp
.Vb 1
\& $Rex::Logger::debug = 1;
.Ve
.ie n .IP "$silent" 4
.el .IP "\f(CW$silent\fR" 4
.IX Item "$silent"
If you set this variable to 1 nothing will be logged.
.Sp
.Vb 1
\& $Rex::Logger::silent = 1;
.Ve
.ie n .IP "$format" 4
.el .IP "\f(CW$format\fR" 4
.IX Item "$format"
You can define the logging format with the following parameters.
.Sp
\&\f(CW%D\fR \- Appends the current date yyyy-mm-dd HH:mm:ss
.Sp
\&\f(CW%h\fR \- The target host
.Sp
\&\f(CW%p\fR \- The pid of the running process
.Sp
\&\f(CW%l\fR \- Loglevel (\s-1INFO\s0 or \s-1DEBUG\s0)
.Sp
\&\f(CW%s\fR \- The Logstring
.Sp
Default is: [%D] \f(CW%l\fR \- \f(CW%s\fR