The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
BLHOTSKY / Parse-Syslog-Line-1.0 / README.mkdn

NAME

Parse::Syslog::Line - Simple syslog line parser

VERSION

version 1.0

SYNOPSIS

I wanted a very simple log parser for network based syslog input. Nothing existed that simply took a line and returned a hash ref all parsed out.

use Parse::Syslog::Line qw(parse_syslog_line);

$Parse::Syslog::Line::DateTimeCreate = 1;

my $href = parse_syslog_line( $msg );
#
# $href = {
#       preamble        => '13',
#       priority        => 'notice',
#       priority_int    => 5,
#       facility        => 'user',
#       facility_int    => 8,
#       date            => 'YYYY-MM-DD',
#       time            => 'HH::MM:SS',
#       datetime_str    => 'YYYY-MM-DD HH:MM:SS',
#       datetime_obj    => new DateTime(), # If installed
#       datetime_raw    => 'Feb 17 11:12:13'
#       host_raw        => 'hostname',  # Hostname as it appeared in the message
#       host            => 'hostname',  # Hostname without domain
#       domain          => 'blah.com',  # if provided
#       program_raw     => 'sshd(blah)[pid]',
#       program_name    => 'sshd',
#       program_sub     => 'pam_unix',
#       program_pid     => 20345,
#       content         => 'the rest of the message'
#       message         => 'program[pid]: the rest of the message',
#       message_raw     => 'The message as it was passed',
# };
...

NAME

Parse::Syslog::Line - Parses Syslog Lines into Hashes

VERSION

Version 1.0

EXPORT

Exported by default: parse_syslog_line( $one_line_of_syslog_message );

Optional Exports: :preamble preamble_priority preamble_facility

:constants
     %LOG_FACILITY
     %LOG_PRIORITY

VARIABLES

DateTimeCreate

If this variable is set to 1 (the default), a DateTime object will be returned in the $m->{datetime_obj} field. Otherwise, this will be skipped.

Usage:

our $Parse::Syslog::Line::DateTimeCreate = 0;

FUNCTIONS

parse_syslog_line

Returns a hash reference of syslog message parsed data.

preamble_priority

Takes the Integer portion of the syslog messsage and returns a hash reference as such:

$prioRef = {
    'preamble'  => 13
    'as_text'   => 'notice',
    'as_int'    => 5,
};

preamble_facility

Takes the Integer portion of the syslog messsage and returns a hash reference as such:

$facRef = {
    'preamble'  => 13
    'as_text'   => 'user',
    'as_int'    => 8,
};

AUTHOR

Brad Lhotsky, <brad at divisionbyzero.net>

BUGS

Please report any bugs or feature requests to bug-parse-syslog-line at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Parse-Syslog-Line. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Parse::Syslog::Line

You can also look for information at:

http://github.com/reyjrar/Parse-Syslog-Line

http://annocpan.org/dist/Parse-Syslog-Line

http://cpanratings.perl.org/d/Parse-Syslog-Line

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Parse-Syslog-Line

http://search.cpan.org/dist/Parse-Syslog-Line

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2007 Brad Lhotsky, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Brad Lhotsky brad@divisionbyzero.net

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Brad Lhotsky.

This is free software, licensed under:

The (three-clause) BSD License