.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "DlfConverterProcess 3pm"
.TH DlfConverterProcess 3pm "2006-07-23" "Lire 2.1.1" "LogReport's Lire 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"
Lire::DlfConverterProcess \- Object that controls the DLF conversion process
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Lire::ImportJob;
\&  use Lire::DlfStore;
\&  use Lire::DlfConverterProcess;
\&
\&  my $src = new Lire::ImportJob( "file", \*(Aqpattern\*(Aq => "/var/log/messages" );
\&  my $store = Lire::DlfStore\->open( "store" );
\&
\&  my $process = new Lire::DlfConverterProcess( $src, $store );
\&
\&  $process\->run_import_job();
\&
\&  print "Log lines read: ",      $process\->line_count(), "\en";
\&  print "DLF records created: ", $process\->dlf_count,    "\en";
\&  print "Errors encountered: ",  $process\->errors_count, "\en";
\&  print "Ignored records: ",     $process\->ignored_count,"\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object encapsulates the Lire \s-1DLF\s0 conversion process. It takes as
parameter a Lire::ImportJob and a Lire::DlfStore. It will setup the
converter and will converter the content of Lire::ImportJob to \s-1DLF\s0
which will be saved in the Lire::DlfStore.
.PP
The object provides the \s-1API\s0 to the converter. Methods are also
available to query information on the conversion process.
.ie n .SH "new( $job, $store );"
.el .SH "new( \f(CW$job\fP, \f(CW$store\fP );"
.IX Header "new( $job, $store );"
Create a Lire::DlfConverterProcess that will be used to import the
log specified in Lire::ImportJob into \s-1DLF\s0 records which will be stored into
Lire::DlfStore.
.SS "run_import_job( [$time] )"
.IX Subsection "run_import_job( [$time] )"
Import the log data from ImportJob as \s-1DLF\s0. This method will throw an
exception if it is called more than once. The \f(CW$time\fR parameter will be
used to determine the time window covered by period. It defaults to the
current time.
.SS "\fIjob_id()\fP"
.IX Subsection "job_id()"
Returns the job identifier associated to this process.
.SS "\fIdlf_store()\fP"
.IX Subsection "dlf_store()"
Returns the Lire::DlfStore in which this conversion process is storing
the \s-1DLF\s0 records.
.SS "\fIimport_job()\fP"
.IX Subsection "import_job()"
Returns the Lire::ImportJob upon which this conversion process is operating.
.SS "\fIline_count()\fP"
.IX Subsection "line_count()"
Returns the number of lines processed. This will 0 in case the \s-1DLF\s0
converter process file and not log lines. During a processing, this is
always equals to the line that is currently being converted.
.SS "\fIdlf_count()\fP"
.IX Subsection "dlf_count()"
Returns the number of \s-1DLF\s0 records created.
.SS "\fIerror_count()\fP"
.IX Subsection "error_count()"
Returns the number of errors encountered in the conversion process.
.SS "\fIignored_count()\fP"
.IX Subsection "ignored_count()"
Returns the number of records which were ignored in the conversion
process.
.SS "\fIsaved_count()\fP"
.IX Subsection "saved_count()"
Returns the number of lines which were saved for later processing.
.SH "API FOR THE DLF CONVERTERS"
.IX Header "API FOR THE DLF CONVERTERS"
This is the object that encapsulates the Dlf implementation and hides
the complexitity of the storage framework from the \s-1DLF\s0 converter. It
offers the following methods to the DLf converter.
.ie n .SS "write_dlf( $schema, $dlf )"
.el .SS "write_dlf( \f(CW$schema\fP, \f(CW$dlf\fP )"
.IX Subsection "write_dlf( $schema, $dlf )"
This writes the \f(CW$dlf\fR \s-1DLF\s0 record conforming the \f(CW$schema\fR's schema in the
Lire::DlfStore. The schema is the schema's name (e.g. 'www'). \f(CW$dlf\fR is
an hash reference. Keys are the schema's field name. Undefined value
means that this field isn't available in that record.
.ie n .SS "save_log_line( $line )"
.el .SS "save_log_line( \f(CW$line\fP )"
.IX Subsection "save_log_line( $line )"
Method that should be used to save \f(CW$line\fR for a future processing run
of the converter on the same Lire::ImportJob.
.ie n .SS "ignored_log_line( $line, [ $reason ] )"
.el .SS "ignored_log_line( \f(CW$line\fP, [ \f(CW$reason\fP ] )"
.IX Subsection "ignored_log_line( $line, [ $reason ] )"
Method that can be used by the Lire::DlfConverter to report that the
\&'$line' log line was ignored during that processing. The reason why
the line was ignored can be given in \f(CW$reason\fR. For example,
syslog-based converter should use that method to report lines that are
for another 'service' than theirs.
.ie n .SS "error( $error_msg, [ $line ] );"
.el .SS "error( \f(CW$error_msg\fP, [ \f(CW$line\fP ] );"
.IX Subsection "error( $error_msg, [ $line ] );"
Method that should be used by the Lire::DlfConveter to report that an
error was encountered when processing the Lire::ImportJob. \f(CW$error_msg\fR
should be used to report the nature of the error. The \f(CW$line\fR parameter
should be used by converter operating on lines to associate the error
message to a particular line.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILire::DlfStore\fR\|(3pm) \fILire::DlfConverter\fR\|(3pm)
.SH "AUTHOR"
.IX Header "AUTHOR"
Francis J. Lacoste <flacoste@logreport.org>
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR DlfConverterProcess.pm,v 1.18 2006/07/23 13:16:28 vanbaal Exp $
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2002\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.