|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 accumulate isnt 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 messages, regardless if the interval set in block_period has passed or not. Dont 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. Dont mix with max_until_flushed.|
Optional method name to be called on the appender attached to the
limiter when messages are flushed. For example, to have the sample code
in the SYNOPSIS section bundle buffered emails into one, change the
mailers buffered parameter to 1 and set the limiters
appender_method_on_flush value to the string "flush":
This will cause the mailer to buffer messages and wait for flush() to send out the whole batch. The limiter will then call the appenders flush() method when its own buffer gets flushed out.
Log::Log4perl::Appender::Limit is a composite appender. Unlike other appenders, it doesnt log any messages, it just passes them on to its attached sub-appender. For this reason, it doesnt 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.
Copyright 2002-2013 by Mike Schilli <firstname.lastname@example.org> and Kevin Goess <email@example.com>.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Please contribute patches to the project on Github:
Send bug reports or requests for enhancements to the authors via our
MAILING LIST (questions, bug reports, suggestions/patches): firstname.lastname@example.org
Contributors (in alphabetical order): Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy Grundman, Paul Harrington, Alexander Hartmaier David Hull, Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope, Lars Thegler, David Viner, Mac Yang.
|perl v5.20.3||APPENDER::LIMIT (3)||2015-04-18|