1 |
root |
1.1 |
=head1 NAME |
2 |
|
|
|
3 |
|
|
AnyEvent::Log - simple logging "framework" |
4 |
|
|
|
5 |
|
|
=head1 SYNOPSIS |
6 |
|
|
|
7 |
root |
1.25 |
Simple uses: |
8 |
root |
1.24 |
|
9 |
root |
1.8 |
use AnyEvent; |
10 |
|
|
|
11 |
|
|
AE::log debug => "hit my knee"; |
12 |
|
|
AE::log warn => "it's a bit too hot"; |
13 |
|
|
AE::log error => "the flag was false!"; |
14 |
root |
1.23 |
AE::log fatal => "the bit toggled! run!"; # never returns |
15 |
root |
1.8 |
|
16 |
root |
1.25 |
"Complex" uses (for speed sensitive code): |
17 |
root |
1.24 |
|
18 |
root |
1.1 |
use AnyEvent::Log; |
19 |
|
|
|
20 |
root |
1.8 |
my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
21 |
|
|
|
22 |
|
|
$tracer->("i am here") if $trace; |
23 |
|
|
$tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
24 |
|
|
|
25 |
root |
1.25 |
Configuration (also look at the EXAMPLES section): |
26 |
root |
1.10 |
|
27 |
root |
1.18 |
# set logging for the current package to errors and higher only |
28 |
root |
1.16 |
AnyEvent::Log::ctx->level ("error"); |
29 |
root |
1.10 |
|
30 |
root |
1.23 |
# set logging level to suppress anything below "notice" |
31 |
root |
1.18 |
$AnyEvent::Log::FILTER->level ("notice"); |
32 |
root |
1.10 |
|
33 |
root |
1.23 |
# send all critical and higher priority messages to syslog, |
34 |
|
|
# regardless of (most) other settings |
35 |
|
|
$AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
36 |
|
|
level => "critical", |
37 |
|
|
log_to_syslog => 0, |
38 |
|
|
); |
39 |
|
|
|
40 |
root |
1.1 |
=head1 DESCRIPTION |
41 |
|
|
|
42 |
root |
1.2 |
This module implements a relatively simple "logging framework". It doesn't |
43 |
|
|
attempt to be "the" logging solution or even "a" logging solution for |
44 |
|
|
AnyEvent - AnyEvent simply creates logging messages internally, and this |
45 |
|
|
module more or less exposes the mechanism, with some extra spiff to allow |
46 |
|
|
using it from other modules as well. |
47 |
|
|
|
48 |
root |
1.20 |
Remember that the default verbosity level is C<0> (C<off>), so nothing |
49 |
|
|
will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
50 |
|
|
before starting your program, or change the logging level at runtime with |
51 |
root |
1.9 |
something like: |
52 |
root |
1.2 |
|
53 |
root |
1.18 |
use AnyEvent::Log; |
54 |
|
|
AnyEvent::Log::FILTER->level ("info"); |
55 |
root |
1.2 |
|
56 |
root |
1.10 |
The design goal behind this module was to keep it simple (and small), |
57 |
|
|
but make it powerful enough to be potentially useful for any module, and |
58 |
|
|
extensive enough for the most common tasks, such as logging to multiple |
59 |
|
|
targets, or being able to log into a database. |
60 |
|
|
|
61 |
root |
1.14 |
The amount of documentation might indicate otherwise, but the module is |
62 |
root |
1.18 |
still just below 300 lines of code. |
63 |
|
|
|
64 |
|
|
=head1 LOGGING LEVELS |
65 |
|
|
|
66 |
|
|
Logging levels in this module range from C<1> (highest priority) to C<9> |
67 |
|
|
(lowest priority). Note that the lowest numerical value is the highest |
68 |
|
|
priority, so when this document says "higher priority" it means "lower |
69 |
|
|
numerical value". |
70 |
|
|
|
71 |
|
|
Instead of specifying levels by name you can also specify them by aliases: |
72 |
|
|
|
73 |
|
|
LVL NAME SYSLOG PERL NOTE |
74 |
|
|
1 fatal emerg exit aborts program! |
75 |
|
|
2 alert |
76 |
|
|
3 critical crit |
77 |
|
|
4 error err die |
78 |
|
|
5 warn warning |
79 |
|
|
6 note notice |
80 |
|
|
7 info |
81 |
|
|
8 debug |
82 |
|
|
9 trace |
83 |
|
|
|
84 |
|
|
As you can see, some logging levels have multiple aliases - the first one |
85 |
|
|
is the "official" name, the second one the "syslog" name (if it differs) |
86 |
|
|
and the third one the "perl" name, suggesting that you log C<die> messages |
87 |
|
|
at C<error> priority. |
88 |
|
|
|
89 |
|
|
You can normally only log a single message at highest priority level |
90 |
|
|
(C<1>, C<fatal>), because logging a fatal message will also quit the |
91 |
|
|
program - so use it sparingly :) |
92 |
|
|
|
93 |
|
|
Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
94 |
|
|
or C<all> - these are only valid in the methods they are documented for. |
95 |
root |
1.14 |
|
96 |
root |
1.9 |
=head1 LOGGING FUNCTIONS |
97 |
root |
1.2 |
|
98 |
|
|
These functions allow you to log messages. They always use the caller's |
99 |
root |
1.18 |
package as a "logging context". Also, the main logging function C<log> is |
100 |
root |
1.7 |
callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is |
101 |
|
|
loaded. |
102 |
root |
1.1 |
|
103 |
|
|
=over 4 |
104 |
|
|
|
105 |
|
|
=cut |
106 |
|
|
|
107 |
|
|
package AnyEvent::Log; |
108 |
|
|
|
109 |
root |
1.2 |
use Carp (); |
110 |
root |
1.1 |
use POSIX (); |
111 |
|
|
|
112 |
|
|
use AnyEvent (); BEGIN { AnyEvent::common_sense } |
113 |
root |
1.3 |
use AnyEvent::Util (); |
114 |
root |
1.1 |
|
115 |
root |
1.14 |
our $VERSION = $AnyEvent::VERSION; |
116 |
|
|
|
117 |
root |
1.18 |
our ($COLLECT, $FILTER, $LOG); |
118 |
|
|
|
119 |
root |
1.2 |
our ($now_int, $now_str1, $now_str2); |
120 |
|
|
|
121 |
|
|
# Format Time, not public - yet? |
122 |
|
|
sub ft($) { |
123 |
|
|
my $i = int $_[0]; |
124 |
|
|
my $f = sprintf "%06d", 1e6 * ($_[0] - $i); |
125 |
|
|
|
126 |
|
|
($now_int, $now_str1, $now_str2) = ($i, split /\x01/, POSIX::strftime "%Y-%m-%d %H:%M:%S.\x01 %z", localtime $i) |
127 |
|
|
if $now_int != $i; |
128 |
|
|
|
129 |
|
|
"$now_str1$f$now_str2" |
130 |
|
|
} |
131 |
|
|
|
132 |
root |
1.18 |
our %CTX; # all package contexts |
133 |
root |
1.3 |
|
134 |
root |
1.8 |
# creates a default package context object for the given package |
135 |
|
|
sub _pkg_ctx($) { |
136 |
root |
1.10 |
my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx"; |
137 |
root |
1.8 |
|
138 |
|
|
# link "parent" package |
139 |
root |
1.18 |
my $parent = $_[0] =~ /^(.+)::/ |
140 |
|
|
? $CTX{$1} ||= &_pkg_ctx ("$1") |
141 |
|
|
: $COLLECT; |
142 |
root |
1.8 |
|
143 |
root |
1.18 |
$ctx->[2]{$parent+0} = $parent; |
144 |
root |
1.8 |
|
145 |
|
|
$ctx |
146 |
|
|
} |
147 |
|
|
|
148 |
root |
1.2 |
=item AnyEvent::Log::log $level, $msg[, @args] |
149 |
|
|
|
150 |
root |
1.22 |
Requests logging of the given C<$msg> with the given log level, and |
151 |
|
|
returns true if the message was logged I<somewhere>. |
152 |
root |
1.2 |
|
153 |
|
|
For C<fatal> log levels, the program will abort. |
154 |
|
|
|
155 |
|
|
If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
156 |
|
|
C<$msg> is interpreted as an sprintf format string. |
157 |
|
|
|
158 |
|
|
The C<$msg> should not end with C<\n>, but may if that is convenient for |
159 |
|
|
you. Also, multiline messages are handled properly. |
160 |
|
|
|
161 |
root |
1.3 |
Last not least, C<$msg> might be a code reference, in which case it is |
162 |
|
|
supposed to return the message. It will be called only then the message |
163 |
|
|
actually gets logged, which is useful if it is costly to create the |
164 |
|
|
message in the first place. |
165 |
root |
1.2 |
|
166 |
|
|
Whether the given message will be logged depends on the maximum log level |
167 |
root |
1.22 |
and the caller's package. The return value can be used to ensure that |
168 |
|
|
messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
169 |
|
|
runtime error it tries to log it at C<die> level, but if that message is |
170 |
|
|
lost it simply uses warn. |
171 |
root |
1.2 |
|
172 |
|
|
Note that you can (and should) call this function as C<AnyEvent::log> or |
173 |
root |
1.8 |
C<AE::log>, without C<use>-ing this module if possible (i.e. you don't |
174 |
|
|
need any additional functionality), as those functions will load the |
175 |
|
|
logging module on demand only. They are also much shorter to write. |
176 |
|
|
|
177 |
root |
1.11 |
Also, if you optionally generate a lot of debug messages (such as when |
178 |
root |
1.8 |
tracing some code), you should look into using a logger callback and a |
179 |
|
|
boolean enabler (see C<logger>, below). |
180 |
root |
1.2 |
|
181 |
root |
1.3 |
Example: log something at error level. |
182 |
|
|
|
183 |
|
|
AE::log error => "something"; |
184 |
|
|
|
185 |
|
|
Example: use printf-formatting. |
186 |
|
|
|
187 |
|
|
AE::log info => "%5d %-10.10s %s", $index, $category, $msg; |
188 |
|
|
|
189 |
|
|
Example: only generate a costly dump when the message is actually being logged. |
190 |
|
|
|
191 |
|
|
AE::log debug => sub { require Data::Dump; Data::Dump::dump \%cache }; |
192 |
|
|
|
193 |
root |
1.2 |
=cut |
194 |
|
|
|
195 |
|
|
# also allow syslog equivalent names |
196 |
|
|
our %STR2LEVEL = ( |
197 |
root |
1.18 |
fatal => 1, emerg => 1, exit => 1, |
198 |
root |
1.2 |
alert => 2, |
199 |
|
|
critical => 3, crit => 3, |
200 |
root |
1.18 |
error => 4, err => 4, die => 4, |
201 |
root |
1.2 |
warn => 5, warning => 5, |
202 |
|
|
note => 6, notice => 6, |
203 |
|
|
info => 7, |
204 |
|
|
debug => 8, |
205 |
|
|
trace => 9, |
206 |
|
|
); |
207 |
|
|
|
208 |
root |
1.4 |
sub now () { time } |
209 |
root |
1.10 |
|
210 |
root |
1.4 |
AnyEvent::post_detect { |
211 |
|
|
*now = \&AE::now; |
212 |
|
|
}; |
213 |
|
|
|
214 |
root |
1.2 |
our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
215 |
|
|
|
216 |
root |
1.8 |
# time, ctx, level, msg |
217 |
|
|
sub _format($$$$) { |
218 |
root |
1.11 |
my $ts = ft $_[0]; |
219 |
|
|
my $ct = " "; |
220 |
|
|
|
221 |
root |
1.10 |
my @res; |
222 |
root |
1.8 |
|
223 |
root |
1.10 |
for (split /\n/, sprintf "%-5s %s: %s", $LEVEL2STR[$_[2]], $_[1][0], $_[3]) { |
224 |
root |
1.11 |
push @res, "$ts$ct$_\n"; |
225 |
|
|
$ct = " + "; |
226 |
root |
1.10 |
} |
227 |
|
|
|
228 |
|
|
join "", @res |
229 |
root |
1.8 |
} |
230 |
|
|
|
231 |
root |
1.3 |
sub _log { |
232 |
root |
1.8 |
my ($ctx, $level, $format, @args) = @_; |
233 |
root |
1.2 |
|
234 |
root |
1.11 |
$level = $level > 0 && $level <= 9 |
235 |
|
|
? $level+0 |
236 |
|
|
: $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
237 |
root |
1.2 |
|
238 |
root |
1.8 |
my $mask = 1 << $level; |
239 |
root |
1.2 |
|
240 |
root |
1.22 |
my ($success, %seen, @ctx, $now, $fmt); |
241 |
root |
1.8 |
|
242 |
root |
1.11 |
do |
243 |
|
|
{ |
244 |
|
|
# skip if masked |
245 |
|
|
if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
246 |
|
|
if ($ctx->[3]) { |
247 |
|
|
# logging target found |
248 |
|
|
|
249 |
|
|
# now get raw message, unless we have it already |
250 |
|
|
unless ($now) { |
251 |
|
|
$format = $format->() if ref $format; |
252 |
|
|
$format = sprintf $format, @args if @args; |
253 |
|
|
$format =~ s/\n$//; |
254 |
|
|
$now = AE::now; |
255 |
|
|
}; |
256 |
|
|
|
257 |
|
|
# format msg |
258 |
|
|
my $str = $ctx->[4] |
259 |
|
|
? $ctx->[4]($now, $_[0], $level, $format) |
260 |
root |
1.20 |
: ($fmt ||= _format $now, $_[0], $level, $format); |
261 |
root |
1.11 |
|
262 |
root |
1.22 |
$success = 1; |
263 |
|
|
|
264 |
root |
1.21 |
$ctx->[3]($str) |
265 |
root |
1.18 |
or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
266 |
|
|
} else { |
267 |
|
|
push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
268 |
root |
1.11 |
} |
269 |
|
|
} |
270 |
root |
1.8 |
} |
271 |
root |
1.11 |
while $ctx = pop @ctx; |
272 |
root |
1.2 |
|
273 |
|
|
exit 1 if $level <= 1; |
274 |
root |
1.22 |
|
275 |
|
|
$success |
276 |
root |
1.2 |
} |
277 |
|
|
|
278 |
root |
1.3 |
sub log($$;@) { |
279 |
root |
1.8 |
_log |
280 |
|
|
$CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
281 |
|
|
@_; |
282 |
root |
1.3 |
} |
283 |
|
|
|
284 |
root |
1.2 |
*AnyEvent::log = *AE::log = \&log; |
285 |
|
|
|
286 |
root |
1.3 |
=item $logger = AnyEvent::Log::logger $level[, \$enabled] |
287 |
|
|
|
288 |
|
|
Creates a code reference that, when called, acts as if the |
289 |
root |
1.22 |
C<AnyEvent::Log::log> function was called at this point with the given |
290 |
root |
1.3 |
level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
291 |
|
|
the C<AnyEvent::Log::log> function: |
292 |
|
|
|
293 |
|
|
my $debug_log = AnyEvent::Log::logger "debug"; |
294 |
|
|
|
295 |
|
|
$debug_log->("debug here"); |
296 |
|
|
$debug_log->("%06d emails processed", 12345); |
297 |
|
|
$debug_log->(sub { $obj->as_string }); |
298 |
|
|
|
299 |
|
|
The idea behind this function is to decide whether to log before actually |
300 |
|
|
logging - when the C<logger> function is called once, but the returned |
301 |
|
|
logger callback often, then this can be a tremendous speed win. |
302 |
|
|
|
303 |
|
|
Despite this speed advantage, changes in logging configuration will |
304 |
|
|
still be reflected by the logger callback, even if configuration changes |
305 |
|
|
I<after> it was created. |
306 |
|
|
|
307 |
|
|
To further speed up logging, you can bind a scalar variable to the logger, |
308 |
|
|
which contains true if the logger should be called or not - if it is |
309 |
|
|
false, calling the logger can be safely skipped. This variable will be |
310 |
|
|
updated as long as C<$logger> is alive. |
311 |
|
|
|
312 |
|
|
Full example: |
313 |
|
|
|
314 |
|
|
# near the init section |
315 |
|
|
use AnyEvent::Log; |
316 |
|
|
|
317 |
|
|
my $debug_log = AnyEvent:Log::logger debug => \my $debug; |
318 |
|
|
|
319 |
|
|
# and later in your program |
320 |
|
|
$debug_log->("yo, stuff here") if $debug; |
321 |
|
|
|
322 |
|
|
$debug and $debug_log->("123"); |
323 |
|
|
|
324 |
|
|
=cut |
325 |
|
|
|
326 |
|
|
our %LOGGER; |
327 |
|
|
|
328 |
|
|
# re-assess logging status for all loggers |
329 |
|
|
sub _reassess { |
330 |
root |
1.17 |
local $SIG{__DIE__}; |
331 |
|
|
my $die = sub { die }; |
332 |
|
|
|
333 |
root |
1.3 |
for (@_ ? $LOGGER{$_[0]} : values %LOGGER) { |
334 |
root |
1.8 |
my ($ctx, $level, $renabled) = @$_; |
335 |
root |
1.3 |
|
336 |
root |
1.17 |
# to detect whether a message would be logged, we actually |
337 |
root |
1.11 |
# try to log one and die. this isn't fast, but we can be |
338 |
root |
1.3 |
# sure that the logging decision is correct :) |
339 |
|
|
|
340 |
|
|
$$renabled = !eval { |
341 |
root |
1.17 |
_log $ctx, $level, $die; |
342 |
root |
1.3 |
|
343 |
|
|
1 |
344 |
|
|
}; |
345 |
|
|
} |
346 |
|
|
} |
347 |
|
|
|
348 |
root |
1.15 |
sub _logger { |
349 |
root |
1.8 |
my ($ctx, $level, $renabled) = @_; |
350 |
root |
1.3 |
|
351 |
|
|
$$renabled = 1; |
352 |
|
|
|
353 |
root |
1.8 |
my $logger = [$ctx, $level, $renabled]; |
354 |
root |
1.3 |
|
355 |
|
|
$LOGGER{$logger+0} = $logger; |
356 |
|
|
|
357 |
|
|
_reassess $logger+0; |
358 |
|
|
|
359 |
|
|
my $guard = AnyEvent::Util::guard { |
360 |
|
|
# "clean up" |
361 |
|
|
delete $LOGGER{$logger+0}; |
362 |
|
|
}; |
363 |
|
|
|
364 |
|
|
sub { |
365 |
|
|
$guard if 0; # keep guard alive, but don't cause runtime overhead |
366 |
|
|
|
367 |
root |
1.8 |
_log $ctx, $level, @_ |
368 |
root |
1.3 |
if $$renabled; |
369 |
|
|
} |
370 |
|
|
} |
371 |
|
|
|
372 |
root |
1.8 |
sub logger($;$) { |
373 |
|
|
_logger |
374 |
|
|
$CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
375 |
|
|
@_ |
376 |
|
|
} |
377 |
|
|
|
378 |
root |
1.2 |
=back |
379 |
|
|
|
380 |
root |
1.9 |
=head1 LOGGING CONTEXTS |
381 |
root |
1.2 |
|
382 |
root |
1.9 |
This module associates every log message with a so-called I<logging |
383 |
|
|
context>, based on the package of the caller. Every perl package has its |
384 |
|
|
own logging context. |
385 |
root |
1.8 |
|
386 |
root |
1.10 |
A logging context has three major responsibilities: filtering, logging and |
387 |
|
|
propagating the message. |
388 |
root |
1.9 |
|
389 |
root |
1.10 |
For the first purpose, filtering, each context has a set of logging |
390 |
|
|
levels, called the log level mask. Messages not in the set will be ignored |
391 |
|
|
by this context (masked). |
392 |
|
|
|
393 |
|
|
For logging, the context stores a formatting callback (which takes the |
394 |
|
|
timestamp, context, level and string message and formats it in the way |
395 |
|
|
it should be logged) and a logging callback (which is responsible for |
396 |
|
|
actually logging the formatted message and telling C<AnyEvent::Log> |
397 |
|
|
whether it has consumed the message, or whether it should be propagated). |
398 |
root |
1.9 |
|
399 |
root |
1.18 |
For propagation, a context can have any number of attached I<slave |
400 |
root |
1.10 |
contexts>. Any message that is neither masked by the logging mask nor |
401 |
root |
1.18 |
masked by the logging callback returning true will be passed to all slave |
402 |
root |
1.10 |
contexts. |
403 |
root |
1.9 |
|
404 |
root |
1.11 |
Each call to a logging function will log the message at most once per |
405 |
|
|
context, so it does not matter (much) if there are cycles or if the |
406 |
|
|
message can arrive at the same context via multiple paths. |
407 |
|
|
|
408 |
root |
1.9 |
=head2 DEFAULTS |
409 |
|
|
|
410 |
root |
1.10 |
By default, all logging contexts have an full set of log levels ("all"), a |
411 |
root |
1.9 |
disabled logging callback and the default formatting callback. |
412 |
|
|
|
413 |
|
|
Package contexts have the package name as logging title by default. |
414 |
|
|
|
415 |
root |
1.18 |
They have exactly one slave - the context of the "parent" package. The |
416 |
root |
1.9 |
parent package is simply defined to be the package name without the last |
417 |
|
|
component, i.e. C<AnyEvent::Debug::Wrapped> becomes C<AnyEvent::Debug>, |
418 |
root |
1.18 |
and C<AnyEvent> becomes ... C<$AnyEvent::Log::COLLECT> which is the |
419 |
|
|
exception of the rule - just like the "parent" of any single-component |
420 |
|
|
package name in Perl is C<main>, the default slave of any top-level |
421 |
|
|
package context is C<$AnyEvent::Log::COLLECT>. |
422 |
root |
1.9 |
|
423 |
root |
1.18 |
Since perl packages form only an approximate hierarchy, this slave |
424 |
root |
1.9 |
context can of course be removed. |
425 |
|
|
|
426 |
root |
1.18 |
All other (anonymous) contexts have no slaves and an empty title by |
427 |
root |
1.9 |
default. |
428 |
|
|
|
429 |
root |
1.18 |
When the module is loaded it creates the C<$AnyEvent::Log::LOG> logging |
430 |
|
|
context that simply logs everything via C<warn>, without propagating |
431 |
|
|
anything anywhere by default. The purpose of this context is to provide |
432 |
root |
1.12 |
a convenient place to override the global logging target or to attach |
433 |
|
|
additional log targets. It's not meant for filtering. |
434 |
|
|
|
435 |
root |
1.18 |
It then creates the C<$AnyEvent::Log::FILTER> context whose |
436 |
|
|
purpose is to suppress all messages with priority higher |
437 |
|
|
than C<$ENV{PERL_ANYEVENT_VERBOSE}>. It then attached the |
438 |
|
|
C<$AnyEvent::Log::LOG> context to it. The purpose of the filter context |
439 |
|
|
is to simply provide filtering according to some global log level. |
440 |
|
|
|
441 |
|
|
Finally it creates the top-level package context C<$AnyEvent::Log::COLLECT> |
442 |
|
|
and attaches the C<$AnyEvent::Log::FILTER> context to it, but otherwise |
443 |
|
|
leaves it at default config. Its purpose is simply to collect all log |
444 |
|
|
messages system-wide. |
445 |
|
|
|
446 |
|
|
The hierarchy is then: |
447 |
|
|
|
448 |
|
|
any package, eventually -> $COLLECT -> $FILTER -> $LOG |
449 |
|
|
|
450 |
|
|
The effect of all this is that log messages, by default, wander up to the |
451 |
|
|
C<$AnyEvent::Log::COLLECT> context where all messages normally end up, |
452 |
|
|
from there to C<$AnyEvent::Log::FILTER> where log messages with lower |
453 |
|
|
priority then C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered out and then |
454 |
|
|
to the C<$AnyEvent::Log::LOG> context to be passed to C<warn>. |
455 |
|
|
|
456 |
|
|
This makes it easy to set a global logging level (by modifying $FILTER), |
457 |
|
|
but still allow other contexts to send, for example, their debug and trace |
458 |
|
|
messages to the $LOG target despite the global logging level, or to attach |
459 |
|
|
additional log targets that log messages, regardless of the global logging |
460 |
|
|
level. |
461 |
|
|
|
462 |
|
|
It also makes it easy to modify the default warn-logger ($LOG) to |
463 |
|
|
something that logs to a file, or to attach additional logging targets |
464 |
|
|
(such as loggign to a file) by attaching it to $FILTER. |
465 |
root |
1.9 |
|
466 |
root |
1.11 |
=head2 CREATING/FINDING/DESTROYING CONTEXTS |
467 |
root |
1.2 |
|
468 |
|
|
=over 4 |
469 |
|
|
|
470 |
root |
1.8 |
=item $ctx = AnyEvent::Log::ctx [$pkg] |
471 |
|
|
|
472 |
root |
1.9 |
This function creates or returns a logging context (which is an object). |
473 |
root |
1.8 |
|
474 |
root |
1.9 |
If a package name is given, then the context for that packlage is |
475 |
|
|
returned. If it is called without any arguments, then the context for the |
476 |
|
|
callers package is returned (i.e. the same context as a C<AE::log> call |
477 |
|
|
would use). |
478 |
root |
1.8 |
|
479 |
|
|
If C<undef> is given, then it creates a new anonymous context that is not |
480 |
|
|
tied to any package and is destroyed when no longer referenced. |
481 |
|
|
|
482 |
|
|
=cut |
483 |
|
|
|
484 |
|
|
sub ctx(;$) { |
485 |
|
|
my $pkg = @_ ? shift : (caller)[0]; |
486 |
|
|
|
487 |
|
|
ref $pkg |
488 |
|
|
? $pkg |
489 |
|
|
: defined $pkg |
490 |
|
|
? $CTX{$pkg} ||= AnyEvent::Log::_pkg_ctx $pkg |
491 |
root |
1.10 |
: bless [undef, (1 << 10) - 1 - 1], "AnyEvent::Log::Ctx" |
492 |
root |
1.8 |
} |
493 |
|
|
|
494 |
root |
1.11 |
=item AnyEvent::Log::reset |
495 |
|
|
|
496 |
root |
1.16 |
Resets all package contexts and recreates the default hierarchy if |
497 |
|
|
necessary, i.e. resets the logging subsystem to defaults, as much as |
498 |
|
|
possible. This process keeps references to contexts held by other parts of |
499 |
|
|
the program intact. |
500 |
root |
1.11 |
|
501 |
|
|
This can be used to implement config-file (re-)loading: before loading a |
502 |
|
|
configuration, reset all contexts. |
503 |
|
|
|
504 |
|
|
=cut |
505 |
|
|
|
506 |
|
|
sub reset { |
507 |
root |
1.15 |
# hard to kill complex data structures |
508 |
root |
1.19 |
# we "recreate" all package loggers and reset the hierarchy |
509 |
root |
1.15 |
while (my ($k, $v) = each %CTX) { |
510 |
|
|
@$v = ($k, (1 << 10) - 1 - 1, { }); |
511 |
|
|
|
512 |
root |
1.19 |
$v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log::COLLECT); |
513 |
root |
1.15 |
} |
514 |
root |
1.11 |
|
515 |
root |
1.19 |
@$_ = ($_->[0], (1 << 10) - 1 - 1) |
516 |
|
|
for $LOG, $FILTER, $COLLECT; |
517 |
|
|
|
518 |
root |
1.18 |
$LOG->slaves; |
519 |
|
|
$LOG->title ('$AnyEvent::Log::LOG'); |
520 |
|
|
$LOG->log_cb (sub { |
521 |
root |
1.15 |
warn shift; |
522 |
root |
1.8 |
0 |
523 |
|
|
}); |
524 |
root |
1.15 |
|
525 |
root |
1.18 |
$FILTER->slaves ($LOG); |
526 |
|
|
$FILTER->title ('$AnyEvent::Log::FILTER'); |
527 |
|
|
$FILTER->level ($AnyEvent::VERBOSE); |
528 |
|
|
|
529 |
|
|
$COLLECT->slaves ($FILTER); |
530 |
root |
1.19 |
$COLLECT->title ('$AnyEvent::Log::COLLECT'); |
531 |
root |
1.15 |
|
532 |
|
|
_reassess; |
533 |
root |
1.11 |
} |
534 |
|
|
|
535 |
root |
1.15 |
# create the default logger contexts |
536 |
root |
1.18 |
$LOG = ctx undef; |
537 |
|
|
$FILTER = ctx undef; |
538 |
|
|
$COLLECT = ctx undef; |
539 |
root |
1.15 |
|
540 |
root |
1.11 |
AnyEvent::Log::reset; |
541 |
|
|
|
542 |
root |
1.12 |
# hello, CPAN, please catch me |
543 |
root |
1.18 |
package AnyEvent::Log::LOG; |
544 |
|
|
package AE::Log::LOG; |
545 |
|
|
package AnyEvent::Log::FILTER; |
546 |
|
|
package AE::Log::FILTER; |
547 |
|
|
package AnyEvent::Log::COLLECT; |
548 |
|
|
package AE::Log::COLLECT; |
549 |
root |
1.8 |
|
550 |
root |
1.12 |
package AnyEvent::Log::Ctx; |
551 |
|
|
|
552 |
root |
1.18 |
# 0 1 2 3 4 |
553 |
|
|
# [$title, $level, %$slaves, &$logcb, &$fmtcb] |
554 |
root |
1.12 |
|
555 |
|
|
=item $ctx = new AnyEvent::Log::Ctx methodname => param... |
556 |
|
|
|
557 |
|
|
This is a convenience constructor that makes it simpler to construct |
558 |
|
|
anonymous logging contexts. |
559 |
|
|
|
560 |
|
|
Each key-value pair results in an invocation of the method of the same |
561 |
|
|
name as the key with the value as parameter, unless the value is an |
562 |
|
|
arrayref, in which case it calls the method with the contents of the |
563 |
|
|
array. The methods are called in the same order as specified. |
564 |
|
|
|
565 |
|
|
Example: create a new logging context and set both the default logging |
566 |
root |
1.18 |
level, some slave contexts and a logging callback. |
567 |
root |
1.12 |
|
568 |
|
|
$ctx = new AnyEvent::Log::Ctx |
569 |
|
|
title => "dubious messages", |
570 |
|
|
level => "error", |
571 |
|
|
log_cb => sub { print STDOUT shift; 0 }, |
572 |
root |
1.18 |
slaves => [$ctx1, $ctx, $ctx2], |
573 |
root |
1.12 |
; |
574 |
|
|
|
575 |
root |
1.9 |
=back |
576 |
|
|
|
577 |
|
|
=cut |
578 |
|
|
|
579 |
root |
1.12 |
sub new { |
580 |
|
|
my $class = shift; |
581 |
|
|
|
582 |
|
|
my $ctx = AnyEvent::Log::ctx undef; |
583 |
|
|
|
584 |
|
|
while (@_) { |
585 |
|
|
my ($k, $v) = splice @_, 0, 2; |
586 |
|
|
$ctx->$k (ref $v eq "ARRAY" ? @$v : $v); |
587 |
|
|
} |
588 |
|
|
|
589 |
|
|
bless $ctx, $class # do we really support subclassing, hmm? |
590 |
|
|
} |
591 |
root |
1.8 |
|
592 |
|
|
|
593 |
root |
1.9 |
=head2 CONFIGURING A LOG CONTEXT |
594 |
|
|
|
595 |
|
|
The following methods can be used to configure the logging context. |
596 |
|
|
|
597 |
|
|
=over 4 |
598 |
|
|
|
599 |
root |
1.8 |
=item $ctx->title ([$new_title]) |
600 |
|
|
|
601 |
|
|
Returns the title of the logging context - this is the package name, for |
602 |
|
|
package contexts, and a user defined string for all others. |
603 |
|
|
|
604 |
|
|
If C<$new_title> is given, then it replaces the package name or title. |
605 |
|
|
|
606 |
|
|
=cut |
607 |
|
|
|
608 |
|
|
sub title { |
609 |
|
|
$_[0][0] = $_[1] if @_ > 1; |
610 |
|
|
$_[0][0] |
611 |
|
|
} |
612 |
|
|
|
613 |
root |
1.9 |
=back |
614 |
|
|
|
615 |
|
|
=head3 LOGGING LEVELS |
616 |
|
|
|
617 |
root |
1.10 |
The following methods deal with the logging level set associated with the |
618 |
|
|
log context. |
619 |
root |
1.9 |
|
620 |
|
|
The most common method to use is probably C<< $ctx->level ($level) >>, |
621 |
|
|
which configures the specified and any higher priority levels. |
622 |
|
|
|
623 |
root |
1.10 |
All functions which accept a list of levels also accept the special string |
624 |
|
|
C<all> which expands to all logging levels. |
625 |
|
|
|
626 |
root |
1.9 |
=over 4 |
627 |
|
|
|
628 |
root |
1.8 |
=item $ctx->levels ($level[, $level...) |
629 |
|
|
|
630 |
root |
1.10 |
Enables logging for the given levels and disables it for all others. |
631 |
root |
1.8 |
|
632 |
|
|
=item $ctx->level ($level) |
633 |
|
|
|
634 |
|
|
Enables logging for the given level and all lower level (higher priority) |
635 |
root |
1.10 |
ones. In addition to normal logging levels, specifying a level of C<0> or |
636 |
|
|
C<off> disables all logging for this level. |
637 |
root |
1.8 |
|
638 |
|
|
Example: log warnings, errors and higher priority messages. |
639 |
|
|
|
640 |
|
|
$ctx->level ("warn"); |
641 |
|
|
$ctx->level (5); # same thing, just numeric |
642 |
|
|
|
643 |
|
|
=item $ctx->enable ($level[, $level...]) |
644 |
|
|
|
645 |
|
|
Enables logging for the given levels, leaving all others unchanged. |
646 |
root |
1.5 |
|
647 |
root |
1.8 |
=item $ctx->disable ($level[, $level...]) |
648 |
|
|
|
649 |
|
|
Disables logging for the given levels, leaving all others unchanged. |
650 |
|
|
|
651 |
|
|
=cut |
652 |
|
|
|
653 |
|
|
sub _lvl_lst { |
654 |
root |
1.10 |
map { |
655 |
|
|
$_ > 0 && $_ <= 9 ? $_+0 |
656 |
|
|
: $_ eq "all" ? (1 .. 9) |
657 |
|
|
: $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
658 |
|
|
} @_ |
659 |
root |
1.8 |
} |
660 |
|
|
|
661 |
|
|
our $NOP_CB = sub { 0 }; |
662 |
|
|
|
663 |
|
|
sub levels { |
664 |
|
|
my $ctx = shift; |
665 |
|
|
$ctx->[1] = 0; |
666 |
|
|
$ctx->[1] |= 1 << $_ |
667 |
|
|
for &_lvl_lst; |
668 |
|
|
AnyEvent::Log::_reassess; |
669 |
|
|
} |
670 |
|
|
|
671 |
|
|
sub level { |
672 |
|
|
my $ctx = shift; |
673 |
root |
1.10 |
my $lvl = $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1]; |
674 |
|
|
|
675 |
root |
1.8 |
$ctx->[1] = ((1 << $lvl) - 1) << 1; |
676 |
|
|
AnyEvent::Log::_reassess; |
677 |
|
|
} |
678 |
|
|
|
679 |
|
|
sub enable { |
680 |
|
|
my $ctx = shift; |
681 |
|
|
$ctx->[1] |= 1 << $_ |
682 |
|
|
for &_lvl_lst; |
683 |
|
|
AnyEvent::Log::_reassess; |
684 |
|
|
} |
685 |
|
|
|
686 |
|
|
sub disable { |
687 |
|
|
my $ctx = shift; |
688 |
|
|
$ctx->[1] &= ~(1 << $_) |
689 |
|
|
for &_lvl_lst; |
690 |
|
|
AnyEvent::Log::_reassess; |
691 |
|
|
} |
692 |
|
|
|
693 |
root |
1.9 |
=back |
694 |
|
|
|
695 |
root |
1.18 |
=head3 SLAVE CONTEXTS |
696 |
root |
1.9 |
|
697 |
|
|
The following methods attach and detach another logging context to a |
698 |
|
|
logging context. |
699 |
|
|
|
700 |
root |
1.18 |
Log messages are propagated to all slave contexts, unless the logging |
701 |
root |
1.9 |
callback consumes the message. |
702 |
|
|
|
703 |
|
|
=over 4 |
704 |
|
|
|
705 |
root |
1.8 |
=item $ctx->attach ($ctx2[, $ctx3...]) |
706 |
|
|
|
707 |
root |
1.18 |
Attaches the given contexts as slaves to this context. It is not an error |
708 |
root |
1.8 |
to add a context twice (the second add will be ignored). |
709 |
|
|
|
710 |
|
|
A context can be specified either as package name or as a context object. |
711 |
|
|
|
712 |
|
|
=item $ctx->detach ($ctx2[, $ctx3...]) |
713 |
|
|
|
714 |
root |
1.18 |
Removes the given slaves from this context - it's not an error to attempt |
715 |
root |
1.8 |
to remove a context that hasn't been added. |
716 |
|
|
|
717 |
|
|
A context can be specified either as package name or as a context object. |
718 |
root |
1.5 |
|
719 |
root |
1.18 |
=item $ctx->slaves ($ctx2[, $ctx3...]) |
720 |
root |
1.11 |
|
721 |
root |
1.18 |
Replaces all slaves attached to this context by the ones given. |
722 |
root |
1.11 |
|
723 |
root |
1.2 |
=cut |
724 |
|
|
|
725 |
root |
1.8 |
sub attach { |
726 |
|
|
my $ctx = shift; |
727 |
|
|
|
728 |
|
|
$ctx->[2]{$_+0} = $_ |
729 |
|
|
for map { AnyEvent::Log::ctx $_ } @_; |
730 |
|
|
} |
731 |
|
|
|
732 |
|
|
sub detach { |
733 |
|
|
my $ctx = shift; |
734 |
|
|
|
735 |
|
|
delete $ctx->[2]{$_+0} |
736 |
|
|
for map { AnyEvent::Log::ctx $_ } @_; |
737 |
|
|
} |
738 |
|
|
|
739 |
root |
1.18 |
sub slaves { |
740 |
root |
1.11 |
undef $_[0][2]; |
741 |
|
|
&attach; |
742 |
|
|
} |
743 |
|
|
|
744 |
root |
1.9 |
=back |
745 |
|
|
|
746 |
root |
1.18 |
=head3 LOG TARGETS |
747 |
root |
1.9 |
|
748 |
|
|
The following methods configure how the logging context actually does |
749 |
root |
1.10 |
the logging (which consists of formatting the message and printing it or |
750 |
root |
1.18 |
whatever it wants to do with it). |
751 |
root |
1.9 |
|
752 |
|
|
=over 4 |
753 |
|
|
|
754 |
root |
1.21 |
=item $ctx->log_cb ($cb->($str) |
755 |
root |
1.5 |
|
756 |
root |
1.8 |
Replaces the logging callback on the context (C<undef> disables the |
757 |
|
|
logging callback). |
758 |
root |
1.5 |
|
759 |
root |
1.8 |
The logging callback is responsible for handling formatted log messages |
760 |
|
|
(see C<fmt_cb> below) - normally simple text strings that end with a |
761 |
root |
1.21 |
newline (and are possibly multiline themselves). |
762 |
root |
1.8 |
|
763 |
|
|
It also has to return true iff it has consumed the log message, and false |
764 |
|
|
if it hasn't. Consuming a message means that it will not be sent to any |
765 |
root |
1.18 |
slave context. When in doubt, return C<0> from your logging callback. |
766 |
root |
1.8 |
|
767 |
|
|
Example: a very simple logging callback, simply dump the message to STDOUT |
768 |
|
|
and do not consume it. |
769 |
|
|
|
770 |
|
|
$ctx->log_cb (sub { print STDERR shift; 0 }); |
771 |
|
|
|
772 |
root |
1.10 |
You can filter messages by having a log callback that simply returns C<1> |
773 |
|
|
and does not do anything with the message, but this counts as "message |
774 |
|
|
being logged" and might not be very efficient. |
775 |
|
|
|
776 |
|
|
Example: propagate all messages except for log levels "debug" and |
777 |
|
|
"trace". The messages will still be generated, though, which can slow down |
778 |
|
|
your program. |
779 |
|
|
|
780 |
|
|
$ctx->levels ("debug", "trace"); |
781 |
|
|
$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages |
782 |
|
|
|
783 |
root |
1.20 |
=item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message)) |
784 |
root |
1.8 |
|
785 |
root |
1.10 |
Replaces the formatting callback on the context (C<undef> restores the |
786 |
root |
1.8 |
default formatter). |
787 |
|
|
|
788 |
|
|
The callback is passed the (possibly fractional) timestamp, the original |
789 |
root |
1.18 |
logging context, the (numeric) logging level and the raw message string |
790 |
|
|
and needs to return a formatted log message. In most cases this will be a |
791 |
|
|
string, but it could just as well be an array reference that just stores |
792 |
|
|
the values. |
793 |
|
|
|
794 |
|
|
If, for some reaosn, you want to use C<caller> to find out more baout the |
795 |
|
|
logger then you should walk up the call stack until you are no longer |
796 |
|
|
inside the C<AnyEvent::Log> package. |
797 |
root |
1.8 |
|
798 |
|
|
Example: format just the raw message, with numeric log level in angle |
799 |
|
|
brackets. |
800 |
|
|
|
801 |
|
|
$ctx->fmt_cb (sub { |
802 |
|
|
my ($time, $ctx, $lvl, $msg) = @_; |
803 |
|
|
|
804 |
|
|
"<$lvl>$msg\n" |
805 |
|
|
}); |
806 |
|
|
|
807 |
|
|
Example: return an array reference with just the log values, and use |
808 |
|
|
C<PApp::SQL::sql_exec> to store the emssage in a database. |
809 |
|
|
|
810 |
|
|
$ctx->fmt_cb (sub { \@_ }); |
811 |
|
|
$ctx->log_cb (sub { |
812 |
|
|
my ($msg) = @_; |
813 |
|
|
|
814 |
|
|
sql_exec "insert into log (when, subsys, prio, msg) values (?, ?, ?, ?)", |
815 |
|
|
$msg->[0] + 0, |
816 |
|
|
"$msg->[1]", |
817 |
|
|
$msg->[2] + 0, |
818 |
|
|
"$msg->[3]"; |
819 |
|
|
|
820 |
|
|
0 |
821 |
|
|
}); |
822 |
|
|
|
823 |
root |
1.21 |
=item $ctx->log_to_file ($path) |
824 |
|
|
|
825 |
|
|
Sets the C<log_cb> to log to a file (by appending), unbuffered. |
826 |
|
|
|
827 |
|
|
=item $ctx->log_to_path ($path) |
828 |
|
|
|
829 |
|
|
Same as C<< ->log_to_file >>, but opens the file for each message. This |
830 |
|
|
is much slower, but allows you to change/move/rename/delete the file at |
831 |
|
|
basically any time. |
832 |
|
|
|
833 |
|
|
=item $ctx->log_to_syslog ([$log_flags]) |
834 |
|
|
|
835 |
|
|
Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
836 |
|
|
the others in the obvious way. If specified, then the C<$log_flags> are |
837 |
|
|
simply or'ed onto the priority argument and can contain any C<LOG_xxx> |
838 |
|
|
flags valid for Sys::Syslog::syslog, except for the priority levels. |
839 |
|
|
|
840 |
|
|
Note that this function also sets a C<fmt_cb> - the logging part requires |
841 |
|
|
an array reference with [$level, $str] as input. |
842 |
|
|
|
843 |
root |
1.8 |
=cut |
844 |
|
|
|
845 |
|
|
sub log_cb { |
846 |
|
|
my ($ctx, $cb) = @_; |
847 |
root |
1.6 |
|
848 |
root |
1.10 |
$ctx->[3] = $cb; |
849 |
root |
1.6 |
} |
850 |
root |
1.5 |
|
851 |
root |
1.8 |
sub fmt_cb { |
852 |
|
|
my ($ctx, $cb) = @_; |
853 |
root |
1.6 |
|
854 |
root |
1.8 |
$ctx->[4] = $cb; |
855 |
root |
1.5 |
} |
856 |
|
|
|
857 |
root |
1.18 |
sub log_to_file { |
858 |
|
|
my ($ctx, $path) = @_; |
859 |
|
|
|
860 |
|
|
open my $fh, ">>", $path |
861 |
|
|
or die "$path: $!"; |
862 |
|
|
|
863 |
|
|
$ctx->log_cb (sub { |
864 |
|
|
syswrite $fh, shift; |
865 |
|
|
0 |
866 |
|
|
}); |
867 |
|
|
} |
868 |
|
|
|
869 |
|
|
sub log_to_file { |
870 |
|
|
my ($ctx, $path) = @_; |
871 |
|
|
|
872 |
|
|
$ctx->log_cb (sub { |
873 |
|
|
open my $fh, ">>", $path |
874 |
|
|
or die "$path: $!"; |
875 |
|
|
|
876 |
|
|
syswrite $fh, shift; |
877 |
|
|
0 |
878 |
|
|
}); |
879 |
|
|
} |
880 |
|
|
|
881 |
root |
1.20 |
sub log_to_syslog { |
882 |
|
|
my ($ctx, $flags) = @_; |
883 |
|
|
|
884 |
|
|
require Sys::Syslog; |
885 |
|
|
|
886 |
root |
1.21 |
$ctx->fmt_cb (sub { |
887 |
|
|
my $str = $_[3]; |
888 |
|
|
$str =~ s/\n(?=.)/\n+ /g; |
889 |
|
|
|
890 |
|
|
[$_[2], "($_[1][0]) $str"] |
891 |
|
|
}); |
892 |
|
|
|
893 |
root |
1.20 |
$ctx->log_cb (sub { |
894 |
root |
1.21 |
my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
895 |
root |
1.20 |
|
896 |
|
|
Sys::Syslog::syslog ($flags | ($lvl - 1), $_) |
897 |
root |
1.21 |
for split /\n/, $_[0][1]; |
898 |
root |
1.20 |
|
899 |
|
|
0 |
900 |
|
|
}); |
901 |
|
|
} |
902 |
|
|
|
903 |
root |
1.18 |
=back |
904 |
|
|
|
905 |
|
|
=head3 MESSAGE LOGGING |
906 |
|
|
|
907 |
|
|
These methods allow you to log messages directly to a context, without |
908 |
|
|
going via your package context. |
909 |
|
|
|
910 |
|
|
=over 4 |
911 |
|
|
|
912 |
root |
1.8 |
=item $ctx->log ($level, $msg[, @params]) |
913 |
|
|
|
914 |
|
|
Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
915 |
|
|
|
916 |
|
|
=item $logger = $ctx->logger ($level[, \$enabled]) |
917 |
|
|
|
918 |
|
|
Same as C<AnyEvent::Log::logger>, but uses the given context as log |
919 |
|
|
context. |
920 |
|
|
|
921 |
|
|
=cut |
922 |
|
|
|
923 |
|
|
*log = \&AnyEvent::Log::_log; |
924 |
|
|
*logger = \&AnyEvent::Log::_logger; |
925 |
|
|
|
926 |
root |
1.1 |
1; |
927 |
|
|
|
928 |
|
|
=back |
929 |
|
|
|
930 |
root |
1.12 |
=head1 EXAMPLES |
931 |
|
|
|
932 |
|
|
This section shows some common configurations. |
933 |
|
|
|
934 |
|
|
=over 4 |
935 |
|
|
|
936 |
|
|
=item Setting the global logging level. |
937 |
|
|
|
938 |
|
|
Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
939 |
|
|
running your program, or modify the log level of the root context: |
940 |
|
|
|
941 |
|
|
PERL_ANYEVENT_VERBOSE=5 ./myprog |
942 |
|
|
|
943 |
root |
1.18 |
$AnyEvent::Log::FILTER->level ("warn"); |
944 |
root |
1.12 |
|
945 |
|
|
=item Append all messages to a file instead of sending them to STDERR. |
946 |
|
|
|
947 |
|
|
This is affected by the global logging level. |
948 |
|
|
|
949 |
root |
1.18 |
$AnyEvent::Log::LOG->log_to_file ($path); (sub { |
950 |
root |
1.12 |
|
951 |
|
|
=item Write all messages with priority C<error> and higher to a file. |
952 |
|
|
|
953 |
|
|
This writes them only when the global logging level allows it, because |
954 |
|
|
it is attached to the default context which is invoked I<after> global |
955 |
|
|
filtering. |
956 |
|
|
|
957 |
root |
1.18 |
$AnyEvent::Log::FILTER->attach |
958 |
|
|
new AnyEvent::Log::Ctx log_to_file => $path); |
959 |
root |
1.12 |
|
960 |
|
|
This writes them regardless of the global logging level, because it is |
961 |
|
|
attached to the toplevel context, which receives all messages I<before> |
962 |
|
|
the global filtering. |
963 |
|
|
|
964 |
root |
1.18 |
$AnyEvent::Log::COLLECT->attach ( |
965 |
|
|
new AnyEvent::Log::Ctx log_to_file => $path); |
966 |
root |
1.12 |
|
967 |
root |
1.18 |
In both cases, messages are still written to STDERR. |
968 |
root |
1.12 |
|
969 |
|
|
=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
970 |
|
|
|
971 |
root |
1.18 |
Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
972 |
|
|
context - this simply circumvents the global filtering for trace messages. |
973 |
root |
1.12 |
|
974 |
|
|
my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
975 |
root |
1.18 |
$debug->attach ($AnyEvent::Log::LOG); |
976 |
root |
1.12 |
|
977 |
root |
1.18 |
This of course works for any package, not just L<AnyEvent::Debug>, but |
978 |
|
|
assumes the log level for AnyEvent::Debug hasn't been changed from the |
979 |
|
|
default. |
980 |
root |
1.13 |
|
981 |
root |
1.12 |
=back |
982 |
|
|
|
983 |
root |
1.1 |
=head1 AUTHOR |
984 |
|
|
|
985 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
986 |
|
|
http://home.schmorp.de/ |
987 |
|
|
|
988 |
|
|
=cut |