… | |
… | |
6 | |
6 | |
7 | Simple uses: |
7 | Simple uses: |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
11 | AE::log debug => "hit my knee"; |
11 | AE::log trace => "going to call function abc"; |
12 | AE::log warn => "it's a bit too hot"; |
12 | AE::log debug => "the function returned 3"; |
13 | AE::log error => "the flag was false!"; |
13 | AE::log info => "file soandso successfully deleted"; |
14 | AE::log fatal => "the bit toggled! run!"; # never returns |
14 | AE::log note => "wanted to create config, but config was already created"; |
|
|
15 | AE::log warn => "couldn't delete the file"; |
|
|
16 | AE::log error => "failed to retrieve data"; |
|
|
17 | AE::log crit => "the battery temperature is too hot"; |
|
|
18 | AE::log alert => "the battery died"; |
|
|
19 | AE::log fatal => "no config found, cannot continue"; # never returns |
15 | |
20 | |
|
|
21 | Log level overview: |
|
|
22 | |
|
|
23 | LVL NAME SYSLOG PERL NOTE |
|
|
24 | 1 fatal emerg exit system unusable, aborts program! |
|
|
25 | 2 alert failure in primary system |
|
|
26 | 3 critical crit failure in backup system |
|
|
27 | 4 error err die non-urgent program errors, a bug |
|
|
28 | 5 warn warning possible problem, not necessarily error |
|
|
29 | 6 note notice unusual conditions |
|
|
30 | 7 info normal messages, no action required |
|
|
31 | 8 debug debugging messages for development |
|
|
32 | 9 trace copious tracing output |
|
|
33 | |
16 | "Complex" uses (for speed sensitive code): |
34 | "Complex" uses (for speed sensitive code, e.g. trace/debug messages): |
17 | |
35 | |
18 | use AnyEvent::Log; |
36 | use AnyEvent::Log; |
19 | |
37 | |
20 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
38 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
21 | |
39 | |
… | |
… | |
43 | attempt to be "the" logging solution or even "a" logging solution for |
61 | attempt to be "the" logging solution or even "a" logging solution for |
44 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
62 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
45 | module more or less exposes the mechanism, with some extra spiff to allow |
63 | module more or less exposes the mechanism, with some extra spiff to allow |
46 | using it from other modules as well. |
64 | using it from other modules as well. |
47 | |
65 | |
48 | Remember that the default verbosity level is C<0> (C<off>), so nothing |
66 | Remember that the default verbosity level is C<3> (C<critical>), so little |
49 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
67 | 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 |
68 | before starting your program, or change the logging level at runtime with |
51 | something like: |
69 | something like: |
52 | |
70 | |
53 | use AnyEvent::Log; |
71 | use AnyEvent::Log; |
… | |
… | |
72 | numerical value". |
90 | numerical value". |
73 | |
91 | |
74 | Instead of specifying levels by name you can also specify them by aliases: |
92 | Instead of specifying levels by name you can also specify them by aliases: |
75 | |
93 | |
76 | LVL NAME SYSLOG PERL NOTE |
94 | LVL NAME SYSLOG PERL NOTE |
77 | 1 fatal emerg exit aborts program! |
95 | 1 fatal emerg exit system unusable, aborts program! |
78 | 2 alert |
96 | 2 alert failure in primary system |
79 | 3 critical crit |
97 | 3 critical crit failure in backup system |
80 | 4 error err die |
98 | 4 error err die non-urgent program errors, a bug |
81 | 5 warn warning |
99 | 5 warn warning possible problem, not necessarily error |
82 | 6 note notice |
100 | 6 note notice unusual conditions |
83 | 7 info |
101 | 7 info normal messages, no action required |
84 | 8 debug |
102 | 8 debug debugging messages for development |
85 | 9 trace |
103 | 9 trace copious tracing output |
86 | |
104 | |
87 | As you can see, some logging levels have multiple aliases - the first one |
105 | As you can see, some logging levels have multiple aliases - the first one |
88 | is the "official" name, the second one the "syslog" name (if it differs) |
106 | is the "official" name, the second one the "syslog" name (if it differs) |
89 | and the third one the "perl" name, suggesting that you log C<die> messages |
107 | and the third one the "perl" name, suggesting (only!) that you log C<die> |
90 | at C<error> priority. |
108 | messages at C<error> priority. The NOTE column tries to provide some |
|
|
109 | rationale on how to chose a logging level. |
91 | |
110 | |
|
|
111 | As a rough guideline, levels 1..3 are primarily meant for users of the |
|
|
112 | program (admins, staff), and are the only ones logged to STDERR by |
|
|
113 | default. Levels 4..6 are meant for users and developers alike, while |
|
|
114 | levels 7..9 are usually meant for developers. |
|
|
115 | |
92 | You can normally only log a single message at highest priority level |
116 | You can normally only log a message once at highest priority level (C<1>, |
93 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
117 | C<fatal>), because logging a fatal message will also quit the program - so |
94 | program - so use it sparingly :) |
118 | use it sparingly :) |
95 | |
119 | |
96 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
120 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
97 | or C<all> - these are only valid in the methods they are documented for. |
121 | or C<all> - these are only valid for the methods that documented them. |
98 | |
122 | |
99 | =head1 LOGGING FUNCTIONS |
123 | =head1 LOGGING FUNCTIONS |
100 | |
124 | |
101 | These functions allow you to log messages. They always use the caller's |
125 | The following functions allow you to log messages. They always use the |
102 | package as a "logging context". Also, the main logging function C<log> is |
126 | caller's package as a "logging context". Also, the main logging function, |
103 | callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is |
127 | C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent> |
104 | loaded. |
128 | module is loaded. |
105 | |
129 | |
106 | =over 4 |
130 | =over 4 |
107 | |
131 | |
108 | =cut |
132 | =cut |
109 | |
133 | |
110 | package AnyEvent::Log; |
134 | package AnyEvent::Log; |
111 | |
135 | |
112 | use Carp (); |
136 | use Carp (); |
113 | use POSIX (); |
137 | use POSIX (); |
|
|
138 | |
|
|
139 | # layout of a context |
|
|
140 | # 0 1 2 3 4, 5 |
|
|
141 | # [$title, $level, %$slaves, &$logcb, &$fmtcb, $cap] |
114 | |
142 | |
115 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
143 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
116 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
144 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
117 | |
145 | |
118 | our $VERSION = $AnyEvent::VERSION; |
146 | our $VERSION = $AnyEvent::VERSION; |
… | |
… | |
151 | =item AnyEvent::Log::log $level, $msg[, @args] |
179 | =item AnyEvent::Log::log $level, $msg[, @args] |
152 | |
180 | |
153 | Requests logging of the given C<$msg> with the given log level, and |
181 | Requests logging of the given C<$msg> with the given log level, and |
154 | returns true if the message was logged I<somewhere>. |
182 | returns true if the message was logged I<somewhere>. |
155 | |
183 | |
156 | For C<fatal> log levels, the program will abort. |
184 | For loglevel C<fatal>, the program will abort. |
157 | |
185 | |
158 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
186 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
159 | C<$msg> is interpreted as an sprintf format string. |
187 | C<$msg> is interpreted as an sprintf format string. |
160 | |
188 | |
161 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
189 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
… | |
… | |
163 | |
191 | |
164 | Last not least, C<$msg> might be a code reference, in which case it is |
192 | Last not least, C<$msg> might be a code reference, in which case it is |
165 | supposed to return the message. It will be called only then the message |
193 | supposed to return the message. It will be called only then the message |
166 | actually gets logged, which is useful if it is costly to create the |
194 | actually gets logged, which is useful if it is costly to create the |
167 | message in the first place. |
195 | message in the first place. |
|
|
196 | |
|
|
197 | This function takes care of saving and restoring C<$!> and C<$@>, so you |
|
|
198 | don't have to. |
168 | |
199 | |
169 | Whether the given message will be logged depends on the maximum log level |
200 | Whether the given message will be logged depends on the maximum log level |
170 | and the caller's package. The return value can be used to ensure that |
201 | and the caller's package. The return value can be used to ensure that |
171 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
202 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
172 | runtime error it tries to log it at C<die> level, but if that message is |
203 | runtime error it tries to log it at C<die> level, but if that message is |
… | |
… | |
240 | } |
271 | } |
241 | |
272 | |
242 | join "", @res |
273 | join "", @res |
243 | } |
274 | } |
244 | |
275 | |
|
|
276 | sub fatal_exit() { |
|
|
277 | exit 1; |
|
|
278 | } |
|
|
279 | |
245 | sub _log { |
280 | sub _log { |
246 | my ($ctx, $level, $format, @args) = @_; |
281 | my ($ctx, $level, $format, @args) = @_; |
247 | |
282 | |
248 | $level = $level > 0 && $level <= 9 |
283 | $level = $level > 0 && $level <= 9 |
249 | ? $level+0 |
284 | ? $level+0 |
250 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
285 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
251 | |
286 | |
252 | my $mask = 1 << $level; |
287 | my $mask = 1 << $level; |
253 | |
288 | |
254 | my ($success, %seen, @ctx, $now, $fmt); |
289 | my ($success, %seen, @ctx, $now, @fmt); |
255 | |
290 | |
256 | do |
291 | do |
257 | { |
292 | { |
258 | # skip if masked |
293 | # if !ref, then it's a level number |
|
|
294 | if (!ref $ctx) { |
|
|
295 | $level = $ctx; |
259 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
296 | } elsif ($ctx->[1] & $mask and !$seen{$ctx+0}++) { |
|
|
297 | # logging/recursing into this context |
|
|
298 | |
|
|
299 | # level cap |
|
|
300 | if ($ctx->[5] > $level) { |
|
|
301 | push @ctx, $level; # restore level when going up in tree |
|
|
302 | $level = $ctx->[5]; |
|
|
303 | } |
|
|
304 | |
|
|
305 | # log if log cb |
260 | if ($ctx->[3]) { |
306 | if ($ctx->[3]) { |
261 | # logging target found |
307 | # logging target found |
|
|
308 | |
|
|
309 | local ($!, $@); |
262 | |
310 | |
263 | # now get raw message, unless we have it already |
311 | # now get raw message, unless we have it already |
264 | unless ($now) { |
312 | unless ($now) { |
265 | $format = $format->() if ref $format; |
313 | $format = $format->() if ref $format; |
266 | $format = sprintf $format, @args if @args; |
314 | $format = sprintf $format, @args if @args; |
… | |
… | |
269 | }; |
317 | }; |
270 | |
318 | |
271 | # format msg |
319 | # format msg |
272 | my $str = $ctx->[4] |
320 | my $str = $ctx->[4] |
273 | ? $ctx->[4]($now, $_[0], $level, $format) |
321 | ? $ctx->[4]($now, $_[0], $level, $format) |
274 | : ($fmt ||= _format $now, $_[0], $level, $format); |
322 | : ($fmt[$level] ||= _format $now, $_[0], $level, $format); |
275 | |
323 | |
276 | $success = 1; |
324 | $success = 1; |
277 | |
325 | |
278 | $ctx->[3]($str) |
326 | $ctx->[3]($str) |
279 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
327 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
… | |
… | |
282 | } |
330 | } |
283 | } |
331 | } |
284 | } |
332 | } |
285 | while $ctx = pop @ctx; |
333 | while $ctx = pop @ctx; |
286 | |
334 | |
287 | exit 1 if $level <= 1; |
335 | fatal_exit if $level <= 1; |
288 | |
336 | |
289 | $success |
337 | $success |
290 | } |
338 | } |
291 | |
339 | |
292 | sub log($$;@) { |
340 | sub log($$;@) { |
293 | _log |
341 | _log |
294 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
342 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
295 | @_; |
343 | @_; |
296 | } |
344 | } |
297 | |
345 | |
298 | *AnyEvent::log = *AE::log = \&log; |
|
|
299 | |
|
|
300 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
346 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
301 | |
347 | |
302 | Creates a code reference that, when called, acts as if the |
348 | Creates a code reference that, when called, acts as if the |
303 | C<AnyEvent::Log::log> function was called at this point with the given |
349 | C<AnyEvent::Log::log> function was called at this point with the given |
304 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
350 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
… | |
… | |
368 | |
414 | |
369 | $LOGGER{$logger+0} = $logger; |
415 | $LOGGER{$logger+0} = $logger; |
370 | |
416 | |
371 | _reassess $logger+0; |
417 | _reassess $logger+0; |
372 | |
418 | |
373 | require AnyEvent::Util; |
419 | require AnyEvent::Util unless $AnyEvent::Util::VERSION; |
374 | my $guard = AnyEvent::Util::guard (sub { |
420 | my $guard = AnyEvent::Util::guard (sub { |
375 | # "clean up" |
421 | # "clean up" |
376 | delete $LOGGER{$logger+0}; |
422 | delete $LOGGER{$logger+0}; |
377 | }); |
423 | }); |
378 | |
424 | |
… | |
… | |
531 | This can be used to implement config-file (re-)loading: before loading a |
577 | This can be used to implement config-file (re-)loading: before loading a |
532 | configuration, reset all contexts. |
578 | configuration, reset all contexts. |
533 | |
579 | |
534 | =cut |
580 | =cut |
535 | |
581 | |
|
|
582 | our $ORIG_VERBOSE = $AnyEvent::VERBOSE; |
|
|
583 | $AnyEvent::VERBOSE = 9; |
|
|
584 | |
536 | sub reset { |
585 | sub reset { |
537 | # hard to kill complex data structures |
586 | # hard to kill complex data structures |
538 | # we "recreate" all package loggers and reset the hierarchy |
587 | # we "recreate" all package loggers and reset the hierarchy |
539 | while (my ($k, $v) = each %CTX) { |
588 | while (my ($k, $v) = each %CTX) { |
540 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
589 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
… | |
… | |
549 | $LOG->title ('$AnyEvent::Log::LOG'); |
598 | $LOG->title ('$AnyEvent::Log::LOG'); |
550 | $LOG->log_to_warn; |
599 | $LOG->log_to_warn; |
551 | |
600 | |
552 | $FILTER->slaves ($LOG); |
601 | $FILTER->slaves ($LOG); |
553 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
602 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
554 | $FILTER->level ($AnyEvent::VERBOSE); |
603 | $FILTER->level ($ORIG_VERBOSE); |
555 | |
604 | |
556 | $COLLECT->slaves ($FILTER); |
605 | $COLLECT->slaves ($FILTER); |
557 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
606 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
558 | |
607 | |
559 | _reassess; |
608 | _reassess; |
560 | } |
609 | } |
|
|
610 | |
|
|
611 | # override AE::log/logger |
|
|
612 | *AnyEvent::log = *AE::log = \&log; |
|
|
613 | *AnyEvent::logger = *AE::logger = \&logger; |
|
|
614 | |
|
|
615 | # convert AnyEvent loggers to AnyEvent::Log loggers |
|
|
616 | $_->[0] = ctx $_->[0] # convert "pkg" to "ctx" |
|
|
617 | for values %LOGGER; |
561 | |
618 | |
562 | # create the default logger contexts |
619 | # create the default logger contexts |
563 | $LOG = ctx undef; |
620 | $LOG = ctx undef; |
564 | $FILTER = ctx undef; |
621 | $FILTER = ctx undef; |
565 | $COLLECT = ctx undef; |
622 | $COLLECT = ctx undef; |
… | |
… | |
574 | package AnyEvent::Log::COLLECT; |
631 | package AnyEvent::Log::COLLECT; |
575 | package AE::Log::COLLECT; |
632 | package AE::Log::COLLECT; |
576 | |
633 | |
577 | package AnyEvent::Log::Ctx; |
634 | package AnyEvent::Log::Ctx; |
578 | |
635 | |
579 | # 0 1 2 3 4 |
|
|
580 | # [$title, $level, %$slaves, &$logcb, &$fmtcb] |
|
|
581 | |
|
|
582 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
636 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
583 | |
637 | |
584 | This is a convenience constructor that makes it simpler to construct |
638 | This is a convenience constructor that makes it simpler to construct |
585 | anonymous logging contexts. |
639 | anonymous logging contexts. |
586 | |
640 | |
… | |
… | |
673 | |
727 | |
674 | =item $ctx->disable ($level[, $level...]) |
728 | =item $ctx->disable ($level[, $level...]) |
675 | |
729 | |
676 | Disables logging for the given levels, leaving all others unchanged. |
730 | Disables logging for the given levels, leaving all others unchanged. |
677 | |
731 | |
|
|
732 | =item $ctx->cap ($level) |
|
|
733 | |
|
|
734 | Caps the maximum priority to the given level, for all messages logged |
|
|
735 | to, or passing through, this context. That is, while this doesn't affect |
|
|
736 | whether a message is logged or passed on, the maximum priority of messages |
|
|
737 | will be limited to the specified level - messages with a higher priority |
|
|
738 | will be set to the specified priority. |
|
|
739 | |
|
|
740 | Another way to view this is that C<< ->level >> filters out messages with |
|
|
741 | a too low priority, while C<< ->cap >> modifies messages with a too high |
|
|
742 | priority. |
|
|
743 | |
|
|
744 | This is useful when different log targets have different interpretations |
|
|
745 | of priority. For example, for a specific command line program, a wrong |
|
|
746 | command line switch might well result in a C<fatal> log message, while the |
|
|
747 | same message, logged to syslog, is likely I<not> fatal to the system or |
|
|
748 | syslog facility as a whole, but more likely a mere C<error>. |
|
|
749 | |
|
|
750 | This can be modeled by having a stderr logger that logs messages "as-is" |
|
|
751 | and a syslog logger that logs messages with a level cap of, say, C<error>, |
|
|
752 | or, for truly system-critical components, actually C<critical>. |
|
|
753 | |
678 | =cut |
754 | =cut |
679 | |
755 | |
680 | sub _lvl_lst { |
756 | sub _lvl_lst { |
681 | map { |
757 | map { |
682 | $_ > 0 && $_ <= 9 ? $_+0 |
758 | $_ > 0 && $_ <= 9 ? $_+0 |
683 | : $_ eq "all" ? (1 .. 9) |
759 | : $_ eq "all" ? (1 .. 9) |
684 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
760 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
685 | } @_ |
761 | } @_ |
686 | } |
762 | } |
687 | |
763 | |
|
|
764 | sub _lvl { |
|
|
765 | $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1] |
|
|
766 | } |
|
|
767 | |
688 | our $NOP_CB = sub { 0 }; |
768 | our $NOP_CB = sub { 0 }; |
689 | |
769 | |
690 | sub levels { |
770 | sub levels { |
691 | my $ctx = shift; |
771 | my $ctx = shift; |
692 | $ctx->[1] = 0; |
772 | $ctx->[1] = 0; |
… | |
… | |
695 | AnyEvent::Log::_reassess; |
775 | AnyEvent::Log::_reassess; |
696 | } |
776 | } |
697 | |
777 | |
698 | sub level { |
778 | sub level { |
699 | my $ctx = shift; |
779 | my $ctx = shift; |
700 | my $lvl = $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1]; |
|
|
701 | |
|
|
702 | $ctx->[1] = ((1 << $lvl) - 1) << 1; |
780 | $ctx->[1] = ((1 << &_lvl) - 1) << 1; |
703 | AnyEvent::Log::_reassess; |
781 | AnyEvent::Log::_reassess; |
704 | } |
782 | } |
705 | |
783 | |
706 | sub enable { |
784 | sub enable { |
707 | my $ctx = shift; |
785 | my $ctx = shift; |
… | |
… | |
715 | $ctx->[1] &= ~(1 << $_) |
793 | $ctx->[1] &= ~(1 << $_) |
716 | for &_lvl_lst; |
794 | for &_lvl_lst; |
717 | AnyEvent::Log::_reassess; |
795 | AnyEvent::Log::_reassess; |
718 | } |
796 | } |
719 | |
797 | |
|
|
798 | sub cap { |
|
|
799 | my $ctx = shift; |
|
|
800 | $ctx->[5] = &_lvl; |
|
|
801 | } |
|
|
802 | |
720 | =back |
803 | =back |
721 | |
804 | |
722 | =head3 SLAVE CONTEXTS |
805 | =head3 SLAVE CONTEXTS |
723 | |
806 | |
724 | The following methods attach and detach another logging context to a |
807 | The following methods attach and detach another logging context to a |
… | |
… | |
1054 | =item C<nolog> |
1137 | =item C<nolog> |
1055 | |
1138 | |
1056 | Configures the context to not log anything by itself, which is the |
1139 | Configures the context to not log anything by itself, which is the |
1057 | default. Same as C<< $ctx->log_cb (undef) >>. |
1140 | default. Same as C<< $ctx->log_cb (undef) >>. |
1058 | |
1141 | |
|
|
1142 | =item C<cap=>I<level> |
|
|
1143 | |
|
|
1144 | Caps logging messages entering this context at the given level, i.e. |
|
|
1145 | reduces the priority of messages with higher priority than this level. The |
|
|
1146 | default is C<0> (or C<off>), meaning the priority will not be touched. |
|
|
1147 | |
1059 | =item C<0> or C<off> |
1148 | =item C<0> or C<off> |
1060 | |
1149 | |
1061 | Sets the logging level of the context ot C<0>, i.e. all messages will be |
1150 | Sets the logging level of the context to C<0>, i.e. all messages will be |
1062 | filtered out. |
1151 | filtered out. |
1063 | |
1152 | |
1064 | =item C<all> |
1153 | =item C<all> |
1065 | |
1154 | |
1066 | Enables all logging levels, i.e. filtering will effectively be switched |
1155 | Enables all logging levels, i.e. filtering will effectively be switched |
… | |
… | |
1108 | |
1197 | |
1109 | Attaches the named context as slave to the context. |
1198 | Attaches the named context as slave to the context. |
1110 | |
1199 | |
1111 | =item C<+> |
1200 | =item C<+> |
1112 | |
1201 | |
1113 | A line C<+> detaches all contexts, i.e. clears the slave list from the |
1202 | A lone C<+> detaches all contexts, i.e. clears the slave list from the |
1114 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1203 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1115 | but package contexts have the parent context as slave by default. |
1204 | but package contexts have the parent context as slave by default. |
1116 | |
1205 | |
1117 | Example: log messages from My::Module to a file, do not send them to the |
1206 | Example: log messages from My::Module to a file, do not send them to the |
1118 | default log collector. |
1207 | default log collector. |
… | |
… | |
1149 | |
1238 | |
1150 | my $pkg = sub { |
1239 | my $pkg = sub { |
1151 | $_[0] eq "log" ? $LOG |
1240 | $_[0] eq "log" ? $LOG |
1152 | : $_[0] eq "filter" ? $FILTER |
1241 | : $_[0] eq "filter" ? $FILTER |
1153 | : $_[0] eq "collect" ? $COLLECT |
1242 | : $_[0] eq "collect" ? $COLLECT |
1154 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= ctx undef) |
1243 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= do { my $ctx = ctx undef; $ctx->[0] = $_[0]; $ctx }) |
1155 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
1244 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
1156 | : die # never reached? |
1245 | : die # never reached? |
1157 | }; |
1246 | }; |
1158 | |
1247 | |
1159 | /\G[[:space:]]+/gc; # skip initial whitespace |
1248 | /\G[[:space:]]+/gc; # skip initial whitespace |
… | |
… | |
1165 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
1254 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
1166 | for ("$1") { |
1255 | for ("$1") { |
1167 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
1256 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
1168 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
1257 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
1169 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
1258 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
1170 | } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ($1); |
1259 | } elsif (/^syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ("$1"); |
1171 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
1260 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
|
|
1261 | } elsif (/^cap=(.+)/ ) { $ctx->cap ("$1"); |
1172 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
1262 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
1173 | } elsif ($_ eq "+" ) { $ctx->slaves; |
1263 | } elsif ($_ eq "+" ) { $ctx->slaves; |
1174 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
1264 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
1175 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
1265 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
1176 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
1266 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
… | |
… | |
1228 | |
1318 | |
1229 | This writes them only when the global logging level allows it, because |
1319 | This writes them only when the global logging level allows it, because |
1230 | it is attached to the default context which is invoked I<after> global |
1320 | it is attached to the default context which is invoked I<after> global |
1231 | filtering. |
1321 | filtering. |
1232 | |
1322 | |
1233 | $AnyEvent::Log::FILTER->attach |
1323 | $AnyEvent::Log::FILTER->attach ( |
1234 | new AnyEvent::Log::Ctx log_to_file => $path); |
1324 | new AnyEvent::Log::Ctx log_to_file => $path); |
1235 | |
1325 | |
1236 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
1326 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
1237 | |
1327 | |
1238 | This writes them regardless of the global logging level, because it is |
1328 | This writes them regardless of the global logging level, because it is |
… | |
… | |
1244 | |
1334 | |
1245 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
1335 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
1246 | |
1336 | |
1247 | In both cases, messages are still written to STDERR. |
1337 | In both cases, messages are still written to STDERR. |
1248 | |
1338 | |
|
|
1339 | =item Additionally log all messages with C<warn> and higher priority to |
|
|
1340 | C<syslog>, but cap at C<error>. |
|
|
1341 | |
|
|
1342 | This logs all messages to the default log target, but also logs messages |
|
|
1343 | with priority C<warn> or higher (and not filtered otherwise) to syslog |
|
|
1344 | facility C<user>. Messages with priority higher than C<error> will be |
|
|
1345 | logged with level C<error>. |
|
|
1346 | |
|
|
1347 | $AnyEvent::Log::LOG->attach ( |
|
|
1348 | new AnyEvent::Log::Ctx |
|
|
1349 | level => "warn", |
|
|
1350 | cap => "error", |
|
|
1351 | syslog => "user", |
|
|
1352 | ); |
|
|
1353 | |
|
|
1354 | PERL_ANYEVENT_LOG=log=+%syslog:%syslog=warn,cap=error,syslog |
|
|
1355 | |
1249 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1356 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1250 | |
1357 | |
1251 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1358 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1252 | context - this simply circumvents the global filtering for trace messages. |
1359 | context - this simply circumvents the global filtering for trace messages. |
1253 | |
1360 | |