… | |
… | |
2 | |
2 | |
3 | AnyEvent::Log - simple logging "framework" |
3 | AnyEvent::Log - simple logging "framework" |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | # simple use |
7 | Simple uses: |
|
|
8 | |
8 | use AnyEvent; |
9 | use AnyEvent; |
9 | |
10 | |
10 | AE::log debug => "hit my knee"; |
11 | AE::log debug => "hit my knee"; |
11 | AE::log warn => "it's a bit too hot"; |
12 | AE::log warn => "it's a bit too hot"; |
12 | AE::log error => "the flag was false!"; |
13 | AE::log error => "the flag was false!"; |
13 | AE::log fatal => "the bit toggled! run!"; |
14 | AE::log fatal => "the bit toggled! run!"; # never returns |
14 | |
15 | |
15 | # "complex" use |
16 | # available log levels in order: |
|
|
17 | # fatal alert critical error warn note info debug trace |
|
|
18 | |
|
|
19 | "Complex" uses (for speed sensitive code): |
|
|
20 | |
16 | use AnyEvent::Log; |
21 | use AnyEvent::Log; |
17 | |
22 | |
18 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
23 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
19 | |
24 | |
20 | $tracer->("i am here") if $trace; |
25 | $tracer->("i am here") if $trace; |
21 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
26 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
22 | |
27 | |
23 | # configuration |
28 | Configuration (also look at the EXAMPLES section): |
24 | |
29 | |
25 | # set logging for the current package to errors and higher only |
30 | # set logging for the current package to errors and higher only |
26 | AnyEvent::Log::ctx->level ("error"); |
31 | AnyEvent::Log::ctx->level ("error"); |
27 | |
32 | |
28 | # set logging globally to anything below debug |
33 | # set logging level to suppress anything below "notice" |
29 | $AnyEvent::Log::FILTER->level ("notice"); |
34 | $AnyEvent::Log::FILTER->level ("notice"); |
30 | |
35 | |
31 | # see also EXAMPLES, below |
36 | # send all critical and higher priority messages to syslog, |
|
|
37 | # regardless of (most) other settings |
|
|
38 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
|
|
39 | level => "critical", |
|
|
40 | log_to_syslog => "user", |
|
|
41 | ); |
32 | |
42 | |
33 | =head1 DESCRIPTION |
43 | =head1 DESCRIPTION |
34 | |
44 | |
35 | This module implements a relatively simple "logging framework". It doesn't |
45 | This module implements a relatively simple "logging framework". It doesn't |
36 | attempt to be "the" logging solution or even "a" logging solution for |
46 | attempt to be "the" logging solution or even "a" logging solution for |
37 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
47 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
38 | module more or less exposes the mechanism, with some extra spiff to allow |
48 | module more or less exposes the mechanism, with some extra spiff to allow |
39 | using it from other modules as well. |
49 | using it from other modules as well. |
40 | |
50 | |
41 | Remember that the default verbosity level is C<0>, so nothing will be |
51 | Remember that the default verbosity level is C<0> (C<off>), so nothing |
42 | logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before |
52 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
43 | starting your program, or change the logging level at runtime with |
53 | before starting your program, or change the logging level at runtime with |
44 | something like: |
54 | something like: |
45 | |
55 | |
46 | use AnyEvent::Log; |
56 | use AnyEvent::Log; |
47 | AnyEvent::Log::FILTER->level ("info"); |
57 | $AnyEvent::Log::FILTER->level ("info"); |
48 | |
58 | |
49 | The design goal behind this module was to keep it simple (and small), |
59 | The design goal behind this module was to keep it simple (and small), |
50 | but make it powerful enough to be potentially useful for any module, and |
60 | but make it powerful enough to be potentially useful for any module, and |
51 | extensive enough for the most common tasks, such as logging to multiple |
61 | extensive enough for the most common tasks, such as logging to multiple |
52 | targets, or being able to log into a database. |
62 | targets, or being able to log into a database. |
53 | |
63 | |
|
|
64 | The module is also usable before AnyEvent itself is initialised, in which |
|
|
65 | case some of the functionality might be reduced. |
|
|
66 | |
54 | The amount of documentation might indicate otherwise, but the module is |
67 | The amount of documentation might indicate otherwise, but the runtime part |
55 | still just below 300 lines of code. |
68 | of the module is still just below 300 lines of code. |
56 | |
69 | |
57 | =head1 LOGGING LEVELS |
70 | =head1 LOGGING LEVELS |
58 | |
71 | |
59 | Logging levels in this module range from C<1> (highest priority) to C<9> |
72 | Logging levels in this module range from C<1> (highest priority) to C<9> |
60 | (lowest priority). Note that the lowest numerical value is the highest |
73 | (lowest priority). Note that the lowest numerical value is the highest |
… | |
… | |
62 | numerical value". |
75 | numerical value". |
63 | |
76 | |
64 | Instead of specifying levels by name you can also specify them by aliases: |
77 | Instead of specifying levels by name you can also specify them by aliases: |
65 | |
78 | |
66 | LVL NAME SYSLOG PERL NOTE |
79 | LVL NAME SYSLOG PERL NOTE |
67 | 1 fatal emerg exit aborts program! |
80 | 1 fatal emerg exit system unusable, aborts program! |
68 | 2 alert |
81 | 2 alert failure in primary system |
69 | 3 critical crit |
82 | 3 critical crit failure in backup system |
70 | 4 error err die |
83 | 4 error err die non-urgent program errors, a bug |
71 | 5 warn warning |
84 | 5 warn warning possible problem, not necessarily error |
72 | 6 note notice |
85 | 6 note notice unusual conditions |
73 | 7 info |
86 | 7 info normal messages, no action required |
74 | 8 debug |
87 | 8 debug debugging messages for development |
75 | 9 trace |
88 | 9 trace copious tracing output |
76 | |
89 | |
77 | As you can see, some logging levels have multiple aliases - the first one |
90 | As you can see, some logging levels have multiple aliases - the first one |
78 | is the "official" name, the second one the "syslog" name (if it differs) |
91 | is the "official" name, the second one the "syslog" name (if it differs) |
79 | and the third one the "perl" name, suggesting that you log C<die> messages |
92 | and the third one the "perl" name, suggesting (only!) that you log C<die> |
80 | at C<error> priority. |
93 | messages at C<error> priority. The NOTE column tries to provide some |
|
|
94 | rationale on how to chose a logging level. |
|
|
95 | |
|
|
96 | As a rough guideline, levels 1..3 are primarily meant for users of |
|
|
97 | the program (admins, staff), and are the only logged to STDERR by |
|
|
98 | default. Levels 4..6 are meant for users and developers alike, while |
|
|
99 | levels 7..9 are usually meant for developers. |
81 | |
100 | |
82 | You can normally only log a single message at highest priority level |
101 | You can normally only log a single message at highest priority level |
83 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
102 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
84 | program - so use it sparingly :) |
103 | program - so use it sparingly :) |
85 | |
104 | |
… | |
… | |
101 | |
120 | |
102 | use Carp (); |
121 | use Carp (); |
103 | use POSIX (); |
122 | use POSIX (); |
104 | |
123 | |
105 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
124 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
106 | use AnyEvent::Util (); |
125 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
107 | |
126 | |
108 | our $VERSION = $AnyEvent::VERSION; |
127 | our $VERSION = $AnyEvent::VERSION; |
109 | |
128 | |
110 | our ($COLLECT, $FILTER, $LOG); |
129 | our ($COLLECT, $FILTER, $LOG); |
111 | |
130 | |
… | |
… | |
138 | $ctx |
157 | $ctx |
139 | } |
158 | } |
140 | |
159 | |
141 | =item AnyEvent::Log::log $level, $msg[, @args] |
160 | =item AnyEvent::Log::log $level, $msg[, @args] |
142 | |
161 | |
143 | Requests logging of the given C<$msg> with the given log level. |
162 | Requests logging of the given C<$msg> with the given log level, and |
|
|
163 | returns true if the message was logged I<somewhere>. |
144 | |
164 | |
145 | For C<fatal> log levels, the program will abort. |
165 | For loglevel C<fatal>, the program will abort. |
146 | |
166 | |
147 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
167 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
148 | C<$msg> is interpreted as an sprintf format string. |
168 | C<$msg> is interpreted as an sprintf format string. |
149 | |
169 | |
150 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
170 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
… | |
… | |
154 | supposed to return the message. It will be called only then the message |
174 | supposed to return the message. It will be called only then the message |
155 | actually gets logged, which is useful if it is costly to create the |
175 | actually gets logged, which is useful if it is costly to create the |
156 | message in the first place. |
176 | message in the first place. |
157 | |
177 | |
158 | Whether the given message will be logged depends on the maximum log level |
178 | Whether the given message will be logged depends on the maximum log level |
159 | and the caller's package. |
179 | and the caller's package. The return value can be used to ensure that |
|
|
180 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
|
|
181 | runtime error it tries to log it at C<die> level, but if that message is |
|
|
182 | lost it simply uses warn. |
160 | |
183 | |
161 | Note that you can (and should) call this function as C<AnyEvent::log> or |
184 | Note that you can (and should) call this function as C<AnyEvent::log> or |
162 | C<AE::log>, without C<use>-ing this module if possible (i.e. you don't |
185 | C<AE::log>, without C<use>-ing this module if possible (i.e. you don't |
163 | need any additional functionality), as those functions will load the |
186 | need any additional functionality), as those functions will load the |
164 | logging module on demand only. They are also much shorter to write. |
187 | logging module on demand only. They are also much shorter to write. |
… | |
… | |
192 | info => 7, |
215 | info => 7, |
193 | debug => 8, |
216 | debug => 8, |
194 | trace => 9, |
217 | trace => 9, |
195 | ); |
218 | ); |
196 | |
219 | |
197 | sub now () { time } |
220 | our $TIME_EXACT; |
|
|
221 | |
|
|
222 | sub exact_time($) { |
|
|
223 | $TIME_EXACT = shift; |
|
|
224 | *_ts = $AnyEvent::MODEL |
|
|
225 | ? $TIME_EXACT ? \&AE::now : \&AE::time |
|
|
226 | : sub () { $TIME_EXACT ? do { require Time::HiRes; Time::HiRes::time () } : time }; |
|
|
227 | } |
|
|
228 | |
|
|
229 | BEGIN { |
|
|
230 | exact_time 0; |
|
|
231 | } |
198 | |
232 | |
199 | AnyEvent::post_detect { |
233 | AnyEvent::post_detect { |
200 | *now = \&AE::now; |
234 | exact_time $TIME_EXACT; |
201 | }; |
235 | }; |
202 | |
236 | |
203 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
237 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
204 | |
238 | |
205 | # time, ctx, level, msg |
239 | # time, ctx, level, msg |
… | |
… | |
215 | } |
249 | } |
216 | |
250 | |
217 | join "", @res |
251 | join "", @res |
218 | } |
252 | } |
219 | |
253 | |
|
|
254 | sub fatal_exit() { |
|
|
255 | exit 1; |
|
|
256 | } |
|
|
257 | |
220 | sub _log { |
258 | sub _log { |
221 | my ($ctx, $level, $format, @args) = @_; |
259 | my ($ctx, $level, $format, @args) = @_; |
222 | |
260 | |
223 | $level = $level > 0 && $level <= 9 |
261 | $level = $level > 0 && $level <= 9 |
224 | ? $level+0 |
262 | ? $level+0 |
225 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
263 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
226 | |
264 | |
227 | my $mask = 1 << $level; |
265 | my $mask = 1 << $level; |
228 | |
266 | |
229 | my (%seen, @ctx, $now, $fmt); |
267 | my ($success, %seen, @ctx, $now, $fmt); |
230 | |
268 | |
231 | do |
269 | do |
232 | { |
270 | { |
233 | # skip if masked |
271 | # skip if masked |
234 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
272 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
… | |
… | |
238 | # now get raw message, unless we have it already |
276 | # now get raw message, unless we have it already |
239 | unless ($now) { |
277 | unless ($now) { |
240 | $format = $format->() if ref $format; |
278 | $format = $format->() if ref $format; |
241 | $format = sprintf $format, @args if @args; |
279 | $format = sprintf $format, @args if @args; |
242 | $format =~ s/\n$//; |
280 | $format =~ s/\n$//; |
243 | $now = AE::now; |
281 | $now = _ts; |
244 | }; |
282 | }; |
245 | |
283 | |
246 | # format msg |
284 | # format msg |
247 | my $str = $ctx->[4] |
285 | my $str = $ctx->[4] |
248 | ? $ctx->[4]($now, $_[0], $level, $format) |
286 | ? $ctx->[4]($now, $_[0], $level, $format) |
249 | : $fmt ||= _format $now, $_[0], $level, $format; |
287 | : ($fmt ||= _format $now, $_[0], $level, $format); |
|
|
288 | |
|
|
289 | $success = 1; |
250 | |
290 | |
251 | $ctx->[3]($str) |
291 | $ctx->[3]($str) |
252 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
292 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
253 | } else { |
293 | } else { |
254 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
294 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
255 | } |
295 | } |
256 | } |
296 | } |
257 | } |
297 | } |
258 | while $ctx = pop @ctx; |
298 | while $ctx = pop @ctx; |
259 | |
299 | |
260 | exit 1 if $level <= 1; |
300 | fatal_exit if $level <= 1; |
|
|
301 | |
|
|
302 | $success |
261 | } |
303 | } |
262 | |
304 | |
263 | sub log($$;@) { |
305 | sub log($$;@) { |
264 | _log |
306 | _log |
265 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
307 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
266 | @_; |
308 | @_; |
267 | } |
309 | } |
268 | |
310 | |
269 | *AnyEvent::log = *AE::log = \&log; |
|
|
270 | |
|
|
271 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
311 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
272 | |
312 | |
273 | Creates a code reference that, when called, acts as if the |
313 | Creates a code reference that, when called, acts as if the |
274 | C<AnyEvent::Log::log> function was called at this point with the givne |
314 | C<AnyEvent::Log::log> function was called at this point with the given |
275 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
315 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
276 | the C<AnyEvent::Log::log> function: |
316 | the C<AnyEvent::Log::log> function: |
277 | |
317 | |
278 | my $debug_log = AnyEvent::Log::logger "debug"; |
318 | my $debug_log = AnyEvent::Log::logger "debug"; |
279 | |
319 | |
… | |
… | |
339 | |
379 | |
340 | $LOGGER{$logger+0} = $logger; |
380 | $LOGGER{$logger+0} = $logger; |
341 | |
381 | |
342 | _reassess $logger+0; |
382 | _reassess $logger+0; |
343 | |
383 | |
|
|
384 | require AnyEvent::Util unless $AnyEvent::Util::VERSION; |
344 | my $guard = AnyEvent::Util::guard { |
385 | my $guard = AnyEvent::Util::guard (sub { |
345 | # "clean up" |
386 | # "clean up" |
346 | delete $LOGGER{$logger+0}; |
387 | delete $LOGGER{$logger+0}; |
347 | }; |
388 | }); |
348 | |
389 | |
349 | sub { |
390 | sub { |
350 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
391 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
351 | |
392 | |
352 | _log $ctx, $level, @_ |
393 | _log $ctx, $level, @_ |
… | |
… | |
357 | sub logger($;$) { |
398 | sub logger($;$) { |
358 | _logger |
399 | _logger |
359 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
400 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
360 | @_ |
401 | @_ |
361 | } |
402 | } |
|
|
403 | |
|
|
404 | =item AnyEvent::Log::exact_time $on |
|
|
405 | |
|
|
406 | By default, C<AnyEvent::Log> will use C<AE::now>, i.e. the cached |
|
|
407 | eventloop time, for the log timestamps. After calling this function with a |
|
|
408 | true value it will instead resort to C<AE::time>, i.e. fetch the current |
|
|
409 | time on each log message. This only makes a difference for event loops |
|
|
410 | that actually cache the time (such as L<EV> or L<AnyEvent::Loop>). |
|
|
411 | |
|
|
412 | This setting can be changed at any time by calling this function. |
|
|
413 | |
|
|
414 | Since C<AnyEvent::Log> has to work even before the L<AnyEvent> has been |
|
|
415 | initialised, this switch will also decide whether to use C<CORE::time> or |
|
|
416 | C<Time::HiRes::time> when logging a message before L<AnyEvent> becomes |
|
|
417 | available. |
362 | |
418 | |
363 | =back |
419 | =back |
364 | |
420 | |
365 | =head1 LOGGING CONTEXTS |
421 | =head1 LOGGING CONTEXTS |
366 | |
422 | |
… | |
… | |
486 | This can be used to implement config-file (re-)loading: before loading a |
542 | This can be used to implement config-file (re-)loading: before loading a |
487 | configuration, reset all contexts. |
543 | configuration, reset all contexts. |
488 | |
544 | |
489 | =cut |
545 | =cut |
490 | |
546 | |
|
|
547 | our $ORIG_VERBOSE = $AnyEvent::VERBOSE; |
|
|
548 | $AnyEvent::VERBOSE = 9; |
|
|
549 | |
491 | sub reset { |
550 | sub reset { |
492 | # hard to kill complex data structures |
551 | # hard to kill complex data structures |
493 | # we recreate all package loggers and reset the hierarchy |
552 | # we "recreate" all package loggers and reset the hierarchy |
494 | while (my ($k, $v) = each %CTX) { |
553 | while (my ($k, $v) = each %CTX) { |
495 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
554 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
496 | |
555 | |
497 | $v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log); |
556 | $v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log::COLLECT); |
498 | } |
557 | } |
499 | |
558 | |
|
|
559 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
|
|
560 | for $LOG, $FILTER, $COLLECT; |
|
|
561 | |
500 | $LOG->slaves; |
562 | #$LOG->slaves; |
501 | $LOG->title ('$AnyEvent::Log::LOG'); |
563 | $LOG->title ('$AnyEvent::Log::LOG'); |
502 | $LOG->log_cb (sub { |
564 | $LOG->log_to_warn; |
503 | warn shift; |
|
|
504 | 0 |
|
|
505 | }); |
|
|
506 | |
565 | |
507 | $FILTER->slaves ($LOG); |
566 | $FILTER->slaves ($LOG); |
508 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
567 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
509 | $FILTER->level ($AnyEvent::VERBOSE); |
568 | $FILTER->level ($ORIG_VERBOSE); |
510 | |
569 | |
511 | $COLLECT->slaves ($FILTER); |
570 | $COLLECT->slaves ($FILTER); |
512 | $COLLECT->title ('$AnyEvent::Log::FILTER'); |
571 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
513 | |
572 | |
514 | _reassess; |
573 | _reassess; |
515 | } |
574 | } |
|
|
575 | |
|
|
576 | # override AE::log/logger |
|
|
577 | *AnyEvent::log = *AE::log = \&log; |
|
|
578 | *AnyEvent::logger = *AE::logger = \&logger; |
|
|
579 | |
|
|
580 | # convert AnyEvent loggers to AnyEvent::Log loggers |
|
|
581 | $_->[0] = ctx $_->[0] # convert "pkg" to "ctx" |
|
|
582 | for values %LOGGER; |
516 | |
583 | |
517 | # create the default logger contexts |
584 | # create the default logger contexts |
518 | $LOG = ctx undef; |
585 | $LOG = ctx undef; |
519 | $FILTER = ctx undef; |
586 | $FILTER = ctx undef; |
520 | $COLLECT = ctx undef; |
587 | $COLLECT = ctx undef; |
… | |
… | |
731 | the logging (which consists of formatting the message and printing it or |
798 | the logging (which consists of formatting the message and printing it or |
732 | whatever it wants to do with it). |
799 | whatever it wants to do with it). |
733 | |
800 | |
734 | =over 4 |
801 | =over 4 |
735 | |
802 | |
736 | =item $ctx->log_cb ($cb->($str)) |
803 | =item $ctx->log_cb ($cb->($str) |
737 | |
804 | |
738 | Replaces the logging callback on the context (C<undef> disables the |
805 | Replaces the logging callback on the context (C<undef> disables the |
739 | logging callback). |
806 | logging callback). |
740 | |
807 | |
741 | The logging callback is responsible for handling formatted log messages |
808 | The logging callback is responsible for handling formatted log messages |
… | |
… | |
760 | your program. |
827 | your program. |
761 | |
828 | |
762 | $ctx->levels ("debug", "trace"); |
829 | $ctx->levels ("debug", "trace"); |
763 | $ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages |
830 | $ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages |
764 | |
831 | |
765 | =item $ctx->log_to_file ($path) |
|
|
766 | |
|
|
767 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
|
|
768 | |
|
|
769 | =item $ctx->log_to_path ($path) |
|
|
770 | |
|
|
771 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
|
|
772 | is much slower, but allows you to change/move/rename/delete the file at |
|
|
773 | basically any time. |
|
|
774 | |
|
|
775 | =item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message)) |
832 | =item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message)) |
776 | |
833 | |
777 | Replaces the formatting callback on the context (C<undef> restores the |
834 | Replaces the formatting callback on the context (C<undef> restores the |
778 | default formatter). |
835 | default formatter). |
779 | |
836 | |
780 | The callback is passed the (possibly fractional) timestamp, the original |
837 | The callback is passed the (possibly fractional) timestamp, the original |
781 | logging context, the (numeric) logging level and the raw message string |
838 | logging context, the (numeric) logging level and the raw message string |
782 | and needs to return a formatted log message. In most cases this will be a |
839 | and needs to return a formatted log message. In most cases this will be a |
783 | string, but it could just as well be an array reference that just stores |
840 | string, but it could just as well be an array reference that just stores |
784 | the values. |
841 | the values. |
785 | |
842 | |
786 | If, for some reaosn, you want to use C<caller> to find out more baout the |
843 | If, for some reason, you want to use C<caller> to find out more baout the |
787 | logger then you should walk up the call stack until you are no longer |
844 | logger then you should walk up the call stack until you are no longer |
788 | inside the C<AnyEvent::Log> package. |
845 | inside the C<AnyEvent::Log> package. |
789 | |
846 | |
790 | Example: format just the raw message, with numeric log level in angle |
847 | Example: format just the raw message, with numeric log level in angle |
791 | brackets. |
848 | brackets. |
… | |
… | |
810 | "$msg->[3]"; |
867 | "$msg->[3]"; |
811 | |
868 | |
812 | 0 |
869 | 0 |
813 | }); |
870 | }); |
814 | |
871 | |
|
|
872 | =item $ctx->log_to_warn |
|
|
873 | |
|
|
874 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
|
|
875 | (usually this logs to STDERR). |
|
|
876 | |
|
|
877 | =item $ctx->log_to_file ($path) |
|
|
878 | |
|
|
879 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
|
|
880 | |
|
|
881 | =item $ctx->log_to_path ($path) |
|
|
882 | |
|
|
883 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
|
|
884 | is much slower, but allows you to change/move/rename/delete the file at |
|
|
885 | basically any time. |
|
|
886 | |
|
|
887 | Needless(?) to say, if you do not want to be bitten by some evil person |
|
|
888 | calling C<chdir>, the path should be absolute. Doesn't help with |
|
|
889 | C<chroot>, but hey... |
|
|
890 | |
|
|
891 | =item $ctx->log_to_syslog ([$facility]) |
|
|
892 | |
|
|
893 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and |
|
|
894 | all the others in the obvious way. If specified, then the C<$facility> is |
|
|
895 | used as the facility (C<user>, C<auth>, C<local0> and so on). The default |
|
|
896 | facility is C<user>. |
|
|
897 | |
|
|
898 | Note that this function also sets a C<fmt_cb> - the logging part requires |
|
|
899 | an array reference with [$level, $str] as input. |
|
|
900 | |
815 | =cut |
901 | =cut |
816 | |
902 | |
817 | sub log_cb { |
903 | sub log_cb { |
818 | my ($ctx, $cb) = @_; |
904 | my ($ctx, $cb) = @_; |
819 | |
905 | |
… | |
… | |
822 | |
908 | |
823 | sub fmt_cb { |
909 | sub fmt_cb { |
824 | my ($ctx, $cb) = @_; |
910 | my ($ctx, $cb) = @_; |
825 | |
911 | |
826 | $ctx->[4] = $cb; |
912 | $ctx->[4] = $cb; |
|
|
913 | } |
|
|
914 | |
|
|
915 | sub log_to_warn { |
|
|
916 | my ($ctx, $path) = @_; |
|
|
917 | |
|
|
918 | $ctx->log_cb (sub { |
|
|
919 | warn shift; |
|
|
920 | 0 |
|
|
921 | }); |
827 | } |
922 | } |
828 | |
923 | |
829 | sub log_to_file { |
924 | sub log_to_file { |
830 | my ($ctx, $path) = @_; |
925 | my ($ctx, $path) = @_; |
831 | |
926 | |
… | |
… | |
836 | syswrite $fh, shift; |
931 | syswrite $fh, shift; |
837 | 0 |
932 | 0 |
838 | }); |
933 | }); |
839 | } |
934 | } |
840 | |
935 | |
841 | sub log_to_file { |
936 | sub log_to_path { |
842 | my ($ctx, $path) = @_; |
937 | my ($ctx, $path) = @_; |
843 | |
938 | |
844 | $ctx->log_cb (sub { |
939 | $ctx->log_cb (sub { |
845 | open my $fh, ">>", $path |
940 | open my $fh, ">>", $path |
846 | or die "$path: $!"; |
941 | or die "$path: $!"; |
… | |
… | |
848 | syswrite $fh, shift; |
943 | syswrite $fh, shift; |
849 | 0 |
944 | 0 |
850 | }); |
945 | }); |
851 | } |
946 | } |
852 | |
947 | |
|
|
948 | sub log_to_syslog { |
|
|
949 | my ($ctx, $facility) = @_; |
|
|
950 | |
|
|
951 | require Sys::Syslog; |
|
|
952 | |
|
|
953 | $ctx->fmt_cb (sub { |
|
|
954 | my $str = $_[3]; |
|
|
955 | $str =~ s/\n(?=.)/\n+ /g; |
|
|
956 | |
|
|
957 | [$_[2], "($_[1][0]) $str"] |
|
|
958 | }); |
|
|
959 | |
|
|
960 | $facility ||= "user"; |
|
|
961 | |
|
|
962 | $ctx->log_cb (sub { |
|
|
963 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
|
|
964 | |
|
|
965 | Sys::Syslog::syslog ("$facility|" . ($lvl - 1), $_) |
|
|
966 | for split /\n/, $_[0][1]; |
|
|
967 | |
|
|
968 | 0 |
|
|
969 | }); |
|
|
970 | } |
|
|
971 | |
853 | =back |
972 | =back |
854 | |
973 | |
855 | =head3 MESSAGE LOGGING |
974 | =head3 MESSAGE LOGGING |
856 | |
975 | |
857 | These methods allow you to log messages directly to a context, without |
976 | These methods allow you to log messages directly to a context, without |
… | |
… | |
871 | =cut |
990 | =cut |
872 | |
991 | |
873 | *log = \&AnyEvent::Log::_log; |
992 | *log = \&AnyEvent::Log::_log; |
874 | *logger = \&AnyEvent::Log::_logger; |
993 | *logger = \&AnyEvent::Log::_logger; |
875 | |
994 | |
|
|
995 | =back |
|
|
996 | |
|
|
997 | =cut |
|
|
998 | |
|
|
999 | package AnyEvent::Log; |
|
|
1000 | |
|
|
1001 | =head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG} |
|
|
1002 | |
|
|
1003 | Logging can also be configured by setting the environment variable |
|
|
1004 | C<PERL_ANYEVENT_LOG> (or C<AE_LOG>). |
|
|
1005 | |
|
|
1006 | The value consists of one or more logging context specifications separated |
|
|
1007 | by C<:> or whitespace. Each logging specification in turn starts with a |
|
|
1008 | context name, followed by C<=>, followed by zero or more comma-separated |
|
|
1009 | configuration directives, here are some examples: |
|
|
1010 | |
|
|
1011 | # set default logging level |
|
|
1012 | filter=warn |
|
|
1013 | |
|
|
1014 | # log to file instead of to stderr |
|
|
1015 | log=file=/tmp/mylog |
|
|
1016 | |
|
|
1017 | # log to file in addition to stderr |
|
|
1018 | log=+%file:%file=file=/tmp/mylog |
|
|
1019 | |
|
|
1020 | # enable debug log messages, log warnings and above to syslog |
|
|
1021 | filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0 |
|
|
1022 | |
|
|
1023 | # log trace messages (only) from AnyEvent::Debug to file |
|
|
1024 | AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog |
|
|
1025 | |
|
|
1026 | A context name in the log specification can be any of the following: |
|
|
1027 | |
|
|
1028 | =over 4 |
|
|
1029 | |
|
|
1030 | =item C<collect>, C<filter>, C<log> |
|
|
1031 | |
|
|
1032 | Correspond to the three predefined C<$AnyEvent::Log::COLLECT>, |
|
|
1033 | C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts. |
|
|
1034 | |
|
|
1035 | =item C<%name> |
|
|
1036 | |
|
|
1037 | Context names starting with a C<%> are anonymous contexts created when the |
|
|
1038 | name is first mentioned. The difference to package contexts is that by |
|
|
1039 | default they have no attached slaves. |
|
|
1040 | |
|
|
1041 | =item a perl package name |
|
|
1042 | |
|
|
1043 | Any other string references the logging context associated with the given |
|
|
1044 | Perl C<package>. In the unlikely case where you want to specify a package |
|
|
1045 | context that matches on of the other context name forms, you can add a |
|
|
1046 | C<::> to the package name to force interpretation as a package. |
|
|
1047 | |
|
|
1048 | =back |
|
|
1049 | |
|
|
1050 | The configuration specifications can be any number of the following: |
|
|
1051 | |
|
|
1052 | =over 4 |
|
|
1053 | |
|
|
1054 | =item C<stderr> |
|
|
1055 | |
|
|
1056 | Configures the context to use Perl's C<warn> function (which typically |
|
|
1057 | logs to C<STDERR>). Works like C<log_to_warn>. |
|
|
1058 | |
|
|
1059 | =item C<file=>I<path> |
|
|
1060 | |
|
|
1061 | Configures the context to log to a file with the given path. Works like |
|
|
1062 | C<log_to_file>. |
|
|
1063 | |
|
|
1064 | =item C<path=>I<path> |
|
|
1065 | |
|
|
1066 | Configures the context to log to a file with the given path. Works like |
|
|
1067 | C<log_to_path>. |
|
|
1068 | |
|
|
1069 | =item C<syslog> or C<syslog=>I<expr> |
|
|
1070 | |
|
|
1071 | Configures the context to log to syslog. If I<expr> is given, then it is |
|
|
1072 | evaluated in the L<Sys::Syslog> package, so you could use: |
|
|
1073 | |
|
|
1074 | log=syslog=LOG_LOCAL0 |
|
|
1075 | |
|
|
1076 | =item C<nolog> |
|
|
1077 | |
|
|
1078 | Configures the context to not log anything by itself, which is the |
|
|
1079 | default. Same as C<< $ctx->log_cb (undef) >>. |
|
|
1080 | |
|
|
1081 | =item C<0> or C<off> |
|
|
1082 | |
|
|
1083 | Sets the logging level of the context ot C<0>, i.e. all messages will be |
|
|
1084 | filtered out. |
|
|
1085 | |
|
|
1086 | =item C<all> |
|
|
1087 | |
|
|
1088 | Enables all logging levels, i.e. filtering will effectively be switched |
|
|
1089 | off (the default). |
|
|
1090 | |
|
|
1091 | =item C<only> |
|
|
1092 | |
|
|
1093 | Disables all logging levels, and changes the interpretation of following |
|
|
1094 | level specifications to enable the specified level only. |
|
|
1095 | |
|
|
1096 | Example: only enable debug messages for a context. |
|
|
1097 | |
|
|
1098 | context=only,debug |
|
|
1099 | |
|
|
1100 | =item C<except> |
|
|
1101 | |
|
|
1102 | Enables all logging levels, and changes the interpretation of following |
|
|
1103 | level specifications to disable that level. Rarely used. |
|
|
1104 | |
|
|
1105 | Example: enable all logging levels except fatal and trace (this is rather |
|
|
1106 | nonsensical). |
|
|
1107 | |
|
|
1108 | filter=exept,fatal,trace |
|
|
1109 | |
|
|
1110 | =item C<level> |
|
|
1111 | |
|
|
1112 | Enables all logging levels, and changes the interpretation of following |
|
|
1113 | level specifications to be "that level or any higher priority |
|
|
1114 | message". This is the default. |
|
|
1115 | |
|
|
1116 | Example: log anything at or above warn level. |
|
|
1117 | |
|
|
1118 | filter=warn |
|
|
1119 | |
|
|
1120 | # or, more verbose |
|
|
1121 | filter=only,level,warn |
|
|
1122 | |
|
|
1123 | =item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.) |
|
|
1124 | |
|
|
1125 | A numeric loglevel or the name of a loglevel will be interpreted according |
|
|
1126 | to the most recent C<only>, C<except> or C<level> directive. By default, |
|
|
1127 | specifying a logging level enables that and any higher priority messages. |
|
|
1128 | |
|
|
1129 | =item C<+>I<context> |
|
|
1130 | |
|
|
1131 | Attaches the named context as slave to the context. |
|
|
1132 | |
|
|
1133 | =item C<+> |
|
|
1134 | |
|
|
1135 | A line C<+> detaches all contexts, i.e. clears the slave list from the |
|
|
1136 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
|
|
1137 | but package contexts have the parent context as slave by default. |
|
|
1138 | |
|
|
1139 | Example: log messages from My::Module to a file, do not send them to the |
|
|
1140 | default log collector. |
|
|
1141 | |
|
|
1142 | My::Module=+,file=/tmp/mymodulelog |
|
|
1143 | |
|
|
1144 | =back |
|
|
1145 | |
|
|
1146 | Any character can be escaped by prefixing it with a C<\> (backslash), as |
|
|
1147 | usual, so to log to a file containing a comma, colon, backslash and some |
|
|
1148 | spaces in the filename, you would do this: |
|
|
1149 | |
|
|
1150 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
|
|
1151 | |
|
|
1152 | Since whitespace (which includes newlines) is allowed, it is fine to |
|
|
1153 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |
|
|
1154 | |
|
|
1155 | PERL_ANYEVENT_LOG=" |
|
|
1156 | filter=warn |
|
|
1157 | AnyEvent::Debug=+%trace |
|
|
1158 | %trace=only,trace,+log |
|
|
1159 | " myprog |
|
|
1160 | |
|
|
1161 | Also, in the unlikely case when you want to concatenate specifications, |
|
|
1162 | use whitespace as separator, as C<::> will be interpreted as part of a |
|
|
1163 | module name, an empty spec with two separators: |
|
|
1164 | |
|
|
1165 | PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug" |
|
|
1166 | |
|
|
1167 | =cut |
|
|
1168 | |
|
|
1169 | for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1170 | my %anon; |
|
|
1171 | |
|
|
1172 | my $pkg = sub { |
|
|
1173 | $_[0] eq "log" ? $LOG |
|
|
1174 | : $_[0] eq "filter" ? $FILTER |
|
|
1175 | : $_[0] eq "collect" ? $COLLECT |
|
|
1176 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= ctx undef) |
|
|
1177 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
|
|
1178 | : die # never reached? |
|
|
1179 | }; |
|
|
1180 | |
|
|
1181 | /\G[[:space:]]+/gc; # skip initial whitespace |
|
|
1182 | |
|
|
1183 | while (/\G((?:[^:=[:space:]]+|::|\\.)+)=/gc) { |
|
|
1184 | my $ctx = $pkg->($1); |
|
|
1185 | my $level = "level"; |
|
|
1186 | |
|
|
1187 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
|
|
1188 | for ("$1") { |
|
|
1189 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
|
|
1190 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
|
|
1191 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
|
|
1192 | } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ($1); |
|
|
1193 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
|
|
1194 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
|
|
1195 | } elsif ($_ eq "+" ) { $ctx->slaves; |
|
|
1196 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
|
|
1197 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
|
|
1198 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
|
|
1199 | } elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable"; |
|
|
1200 | } elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable"; |
|
|
1201 | } elsif (/^\d$/ ) { $ctx->$level ($_); |
|
|
1202 | } elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_); |
|
|
1203 | } else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n"; |
|
|
1204 | } |
|
|
1205 | } |
|
|
1206 | |
|
|
1207 | /\G,/gc or last; |
|
|
1208 | } |
|
|
1209 | |
|
|
1210 | /\G[:[:space:]]+/gc or last; |
|
|
1211 | } |
|
|
1212 | |
|
|
1213 | /\G[[:space:]]+/gc; # skip trailing whitespace |
|
|
1214 | |
|
|
1215 | if (/\G(.+)/g) { |
|
|
1216 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
|
|
1217 | } |
|
|
1218 | } |
|
|
1219 | |
876 | 1; |
1220 | 1; |
877 | |
1221 | |
878 | =back |
|
|
879 | |
|
|
880 | =head1 EXAMPLES |
1222 | =head1 EXAMPLES |
881 | |
1223 | |
882 | This section shows some common configurations. |
1224 | This section shows some common configurations, both as code, and as |
|
|
1225 | C<PERL_ANYEVENT_LOG> string. |
883 | |
1226 | |
884 | =over 4 |
1227 | =over 4 |
885 | |
1228 | |
886 | =item Setting the global logging level. |
1229 | =item Setting the global logging level. |
887 | |
1230 | |
888 | Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
1231 | Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before |
889 | running your program, or modify the log level of the root context: |
1232 | running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of |
|
|
1233 | the root context at runtime: |
890 | |
1234 | |
891 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1235 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
892 | |
1236 | |
|
|
1237 | PERL_ANYEVENT_LOG=log=warn |
|
|
1238 | |
893 | $AnyEvent::Log::FILTER->level ("warn"); |
1239 | $AnyEvent::Log::FILTER->level ("warn"); |
894 | |
1240 | |
895 | =item Append all messages to a file instead of sending them to STDERR. |
1241 | =item Append all messages to a file instead of sending them to STDERR. |
896 | |
1242 | |
897 | This is affected by the global logging level. |
1243 | This is affected by the global logging level. |
898 | |
1244 | |
899 | $AnyEvent::Log::LOG->log_to_file ($path); (sub { |
1245 | $AnyEvent::Log::LOG->log_to_file ($path); |
|
|
1246 | |
|
|
1247 | PERL_ANYEVENT_LOG=log=file=/some/path |
900 | |
1248 | |
901 | =item Write all messages with priority C<error> and higher to a file. |
1249 | =item Write all messages with priority C<error> and higher to a file. |
902 | |
1250 | |
903 | This writes them only when the global logging level allows it, because |
1251 | This writes them only when the global logging level allows it, because |
904 | it is attached to the default context which is invoked I<after> global |
1252 | it is attached to the default context which is invoked I<after> global |
905 | filtering. |
1253 | filtering. |
906 | |
1254 | |
907 | $AnyEvent::Log::FILTER->attach |
1255 | $AnyEvent::Log::FILTER->attach ( |
908 | new AnyEvent::Log::Ctx log_to_file => $path); |
1256 | new AnyEvent::Log::Ctx log_to_file => $path); |
|
|
1257 | |
|
|
1258 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
909 | |
1259 | |
910 | This writes them regardless of the global logging level, because it is |
1260 | This writes them regardless of the global logging level, because it is |
911 | attached to the toplevel context, which receives all messages I<before> |
1261 | attached to the toplevel context, which receives all messages I<before> |
912 | the global filtering. |
1262 | the global filtering. |
913 | |
1263 | |
914 | $AnyEvent::Log::COLLECT->attach ( |
1264 | $AnyEvent::Log::COLLECT->attach ( |
915 | new AnyEvent::Log::Ctx log_to_file => $path); |
1265 | new AnyEvent::Log::Ctx log_to_file => $path); |
916 | |
1266 | |
|
|
1267 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
|
|
1268 | |
917 | In both cases, messages are still written to STDERR. |
1269 | In both cases, messages are still written to STDERR. |
918 | |
1270 | |
919 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1271 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
920 | |
1272 | |
921 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1273 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
922 | context - this simply circumvents the global filtering for trace messages. |
1274 | context - this simply circumvents the global filtering for trace messages. |
923 | |
1275 | |
924 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1276 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
925 | $debug->attach ($AnyEvent::Log::LOG); |
1277 | $debug->attach ($AnyEvent::Log::LOG); |
|
|
1278 | |
|
|
1279 | PERL_ANYEVENT_LOG=AnyEvent::Debug=+log |
926 | |
1280 | |
927 | This of course works for any package, not just L<AnyEvent::Debug>, but |
1281 | This of course works for any package, not just L<AnyEvent::Debug>, but |
928 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
1282 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
929 | default. |
1283 | default. |
930 | |
1284 | |
… | |
… | |
934 | |
1288 | |
935 | Marc Lehmann <schmorp@schmorp.de> |
1289 | Marc Lehmann <schmorp@schmorp.de> |
936 | http://home.schmorp.de/ |
1290 | http://home.schmorp.de/ |
937 | |
1291 | |
938 | =cut |
1292 | =cut |
|
|
1293 | |