.\" 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 "Log::Dispatch::Message::Passing 3pm"
.TH Log::Dispatch::Message::Passing 3pm "2013-06-20" "perl v5.18.1" "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::Dispatch::Message::Passing \- log events to Message::Passing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your application code:
.PP
.Vb 4
\&  use Log::Dispatch;
\&  use Log::Dispatch::Message::Passing;
\&  use Message::Passing::Filter::Encoder::JSON;
\&  use Message::Passing::Output::ZeroMQ;
\&
\&  my $log = Log::Dispatch\->new;
\&
\&  $log\->add(Log::Dispatch::Message::Passing\->new(
\&        name      => \*(Aqmyapp_aggregate_log\*(Aq,
\&        min_level => \*(Aqdebug\*(Aq,
\&        output    => Message::Passing::Filter::Encoder::JSON\->new(
\&            output_to => Message::Passing::Output::ZeroMQ\->new(
\&                connect => \*(Aqtcp://192.168.0.1:5558\*(Aq,
\&            ),
\&        ),
\&  ));
\&
\&  $log\->warn($_) for qw/ foo bar baz /;
.Ve
.PP
On your central log server:
.PP
.Vb 2
\&  message\-pass \-\-input ZeroMQ \-\-input_options \*(Aq{"socket_bind":"tcp://*:5558"}\*(Aq \e
\&    \-\-output File \-\-output_options \*(Aq{"filename":"myapp_aggregate.log"}\*(Aq
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This provides a Log::Dispatch log output system that sends logged events to
Message::Passing.
.PP
This allows you to use any of the Message::Passing outputs or filters
to process log events and send them across the network, and you can use
the toolkit to trivially construct a log aggregator.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 1
\& my $table_log = Log::Dispatch::Message::Passing\->new(\e%arg);
.Ve
.PP
This method constructs a new Log::Dispatch::Message::Passing output object.
.PP
Required arguments are:
.PP
.Vb 1
\&  output \- a L<Message::Passing> L<Output|Message::Passing::Role::Output> class.
.Ve
.SS "log_message"
.IX Subsection "log_message"
This is the method which performs the actual logging, as detailed by
Log::Dispatch::Output.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Message::Passing" 4
.IX Item "Message::Passing"
The logging framework itself, allowing you to very simply build log
aggregation and processing servers.
.IP "Message::Passing::Output::ZeroMQ" 4
.IX Item "Message::Passing::Output::ZeroMQ"
The recommended network protocol for aggregating or transporting messages
across the network.
.Sp
Note that whilst this transport is recommended, it is \fB\s-1NOT\s0\fR required by
this module, so you need to require (and depend on) Message::Passing::ZeroMQ
separately.
.IP "example/ directory" 4
.IX Item "example/ directory"
Instantly runnable \s-1SYNOPSIS \-\s0 plug into your application for easy log
aggregation.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tomas Doran (t0m) \f(CW\*(C`<bobtfish@bobtfish.net>\*(C'\fR
.SH "SPONSORSHIP"
.IX Header "SPONSORSHIP"
This module exists due to the wonderful people at Suretec Systems Ltd.
<http://www.suretecsystems.com/> who sponsored it's development for its
VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP \s-1API \- \s0
<http://www.surevoip.co.uk/support/wiki/api_documentation>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright Suretec Systems Ltd. 2012.
.SH "LICENSE"
.IX Header "LICENSE"
\&\s-1GNU\s0 Affero General Public License, Version 3
.PP
If you feel this is too restrictive to be able to use this software,
please talk to us as we'd be willing to consider re-licensing under
less restrictive terms.