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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
###########################################
# Test Suite for Composite Appenders
# Mike Schilli, 2004 (m@perlmeister.com)
###########################################
BEGIN {
if($ENV{INTERNAL_DEBUG}) {
require Log::Log4perl::InternalDebug;
Log::Log4perl::InternalDebug->enable();
}
}
use warnings;
use strict;
use Test::More;
BEGIN {
eval {
require Storable;
};
if ($@) {
plan skip_all => "only with Storable"; # Limit.pm needs it and
# early Perl versions dont
# have it.
}else{
plan tests => 20;
}
}
use Log::Log4perl qw(get_logger :levels);
use Log::Log4perl::Level;
use Log::Log4perl::Appender::TestBuffer;
ok(1); # If we made it this far, we/re ok.
##################################################
# Limit Appender
##################################################
# Reset appender population
Log::Log4perl::Appender::TestBuffer->reset();
my $conf = qq(
log4perl.category = WARN, Limiter
# Email appender
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
);
Log::Log4perl->init(\$conf);
my $logger = get_logger("");
$logger->warn("This message will be sent immediately");
$logger->warn("This message will be delayed by one hour.");
my $buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
like($buffer->buffer(), qr/immediately/);
unlike($buffer->buffer(), qr/delayed/);
# Now flush the limiter and check again. The delayed message should now
# be there.
my $limit = Log::Log4perl->appenders()->{Limiter};
$limit->flush();
like($buffer->buffer(), qr/immediately/);
like($buffer->buffer(), qr/delayed/);
$buffer->reset();
# Nothing to flush
$limit->flush();
is($buffer->buffer(), "");
##################################################
# Flush method
##################################################
$conf .= <<EOT;
log4perl.appender.Limiter.appender_method_on_flush = clear
EOT
Log::Log4perl->init(\$conf);
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
$logger = get_logger("");
$logger->warn("This message will be queued but discarded on flush.");
$limit = Log::Log4perl->appenders()->{Limiter};
$limit->flush();
is($buffer->buffer(), "");
##################################################
# Limit Appender with max_until_discard
##################################################
# Reset appender population
Log::Log4perl::Appender::TestBuffer->reset();
$conf = qq(
log4perl.category = WARN, Limiter
# Email appender
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
log4perl.appender.Limiter.max_until_discarded = 1
);
Log::Log4perl->init(\$conf);
$logger = get_logger("");
$logger->warn("This message will be sent immediately");
for(1..10) {
$logger->warn("This message will be discarded");
}
# Artificially flush the limit appender
$limit = Log::Log4perl->appenders()->{Limiter};
$limit->flush();
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
like($buffer->buffer(), qr/immediately/);
unlike($buffer->buffer(), qr/discarded/);
##################################################
# Limit Appender with max_until_discard
##################################################
# Reset appender population
Log::Log4perl::Appender::TestBuffer->reset();
$conf = qq(
log4perl.category = WARN, Limiter
# Email appender
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
log4perl.appender.Limiter.max_until_discarded = 1
);
Log::Log4perl->init(\$conf);
$logger = get_logger("");
$logger->warn("This message will be sent immediately");
for(1..10) {
$logger->warn("This message will be discarded");
}
# Artificially flush the limit appender
$limit = Log::Log4perl->appenders()->{Limiter};
$limit->flush();
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
like($buffer->buffer(), qr/immediately/);
unlike($buffer->buffer(), qr/discarded/);
##################################################
# Limit Appender with max_until_flushed
##################################################
# Reset appender population
Log::Log4perl::Appender::TestBuffer->reset();
$conf = qq(
log4perl.category = WARN, Limiter
# Email appender
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
log4perl.appender.Limiter.max_until_flushed = 2
);
Log::Log4perl->init(\$conf);
$logger = get_logger("");
$logger->warn("This message will be sent immediately");
$logger->warn("This message won't show right away");
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
like($buffer->buffer(), qr/immediately/);
unlike($buffer->buffer(), qr/right away/);
$logger->warn("This message will show right away");
like($buffer->buffer(), qr/right away/);
#################################
#demonstrating bug in Limiter.pm regarding $_
# Reset appender population
Log::Log4perl::Appender::TestBuffer->reset();
{package My::Test::Appender;
our @ISA = ('Log::Log4perl::Appender::TestBuffer');
sub new {
my $self = shift;
$_ = ''; #aye, there's the rub!
$self->SUPER::new;
}
}
$conf = qq(
log4perl.category = WARN, Limiter
log4perl.appender.Buffer = My::Test::Appender
log4perl.appender.Buffer.layout = SimpleLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d %m %n
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
);
Log::Log4perl->init(\$conf);
ok(1);
### API initialization
#
Log::Log4perl->reset();
my $bufApp = Log::Log4perl::Appender->new(
'Log::Log4perl::Appender::TestBuffer',
name => 'MyBuffer',
);
$bufApp->layout(
Log::Log4perl::Layout::PatternLayout::Multiline->new(
'%m%n')
);
# Make the appender known to the system (without assigning it to
# any logger
Log::Log4perl->add_appender( $bufApp );
my $limitApp = Log::Log4perl::Appender->new(
'Log::Log4perl::Appender::Limit',
name => 'MyLimit',
appender => 'MyBuffer',
key => 'nem',
);
$limitApp->post_init();
$limitApp->composite(1);
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("MyBuffer");
get_logger("")->add_appender($limitApp);
get_logger("")->level($DEBUG);
get_logger("wonk")->debug("waah!");
is($buffer->buffer(), "waah!\n", "composite api init");
### Wrong %M with caching appender
#
Log::Log4perl->reset();
Log::Log4perl::Appender::TestBuffer->reset();
$conf = qq(
log4perl.category = WARN, Limiter
# TestBuffer appender
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.layout.ConversionPattern=%d cat=%c meth=%M %m %n
# Limiting appender, using the email appender above
log4perl.appender.Limiter = Log::Log4perl::Appender::Limit
log4perl.appender.Limiter.appender = Buffer
log4perl.appender.Limiter.block_period = 3600
log4perl.appender.Limiter.max_until_flushed = 2
);
Log::Log4perl->init(\$conf);
$logger = get_logger();
$logger->warn("Sent from main");
package Willy::Wonka;
sub func {
use Log::Log4perl qw(get_logger);
my $logger = get_logger();
$logger->warn("Sent from func");
}
package main;
Willy::Wonka::func();
$logger->warn("Sent from main");
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
like($buffer->buffer(),
qr/cat=main meth=main::.*cat=Willy.Wonka meth=Willy::Wonka::func/s,
"%M/%c with composite appender");
### Different caller stacks with normal vs. composite appenders
Log::Log4perl->reset();
$conf = qq(
log4perl.category = WARN, Buffer1, Composite
# 1st TestBuffer appender
log4perl.appender.Buffer1 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer1.layout = PatternLayout
log4perl.appender.Buffer1.layout.ConversionPattern=meth=%M %m %n
# 2nd TestBuffer appender
log4perl.appender.Buffer2 = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer2.layout = PatternLayout
log4perl.appender.Buffer2.layout.ConversionPattern=meth=%M %m %n
# Composite Appender
log4perl.appender.Composite = Log::Log4perl::Appender::Buffer
log4perl.appender.Composite.appender = Buffer2
log4perl.appender.Composite.trigger = sub { 1 }
);
Log::Log4perl->init(\$conf);
my $buffer1 = Log::Log4perl::Appender::TestBuffer->by_name("Buffer1");
my $buffer2 = Log::Log4perl::Appender::TestBuffer->by_name("Buffer2");
$logger = get_logger();
$logger->warn("Sent from main");
Willy::Wonka::func();
like $buffer1->buffer(),
qr/meth=main:: Sent from main.*meth=Willy::Wonka::func Sent from func/s,
"caller stack from direct appender";
like $buffer2->buffer(),
qr/meth=main:: Sent from main.*meth=Willy::Wonka::func Sent from func/s,
"caller stack from composite appender";
# [RT 72056] Appender Threshold blocks composite appender
$conf = qq(
log4perl.category = DEBUG, Composite
log4perl.appender.Buffer = Log::Log4perl::Appender::TestBuffer
log4perl.appender.Buffer.layout = PatternLayout
log4perl.appender.Buffer.Threshold=INFO
log4perl.appender.Buffer.layout.ConversionPattern=%M %m %n
# Composite Appender
log4perl.appender.Composite = Log::Log4perl::Appender::Buffer
log4perl.appender.Composite.appender = Buffer
log4perl.appender.Composite.trigger = sub { 0 }
);
Log::Log4perl->init(\$conf);
$buffer = Log::Log4perl::Appender::TestBuffer->by_name("Buffer");
$logger = get_logger();
$logger->debug("this will be blocked by the appender threshold");
my $composite = Log::Log4perl->appender_by_name("Composite");
$composite->flush();
is $buffer->buffer(), "",
"appender threshold blocks message in composite appender";
|
