Log::Fine::Formatter - Log message formatting and sanitization
Provides a formatting facility for log messages
use Log::Fine::Handle; use Log::Fine::Formatter; my $handle = Log::Fine::Handle::Console->new(); my $formatter = Log::Fine::Formatter::Detailed->new( timestamp_format => "%Y-%m-%d %H:%M:%S" ); # By default, the handle will set its formatter to # Log::Fine::Formatter::Basic. If that's not what you want, set # it to preference. $handle->formatter($formatter); # Set the time-stamp to "YYYY-MM-DD HH:MM:SS" $formatter->timeStamp("%Y-%m-%d %H:%M:%S"); # High resolution timestamps with milliseconds are # supported thus: my $hires_formatter = Log::Fine::Formatter::Basic->new( hires => 1, timestamp_format => "%H:%M:%S.%%millis%%", ); # Set the precision of the high resolution formatter my $fmtr = Log::Fine::Formatter::Basic->new( hires => 1, timestamp_format => "%H:%M:%S.%%millis%%", precision => 6 );
Base ancestral class for all formatters. All customized formatters must inherit from this class. The formatter class allows developers to adjust the time-stamp in a log message to a customizable strftime-compatible string without the tedious mucking about writing a formatter sub-class. By default, the time-stamp format is "%c". See "timeStamp" and the strftime(3) man page on your system for further details.
High Resolution time stamps are generated using the Time::HiRes module. Depending on your distribution of perl, this may or may not be installed. Add the string "%%millis%%" (without the quotes) where you would like milliseconds displayed within your format. For example:
Note you must enable high resolution mode during Formatter construction as so:
my $formatter = Log::Fine::Formatter::Basic->new( hires => 1 );
By default, the time-stamp format for high resolution mode is "%H:%M:%S.%%millis%%". This can be changed via the "timeStamp" method or set during formatter construction. "%%millis%%" is a case insensitive value, thus "%%MILLIS%%" will work as well as "%%Millis%%".
Millisecond precision can be set on construction as so:
my $formatter = Log::Fine::Formatter::Basic->new( hires => 1, precision => 6 );
If not set, the default value of 5 will be used. Note that the precision hash element will be ignored unless hires is set.
As of version 0.37, Log::Fine now supports log format templates. See Log::Fine::Formatter::Template for details.
Returns the formatted message. Must be sub-classed!
The formatted string
Special method used for unit tests only. Not for use in production environments!
Level at which to log
Message to log
The formatted string
Getter/Setter for a strftime(3)-compatible format string. If passed with an argument, sets the objects strftime compatible string. Otherwise, returns the objects format string.
[optional] strftime(3) compatible string to set
strftime(3) compatible string
Please report any bugs or feature requests to
bug-log-fine 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.
You can find documentation for this module with the perldoc command.
You can also look for information at:
Christopher M. Fuhrman,
<cfuhrman at pobox.com>
Copyright (c) 2008-2010, 2013 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.