.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Poet::Log 3pm"
.TH Poet::Log 3pm "2014-02-26" "perl v5.18.2" "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"
Poet::Log \-\- Poet logging
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&    # In a conf file...
\&    log:
\&      defaults:
\&        level: info
\&        output: poet.log
\&        layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c \- %m \- %F:%L \- %P%n"
\&      class:
\&        CHI:
\&          level: debug
\&          output: chi.log
\&          layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m \- %P%n"
\&        MyApp::Foo:
\&          output: stdout
\&
\&    # In a script...
\&    use Poet::Script qw($log);
\&
\&    # In a module...
\&    use Poet qw($log);
\&
\&    # In a component...
\&    my $log = $m\->log;
\&
\&    # For an arbitrary category...
\&    my $log = Poet::Log\->get_logger(category => \*(AqMyApp::Bar\*(Aq);
\&
\&    # then...
\&    $log\->error("an error occurred");
\&
\&    $log\->debugf("arguments are: %s", \e@_)
\&        if $log\->is_debug();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Poet uses Log::Any and Log::Log4perl for logging,
with simplified configuration for the common case.
.PP
Log::Any is a logging abstraction that allows \s-1CPAN\s0 modules to log without
knowing about which logging framework is in use. It supports standard logging
methods (\f(CW\*(C`$log\->debug\*(C'\fR, \f(CW\*(C`$log\->is_debug\*(C'\fR) along with sprintf variants
(\f(CW\*(C`$log\->debugf\*(C'\fR).
.PP
Log4perl is a powerful logging package that provides just about any
logging-related feature you'd want. One of its only drawbacks is its somewhat
cumbersome configuration. So, we provide a way to configure Log4perl simply
through Poet configuration if you just want common features.
.PP
Note: Log4perl is not a strict dependency for Poet.  Log messages will simply
not get logged until you install it or until you modify logging for your app.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The configurations below can go in any Poet conf
file, e.g. \f(CW\*(C`local.cfg\*(C'\fR or \f(CW\*(C`global/log.cfg\*(C'\fR.
.PP
Here's a simple configuration that caches everything to \f(CW\*(C`logs/poet.log\*(C'\fR at
\&\f(CW\*(C`info\*(C'\fR level. This is also the default if no configuration is present.
.PP
.Vb 5
\&    log:
\&      defaults:
\&        level: info
\&        output: poet.log
\&        layout: %d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c \- %m \- %F:%L \- %P%n
.Ve
.PP
Here's a more involved configuration that maintains the same default, but adds
several \fIcategories\fR that are logged differently:
.PP
.Vb 12
\&    log:
\&      defaults:
\&        level: info
\&        output: poet.log
\&        layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c \- %m \- %F:%L \- %P%n"
\&      category:
\&        CHI:
\&          level: debug
\&          output: chi.log
\&          layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m \- %P%n"
\&        MyApp::Foo:
\&          output: stdout
.Ve
.PP
For the default and for each category, you can specify three different
settings:
.IP "\(bu" 4
level \- one of the valid log4perl levels (fatal, error, warn, info, debug,
trace)
.IP "\(bu" 4
output \- can be a relative filename (which will be placed in the Poet log
directory), an absolute filename, or the special names \*(L"stdout\*(R" or \*(L"stderr\*(R"
.IP "\(bu" 4
layout \- a valid log4perl PatternLayout
string.
.PP
If a setting isn't defined for a specific category then it falls back to the
default. In this example, \f(CW\*(C`MyApp::Foo\*(C'\fR will inherit the default level and
layout.
.PP
Notice that we use '::' instead of '.' to specify hierarchical category names,
because '.' would interfere with Poet::Conf dot notation.
.PP
Finally, if you must use a full Log4perl configuration
file, you can specify it this way:
.PP
.Vb 2
\&    log:
\&      log4perl_conf: /path/to/log4perl.conf
.Ve
.SH "USAGE"
.IX Header "USAGE"
.SS "Obtaining log handle"
.IX Subsection "Obtaining log handle"
.IP "\(bu" 4
In a script (log category will be 'main'):
.Sp
.Vb 1
\&    use Poet::Script qw($log);
.Ve
.IP "\(bu" 4
In a module \f(CW\*(C`MyApp::Foo\*(C'\fR (log category will be 'MyApp::Foo'):
.Sp
.Vb 1
\&    use Poet qw($log);
.Ve
.IP "\(bu" 4
In a component \f(CW\*(C`/foo/bar\*(C'\fR (log category will be 'Mason::Component::foo::bar'):
.Sp
.Vb 1
\&    my $log = $m\->log;
.Ve
.IP "\(bu" 4
Manually for an arbitrary log category:
.Sp
.Vb 1
\&    my $log = Poet::Log\->get_logger(category => \*(AqSome::Category\*(Aq);
\&        
\&    # or
\&    
\&    my $log = MyApp::Log\->get_logger(category => \*(AqSome::Category\*(Aq);
.Ve
.SS "Using log handle"
.IX Subsection "Using log handle"
.Vb 1
\&    $log\->error("an error occurred");
\&
\&    $log\->debugf("arguments are: %s", \e@_)
\&        if $log\->is_debug();
.Ve
.PP
See \f(CW\*(C`Log::Any|Log::Any\*(C'\fR for more details.
.SH "MODIFIABLE METHODS"
.IX Header "MODIFIABLE METHODS"
These methods are not intended to be called externally, but may be useful to
override or modify with method modifiers in
subclasses. Their APIs will be kept as stable as
possible.
.IP "initialize_logging" 4
.IX Item "initialize_logging"
Called once when the Poet environment is initialized. By default, initializes
log4perl with the results of \*(L"generate_log4perl_config\*(R" and then calls \f(CW\*(C`Log::Any::Adapter\->set(\*(AqLog4perl\*(Aq)\*(C'\fR.  You can modify this to initialize
log4perl in your own way, or use a different Log::Any adapter, or use a
completely different logging system.
.IP "generate_log4perl_config" 4
.IX Item "generate_log4perl_config"
Returns a log4perl config string based on Poet configuration. You can modify
this to construct and return your own config.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.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.