view release on metacpan or  search on metacpan

lib/BuzzSaw/Parser/RFC3339.pm  view on Meta::CPAN

while (defined (my $line = $fh->getline) ) {
  my %event = $parser->parse_line($line);
}

=head1 DESCRIPTION

This is a Moose class which provides a parser which implements the
BuzzSaw::Parser role. It can handle log entries that use the RFC3339
date format (e.g. looks like C<2013-03-28T11:57:30.025350+00:00>. The
parser splits a line into separate parts, e.g. date, program, pid,
message.

The BuzzSaw project provides a suite of tools for processing log file
entries. Entries in files are parsed and filtered into a set of events
of interest which are stored in a database. A report generation
framework is also available which makes it easy to generate regular
reports regarding the events discovered.

=head1 ATTRIBUTES

There are no attributes in this class.

=head1 SUBROUTINES/METHODS

=over

=item %results = $parser->parse_line($log_entry)

This method takes a log entry line as a string and returns a hash
which contains the details of the various parts of the entry.

The following date and time attributes will be specified in the
returned hash: C<year>, C<month>, C<day>, C<hour>, C<minute>,
C<second>. If a time-zone is specified in the log entry it will be
returned with the key C<time_zone>. These field names match with the
L<DateTime> attributes.

The C<message> attribute will always be defined (even if it is just an
empty string). The C<program> and C<pid> attributes are optional.

=back

=head1 DEPENDENCIES

This module is powered by L<Moose>. This module implements the
L<BuzzSaw::Parser> Moose role.

=head1 SEE ALSO

L<BuzzSaw>, L<BuzzSaw::Filter>

=head1 PLATFORMS

This is the list of platforms on which we have tested this
software. We expect this software to work on any Unix-like platform
which is supported by Perl.

ScientificLinux6

=head1 BUGS AND LIMITATIONS

Please report any bugs or problems (or praise!) to bugs@lcfg.org,
feedback and patches are also always very welcome.

=head1 AUTHOR

    Stephen Quinney <squinney@inf.ed.ac.uk>

=head1 LICENSE AND COPYRIGHT

    Copyright (C) 2012 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify
it under the terms of the GPL, version 2 or later.

=cut