.\" Automatically generated by Pod::Man 2.28 (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 "Message::Passing::Filter::Regexp 3pm"
.TH Message::Passing::Filter::Regexp 3pm "2013-07-12" "perl v5.20.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"
Message::Passing::Filter::Regexp \- Regexp Capture Filter For Message::Passing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&    # regexfile
\&    [FORMAT]
\&    :default = %date %status %remotehost %domain %request %originhost %responsetime %upstreamtime %bytes %referer %ua %xff
\&    :nginxaccesslog = %date %status %remotehost %bytes %responsetime
\&    [REGEXP]
\&    %date = (?#=date)\e[(?#=ts)\ed{2}\e/\ew{3}\e/\ed{4}(?::\ed{2}){3}(?#!ts) [\-+]\ed{4}\e](?#!date)
\&    %status = (?#=status)\ed+(?#!status)
\&    %remotehost = (?#=remotehost)\eS+(?#!remotehost)
\&    %domain = (?#=domain).*?(?#!domain)
\&    %request = (?#=request)\-|(?#=method)\ew+(?#!method) (?#=url).*?(?#!url) (?#=version)HTTP/\ed\e.\ed(?#!version)(?#!request)
\&    %originhost = (?#=originhost)\-|(?#=oh).*?(?#!oh):\ed+(?#!originhost)
\&    %responsetime = (?#=responsetime)\-|.*?(?#!responsetime)
\&    %upstreamtime = (?#=upstreamtime).*?(?#!upstreamtime)
\&    %bytes = (?#=bytes)\ed+(?#!bytes)
\&    %referer = (?#=referer)\e"(?#=ref).*?(?#!ref)\e"(?#!referer)
\&    %useragent = (?#=useragent)\e"(?#=ua).*?(?#!ua)\e"(?#!useragent)
\&    %xforwarderfor = (?#=xforwarderfor)\e"(?#=xff).*?(?#!xff)\e"(?#!xforwarderfor)
\&
\&    # message\-passing\-cli
\&    use Message::Passing::DSL;
\&    run_message_server message_chain {
\&        output stdout => (
\&            class => \*(AqSTDOUT\*(Aq,
\&        );
\&        output elasticsearch => (
\&            class => \*(AqElasticSearch\*(Aq,
\&            elasticsearch_servers => [\*(Aq127.0.0.1:9200\*(Aq],
\&        );
\&        encoder("encoder",
\&            class => \*(AqJSON\*(Aq,
\&            output_to => \*(Aqstdout\*(Aq,
\&            output_to => \*(Aqes\*(Aq,
\&        );
\&        filter regexp => (
\&            class => \*(AqRegexp\*(Aq,
\&            format => \*(Aq:nginxaccesslog\*(Aq,
\&            capture => [qw( ts status remotehost url oh responsetime upstreamtime bytes )]
\&            output_to => \*(Aqencoder\*(Aq,
\&        );
\&        filter logstash => (
\&            class => \*(AqToLogstash\*(Aq,
\&            output_to => \*(Aqregexp\*(Aq,
\&        );
\&        decoder decoder => (
\&            class => \*(AqJSON\*(Aq,
\&            output_to => \*(Aqlogstash\*(Aq,
\&        );
\&        input file => (
\&            class => \*(AqFileTail\*(Aq,
\&            output_to => \*(Aqdecoder\*(Aq,
\&        );
\&    };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This filter passes all incoming messages through with regexp captures.
.PP
Note it must be running after Message::Passing::Filter::ToLogstash because it don't process with json format but directly capture \f(CW\*(C`$message\->{\*(Aq@message\*(Aq}\*(C'\fR data lines into \f(CW\*(C`%{ $message\->{\*(Aq@fields\*(Aq} }\*(C'\fR
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "regexfile"
.IX Subsection "regexfile"
Path of your regexfile. Default is /etc/message\-passing/regexfile.
.SS "format"
.IX Subsection "format"
Name of a defined format in your regexfile.
.SS "capture"
.IX Subsection "capture"
ArrayRef of regex names which you want to capture and has been defined in your regexfile. note delete the prefix \f(CW\*(C`%\*(C'\fR.
.SS "fromto"
.IX Subsection "fromto"
HashRef of fields which you want capture from and to. Default as \f(CW\*(C`{ \*(Aq@message\*(Aq => \*(Aq@fields\*(Aq }\*(C'\fR.
.PP
If you set \f(CW\*(C`undef\*(C'\fR to one key, such field will exists directly in \f(CW%$message\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Idea steal from <http://logstash.net> Grok filter
.PP
Config Format see Config::Tiny
.SH "AUTHOR"
.IX Header "AUTHOR"
chenryn, <rao.chenlin@gmail.com<gt>
.SH "CONTRIBUTOR"
.IX Header "CONTRIBUTOR"
Alexander Hartmaier
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2012 by chenryn
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.