Appender::Limit(3pm) User Contributed Perl Documentation Appender::Limit(3pm)
NAME
Log::Log4perl::Appender::Limit - Limit message delivery via block period
SYNOPSIS
use Log::Log4perl qw(:easy);
my $conf = qq(
log4perl.category = WARN, Limiter
# Email appender
log4perl.appender.Mailer = Log::Dispatch::Email::MailSend
log4perl.appender.Mailer.to = drone\@pageme.com
log4perl.appender.Mailer.subject = Something's broken!
log4perl.appender.Mailer.buffered = 0
log4perl.appender.Mailer.layout = PatternLayout
log4perl.appender.Mailer.layout.ConversionPattern=%d %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Mailer
log4perl.appender.Limiter.block_period = 3600
);
Log::Log4perl->init(\$conf);
WARN("This message will be sent immediately");
WARN("This message will be delayed by one hour.");
sleep(3601);
WARN("This message plus the last one will be sent now");
DESCRIPTION
"appender"
Specifies the name of the appender used by the limiter. The appender specified must be
defined somewhere in the configuration file, not necessarily before the definition of
"Log::Log4perl::Appender::Limit".
"block_period"
Period in seconds between delivery of messages. If messages arrive in between, they
will be either saved (if "accumulate" is set to a true value) or discarded (if "accu-
mulate" isn't set).
"persistent"
File name in which "Log::Log4perl::Appender::Limit" persistently stores delivery
times. If omitted, the appender will have no recollection of what happened when the
program restarts.
"max_until_flushed"
Maximum number of accumulated messages. If exceeded, the appender flushes all mes-
sages, regardless if the interval set in "block_period" has passed or not. Don't mix
with "max_until_discarded".
"max_until_discarded"
Maximum number of accumulated messages. If exceeded, the appender will simply discard
additional messages, waiting for "block_period" to expire to flush all accumulated
messages. Don't mix with "max_until_flushed".
If the appender attached to "Limit" uses "PatternLayout" with a timestamp specifier, you
will notice that the message timestamps are reflecting the original log event, not the
time of the message rendering in the attached appender. Major trickery has applied to
accomplish this (Cough!).
DEVELOPMENT NOTES
"Log::Log4perl::Appender::Limit" is a composite appender. Unlike other appenders, it
doesn't log any messages, it just passes them on to its attached sub-appender. For this
reason, it doesn't need a layout (contrary to regular appenders). If it defines none,
messages are passed on unaltered.
Custom filters are also applied to the composite appender only. They are not applied to
the sub-appender. Same applies to appender thresholds. This behaviour might change in the
future.
LEGALESE
Copyright 2004 by Mike Schilli, all rights reserved. This program is free software, you
can redistribute it and/or modify it under the same terms as Perl itself.
AUTHOR
2004, Mike Schilli <m AT perlmeister.com>
perl v5.8.4 2004-06-22 Appender::Limit(3pm)
Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache/2.0.61 (Unix) PHP/4.4.7 mod_ssl/2.0.61 OpenSSL/0.9.7e mod_fastcgi/2.4.2 DAV/2 SVN/1.4.2
Under GNU General Public License
2009-01-06 14:36 @38.103.63.57 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)