File::Rotate(3pm) User Contributed Perl Documentation File::Rotate(3pm)NAME
Log::Agent::File::Rotate - a rotating logfile set
SYNOPSIS
#
# This class is not user-visible.
#
# It is documented only for programmers wishing to inherit
# from it to further extend its behaviour.
#
require Log::Agent::Driver::File;
require Log::Agent::Rotate;
require Log::Agent::File::Rotate;
my $config = Log::Agent::Rotate->make(...);
my $driver = Log::Agent::Driver::File->make(...);
my $fh = Log::Agent::File::Rotate->make("file", $config, $driver);
DESCRIPTION
This class represents a rotating logfile and is used drivers wishing to rotate their logfiles periodically. From the outside, it exports a
single "print" routine, just like "Log::Agent::File::Native".
Internally, it uses the parameters given by a "Log::Agent::Rotate" object to transparently close the current logfile and cycle the older
logs.
Before rotating the current logfile, the string:
*** LOGFILE ROTATED ON <local date>
is emitted, so that people monitoring the file via "tail -f" know about it and are not surprised by the sudden stop of messages.
Its exported interface is:
make file, config
This is the creation routine. The config object is an instance of "Log::Agent::Rotate".
print args
Prints args to the file. After having printed the data, monitor the file against the thresholds defined in the configuration, and
possibly rotate the logfiles according to the parameters held in the same configuration object.
When the "is_alone" flag is not set in the configuration, the logfile is checked everytime a "print" is issued to see if its inode
changed. Indeed, when several instances of the same program using rotating logfiles are running, each of them may decide to cycle the
logs at some point in time, and therefore our opened handle could point to an already renamed or unlinked file.
AUTHORS
Originally written by Raphael Manfredi <Raphael_Manfredi@pobox.com>, currently maintained by Mark Rogaski <mrogaski@pobox.com>.
SEE ALSO Log::Agent::Rotate(3), Log::Agent::Driver::File(3).
perl v5.10.0 2002-05-14 File::Rotate(3pm)
Check Out this Related Man Page
Agent::Channel::File(3pm) User Contributed Perl Documentation Agent::Channel::File(3pm)NAME
Log::Agent::Channel::File - file logging channel for Log::Agent
SYNOPSIS
require Log::Agent::Channel::File;
my $driver = Log::Agent::Channel::File->make(
-prefix => "prefix",
-stampfmt => "own",
-showpid => 1,
-magic_open => 0,
-filename => "/tmp/output.err",
-fileperm => 0640,
-share => 1,
);
DESCRIPTION
The file channel performs logging to a file, along with the necessary prefixing and stamping of the messages.
Internally, the "Log::Agent::Driver::File" driver creates such objects for each logging channel defined at driver creation time.
The creation routine make() takes the following arguments:
"-filename" => file
The file name where output should go. The file is opened in append mode and autoflushing is turned on. See also the "-magic_open"
flag.
"-fileperm" => perm
The permissions that the file should be opened with (XOR'd with the user's umask). Due to the nature of the underlying open() and
sysopen(), the value is limited to less than or equal to 0666. See "umask" in perlfunc(3) for more details.
"-magic_open" => flag
When true, channel filenames beginning with '>' or '|' are opened using Perl's open(). Otherwise, sysopen() is used, in append mode.
Default is false.
"-no_newline" => flag
When set to true, never append any "
" (on Unix) or "
" (on Windows) to log messages.
Internally, Log::Agent relies on the channel to delimit logged lines appropriately, so this flag is not used. However, it might be
useful for "Log::Agent::Logger" users.
Default is false, meaning newline markers are systematically appended.
"-no_prefixing" => flag
When set to true, disable the prefixing logic entirely, i.e. the following options are ignored completely: "-prefix", "-showpid",
"-no_ucfirst", "-stampfmt".
Default is false.
"-no_ucfirst" => flag
When set to true, don't upper-case the first letter of the log message entry when there's no prefix inserted before the logged line.
When there is a prefix, a ":" character follows, and therefore the leading letter of the message should not be upper-cased anyway.
Default is false, meaning uppercasing is performed.
"-prefix" => prefix
The application prefix string to prepend to messages.
"-rotate" => object
This sets a default logfile rotation policy. You need to install the additional "Log::Agent::Rotate" module to use this switch.
object is the "Log::Agent::Rotate" instance describing the rotating policy for the channel. Only files which are not opened via a so-
called magic open can be rotated.
"-share" => flag
When true, this flag records the channel in a global pool indexed by filenames. An existing file handle for the same filename may be
then be shared amongst several file channels.
However, you will get this message in the file
Rotation for 'filename' may be wrong (shared with distinct policies)
when a rotation policy different from the one used during the initial opening is given. Which policy will be used is unspecified, on
purpose.
"-showpid" => flag
If set to true, the PID of the process will be appended within square brackets after the prefix, to all messages.
Default is false.
"-stampfmt" => (name | CODE)
Specifies the time stamp format to use. By default, my "own" format is used. See Log::Agent::Stamping for a description of the
available format names.
You may also specify a CODE ref: that routine will be called every time we need to compute a time stamp. It should not expect any
parameter, and should return a string.
CAVEAT
Beware of chdir(). If your program uses chdir(), you should always specify logfiles by using absolute paths, otherwise you run the risk of
having your relative paths become invalid: there is no anchoring done at the time you specify them. This is especially true when
configured for rotation, since the logfiles are recreated as needed and you might end up with many logfiles scattered throughout all the
directories you chdir()ed to.
AUTHORS
Originally written by Raphael Manfredi <Raphael_Manfredi@pobox.com>, currently maintained by Mark Rogaski <mrogaski@cpan.org>.
LICENSE
Copyright (C) 1999 Raphael Manfredi. Copyright (C) 2002 Mark Rogaski, mrogaski@cpan.org; all rights reserved.
See Log::Agent(3) or the README file included with the distribution for license information.
SEE ALSO Log::Agent::Logger(3), Log::Agent::Channel(3).
perl v5.10.0 2002-03-09 Agent::Channel::File(3pm)