/usr/share/perl5/Log/Log4perl/Appender/Buffer.pm is in liblog-log4perl-perl 1.29-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | ######################################################################
# Buffer.pm -- 2004, Mike Schilli <m@perlmeister.com>
######################################################################
# Composite appender buffering messages until a trigger condition is met.
######################################################################
###########################################
package Log::Log4perl::Appender::Buffer;
###########################################
use strict;
use warnings;
our @ISA = qw(Log::Log4perl::Appender);
our $CVSVERSION = '$Revision: 1.2 $';
our ($VERSION) = ($CVSVERSION =~ /(\d+\.\d+)/);
###########################################
sub new {
###########################################
my($class, %options) = @_;
my $self = {
appender=> undef,
buffer => [],
options => {
max_messages => undef,
trigger => undef,
trigger_level => undef,
},
level => 0,
%options,
};
if($self->{trigger_level}) {
$self->{trigger} = level_trigger($self->{trigger_level});
}
# Pass back the appender to be synchronized as a dependency
# to the configuration file parser
push @{$options{l4p_depends_on}}, $self->{appender};
# Run our post_init method in the configurator after
# all appenders have been defined to make sure the
# appender we're playing 'dam' for really exists
push @{$options{l4p_post_config_subs}}, sub { $self->post_init() };
bless $self, $class;
}
###########################################
sub log {
###########################################
my($self, %params) = @_;
local $Log::Log4perl::caller_depth =
$Log::Log4perl::caller_depth + 2;
# Do we need to discard a message because there's already
# max_size messages in the buffer?
if(defined $self->{max_messages} and
@{$self->{buffer}} == $self->{max_messages}) {
shift @{$self->{buffer}};
}
# Ask the appender to save a cached message in $cache
$self->{app}->SUPER::log(\%params,
$params{log4p_category},
$params{log4p_level}, \my $cache);
# Save it in the appender's message buffer
push @{ $self->{buffer} }, $cache;
$self->flush() if $self->{trigger}->($self, \%params);
}
###########################################
sub flush {
###########################################
my($self) = @_;
# Flush pending messages if we have any
for my $cache (@{$self->{buffer}}) {
$self->{app}->SUPER::log_cached($cache);
}
# Empty buffer
$self->{buffer} = [];
}
###########################################
sub post_init {
###########################################
my($self) = @_;
if(! exists $self->{appender}) {
die "No appender defined for " . __PACKAGE__;
}
my $appenders = Log::Log4perl->appenders();
my $appender = Log::Log4perl->appenders()->{$self->{appender}};
if(! defined $appender) {
die "Appender $self->{appender} not defined (yet) when " .
__PACKAGE__ . " needed it";
}
$self->{app} = $appender;
}
###########################################
sub level_trigger {
###########################################
my($level) = @_;
# closure holding $level
return sub {
my($self, $params) = @_;
return Log::Log4perl::Level::to_priority(
$params->{log4p_level}) >=
Log::Log4perl::Level::to_priority($level);
};
}
###########################################
sub DESTROY {
###########################################
my($self) = @_;
}
1;
__END__
=head1 NAME
Log::Log4perl::Appender::Buffer - Buffering Appender
=head1 SYNOPSIS
use Log::Log4perl qw(:easy);
my $conf = qq(
log4perl.category = DEBUG, Buffer
# Regular Screen Appender
log4perl.appender.Screen = Log::Log4perl::Appender::Screen
log4perl.appender.Screen.stdout = 1
log4perl.appender.Screen.layout = PatternLayout
log4perl.appender.Screen.layout.ConversionPattern = %d %p %c %m %n
# Buffering appender, using the appender above as outlet
log4perl.appender.Buffer = Log::Log4perl::Appender::Buffer
log4perl.appender.Buffer.appender = Screen
log4perl.appender.Buffer.trigger_level = ERROR
);
Log::Log4perl->init(\$conf);
DEBUG("This message gets buffered.");
INFO("This message gets buffered also.");
# Time passes. Nothing happens. But then ...
print "It's GO time!!!\n";
ERROR("This message triggers a buffer flush.");
=head1 DESCRIPTION
C<Log::Log4perl::Appender::Buffer> takes these arguments:
=over 4
=item C<appender>
Specifies the name of the appender it buffers messages for. The
appender specified must be defined somewhere in the configuration file,
not necessarily before the definition of
C<Log::Log4perl::Appender::Buffer>.
=item C<max_messages>
Specifies the maximum number of messages the appender will hold in
its ring buffer. C<max_messages> is optional. By default,
C<Log::Log4perl::Appender::Buffer> will I<not> limit the number of
messages buffered. This might be undesirable in long-running processes
accumulating lots of messages before a flush happens. If
C<max_messages> is set to a numeric value,
C<Log::Log4perl::Appender::Buffer> will displace old messages in its
buffer to make room if the buffer is full.
=item C<trigger_level>
If trigger_level is set to one of Log4perl's levels (see
Log::Log4perl::Level), a C<trigger> function will be defined internally
to flush the buffer if a message with a priority of $level or higher
comes along. This is just a convenience function. Defining
log4perl.appender.Buffer.trigger_level = ERROR
is equivalent to creating a trigger function like
log4perl.appender.Buffer.trigger = sub { \
my($self, $params) = @_; \
return $params->{log4p_level} >= \
$Log::Log4perl::Level::ERROR; }
See the next section for defining generic trigger functions.
=item C<trigger>
C<trigger> holds a reference to a subroutine, which
C<Log::Log4perl::Appender::Buffer> will call on every incoming message
with the same parameters as the appender's C<log()> method:
my($self, $params) = @_;
C<$params> references a hash containing
the message priority (key C<l4p_level>), the
message category (key C<l4p_category>) and the content of the message
(key C<message>).
If the subroutine returns 1, it will trigger a flush of buffered messages.
Shortcut
=back
=head1 DEVELOPMENT NOTES
C<Log::Log4perl::Appender::Buffer> is a I<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 I<not> applied to the sub-appender. Same applies to appender
thresholds. This behaviour might change in the future.
=head1 COPYRIGHT AND LICENSE
Copyright 2002-2009 by Mike Schilli E<lt>m@perlmeister.comE<gt>
and Kevin Goess E<lt>cpan@goess.orgE<gt>.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|