.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Zonemaster::Logger 3pm"
.TH Zonemaster::Logger 3pm "2021-01-06" "perl v5.32.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"
Zonemaster::Logger \- class that holds Zonemaster::Logger::Entry objects.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    my $logger = Zonemaster::Logger\->new;
\&    $logger\->add( TAG => {some => \*(Aqarguments\*(Aq});
.Ve
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "entries" 4
.IX Item "entries"
A reference to an array holding Zonemaster::Logger::Entry objects.
.IP "callback($coderef)" 4
.IX Item "callback($coderef)"
If this attribute is set, the given code reference will be called every time a
log entry is added. The referenced code will be called with the newly created
entry as its single argument. The return value of the called code is ignored.
.Sp
If the called code throws an exception, and the exception is not an object of
class Zonemaster::Exception (or a subclass of it), the exception will be
logged as a system message at default level \f(CW\*(C`CRITICAL\*(C'\fR and the callback
attribute will be cleared.
.Sp
If an exception that is of (sub)class Zonemaster::Exception is called, the
exception will simply be rethrown until it reaches the code that started the
test run that logged the message.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "add($tag, $argref)" 4
.el .IP "add($tag, \f(CW$argref\fR)" 4
.IX Item "add($tag, $argref)"
Adds an entry with the given tag and arguments to the logger object.
.IP "json([$level])" 4
.IX Item "json([$level])"
Returns a JSON-formatted string with all the stored log entries. If an argument
is given and is a known severity level, only messages with at least that level
will be included.
.IP "get_max_level" 4
.IX Item "get_max_level"
Returns the maximum log level from the entire log as the level string.
.SH "CLASS METHOD"
.IX Header "CLASS METHOD"
.IP "\fBstart_time_now()\fR" 4
.IX Item "start_time_now()"
Set the logger's start time to the current time.
.IP "\fBclear_history()\fR" 4
.IX Item "clear_history()"
Remove all known log entries.