The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Log::Fine::Formatter::Basic - Default logging formatter

SYNOPSIS

Formats log messages for output in a basic format, suitable for most applications.

    use Log::Fine::Formatter::Basic;
    use Log::Fine::Handle::Console;

    # instantiate a handle
    my $handle = Log::Fine::Handle::Console->new();

    # instantiate a formatter
    my $formatter = Log::Fine::Formatter::Basic
        ->new( name             => 'basic0',
               timestamp_format => "%y-%m-%d %h:%m:%s" );

    # set the formatter
    $handle->formatter( formatter => $formatter );

    # format a msg
    my $str = $formatter->format(INFO, "Resistance is futile", 1);

DESCRIPTION

The basic formatter provides logging in the following format:

    <[TIMESTAMP] <LEVEL> <MESSAGE>

Note that this is the default format for Log::Fine::Handle objects.

METHODS

format

Formats the given message for the given level

Parameters

  • level

    Level at which to log (see Log::Fine::Levels)

  • message

    Message to log

  • skip

    [ignored] Controls caller skip level

Returns

The formatted text string in the form:

  [TIMESTAMP] LEVEL MESSAGE

BUGS

Please report any bugs or feature requests to bug-log-fine-formatter-basic at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Log-Fine. 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 Log::Fine

You can also look for information at:

REVISION INFORMATION

  $Id: ee9d429dfd883146339a7cce1ace10184b715932 $

AUTHOR

Christopher M. Fuhrman, <cfuhrman at panix.com>

SEE ALSO

perl, Log::Fine::Formatter

COPYRIGHT & LICENSE

Copyright (c) 2008, 2009, 2010 Christopher M. Fuhrman, All rights reserved.

This program is free software licensed under the...

        The BSD License

The full text of the license can be found in the LICENSE file included with this module.