Log::Dispatch::File::Stamped - Logging to date/time stamped files
version 0.18
use Log::Dispatch::File::Stamped; my $file = Log::Dispatch::File::Stamped->new( name => 'file1', min_level => 'info', filename => 'Somefile.log', stamp_fmt => '%Y%m%d', time_function => 'localtime', mode => 'append', ); $file->log( level => 'emerg', message => "I've fallen and I can't get up\n" );
This module subclasses Log::Dispatch::File for logging to date/time-stamped files, respecting all its configuration options. As with other Log::Dispatch handlers, the destination file is kept open for as long as the filename remains constant (unless close_on_write is set).
close_on_write
This method takes the same set of parameters as Log::Dispatch::File::new(), with the following differences:
filename ($)
The filename template. The actual timestamp will be appended to this filename when creating the actual logfile. If the filename has an extension, the timestamp is inserted before the extension. See examples below.
stamp_fmt ($)
The format of the timestamp string. This module uses POSIX::strftime to create the timestamp string from the current local date and time. Refer to your platform's strftime documentation for the list of allowed tokens.
strftime
Defaults to %Y%m%d.
%Y%m%d
time_function ($)
The function used to determine the current time; present choices are "localtime" in perlfunc or "gmtime" in perlfunc. Defaults to localtime.
localtime
Sends a message to the appropriate output. Generally this shouldn't be called directly but should be called through the log() method (in Log::Dispatch::Output).
log()
Assuming the current date and time is:
% perl -e 'print scalar localtime' Sat Feb 8 13:56:13 2003 Log::Dispatch::File::Stamped->new( name => 'file', min_level => 'debug', filename => 'logfile.txt', );
This will log to file logfile-20030208.txt.
Log::Dispatch::File::Stamped->new( name => 'file', min_level => 'debug', filename => 'logfile.txt', stamp_fmt => '%d%H', );
This will log to file logfile-0813.txt.
Log::Dispatch::File
POSIX
Log::Dispatch::File::Rolling
Log::Dispatch::FileRotate
Log::Dispatch::FileWriteRotate
Dave Rolsky, author of the Log::Dispatch suite and many other fine modules on CPAN.
This module was rewritten to respect all present (and future) options to Log::Dispatch::File by Karen Etheridge, <ether@cpan.org>.
Bugs may be submitted through the RT bug tracker (or bug-Log-Dispatch-File-Stamped@rt.cpan.org).
Eric Cholet <cholet@logilune.com>
Karen Etheridge <ether@cpan.org>
This software is copyright (c) 2003 by Eric Cholet and Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Log::Dispatch::File::Stamped, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Log::Dispatch::File::Stamped
CPAN shell
perl -MCPAN -e shell install Log::Dispatch::File::Stamped
For more information on module installation, please visit the detailed CPAN module installation guide.