… | |
… | |
11 | AE::log debug => "hit my knee"; |
11 | AE::log debug => "hit my knee"; |
12 | AE::log warn => "it's a bit too hot"; |
12 | AE::log warn => "it's a bit too hot"; |
13 | AE::log error => "the flag was false!"; |
13 | AE::log error => "the flag was false!"; |
14 | AE::log fatal => "the bit toggled! run!"; # never returns |
14 | AE::log fatal => "the bit toggled! run!"; # never returns |
15 | |
15 | |
|
|
16 | # available log levels in order: |
|
|
17 | # fatal alert critical error warn note info debug trace |
|
|
18 | |
16 | "Complex" uses (for speed sensitive code): |
19 | "Complex" uses (for speed sensitive code): |
17 | |
20 | |
18 | use AnyEvent::Log; |
21 | use AnyEvent::Log; |
19 | |
22 | |
20 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
23 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
… | |
… | |
32 | |
35 | |
33 | # send all critical and higher priority messages to syslog, |
36 | # send all critical and higher priority messages to syslog, |
34 | # regardless of (most) other settings |
37 | # regardless of (most) other settings |
35 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
38 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
36 | level => "critical", |
39 | level => "critical", |
37 | log_to_syslog => 0, |
40 | log_to_syslog => "user", |
38 | ); |
41 | ); |
39 | |
42 | |
40 | =head1 DESCRIPTION |
43 | =head1 DESCRIPTION |
41 | |
44 | |
42 | This module implements a relatively simple "logging framework". It doesn't |
45 | This module implements a relatively simple "logging framework". It doesn't |
… | |
… | |
49 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
52 | 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 |
53 | before starting your program, or change the logging level at runtime with |
51 | something like: |
54 | something like: |
52 | |
55 | |
53 | use AnyEvent::Log; |
56 | use AnyEvent::Log; |
54 | AnyEvent::Log::FILTER->level ("info"); |
57 | $AnyEvent::Log::FILTER->level ("info"); |
55 | |
58 | |
56 | 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), |
57 | 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 |
58 | 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 |
59 | targets, or being able to log into a database. |
62 | targets, or being able to log into a database. |
60 | |
63 | |
|
|
64 | The module is also usable before AnyEvent itself is initialised, in which |
|
|
65 | case some of the functionality might be reduced. |
|
|
66 | |
61 | The amount of documentation might indicate otherwise, but the module is |
67 | The amount of documentation might indicate otherwise, but the runtime part |
62 | still just below 300 lines of code. |
68 | of the module is still just below 300 lines of code. |
63 | |
69 | |
64 | =head1 LOGGING LEVELS |
70 | =head1 LOGGING LEVELS |
65 | |
71 | |
66 | 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> |
67 | (lowest priority). Note that the lowest numerical value is the highest |
73 | (lowest priority). Note that the lowest numerical value is the highest |
… | |
… | |
69 | numerical value". |
75 | numerical value". |
70 | |
76 | |
71 | 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: |
72 | |
78 | |
73 | LVL NAME SYSLOG PERL NOTE |
79 | LVL NAME SYSLOG PERL NOTE |
74 | 1 fatal emerg exit aborts program! |
80 | 1 fatal emerg exit system unusable, aborts program! |
75 | 2 alert |
81 | 2 alert failure in primary system |
76 | 3 critical crit |
82 | 3 critical crit failure in backup system |
77 | 4 error err die |
83 | 4 error err die non-urgent program errors, a bug |
78 | 5 warn warning |
84 | 5 warn warning possible problem, not necessarily error |
79 | 6 note notice |
85 | 6 note notice unusual conditions |
80 | 7 info |
86 | 7 info normal messages, no action required |
81 | 8 debug |
87 | 8 debug debugging messages for development |
82 | 9 trace |
88 | 9 trace copious tracing output |
83 | |
89 | |
84 | 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 |
85 | 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) |
86 | 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> |
87 | 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. |
88 | |
100 | |
89 | 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 |
90 | (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 |
91 | program - so use it sparingly :) |
103 | program - so use it sparingly :) |
92 | |
104 | |
… | |
… | |
108 | |
120 | |
109 | use Carp (); |
121 | use Carp (); |
110 | use POSIX (); |
122 | use POSIX (); |
111 | |
123 | |
112 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
124 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
113 | use AnyEvent::Util (); |
125 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
114 | |
126 | |
115 | our $VERSION = $AnyEvent::VERSION; |
127 | our $VERSION = $AnyEvent::VERSION; |
116 | |
128 | |
117 | our ($COLLECT, $FILTER, $LOG); |
129 | our ($COLLECT, $FILTER, $LOG); |
118 | |
130 | |
… | |
… | |
148 | =item AnyEvent::Log::log $level, $msg[, @args] |
160 | =item AnyEvent::Log::log $level, $msg[, @args] |
149 | |
161 | |
150 | Requests logging of the given C<$msg> with the given log level, and |
162 | Requests logging of the given C<$msg> with the given log level, and |
151 | returns true if the message was logged I<somewhere>. |
163 | returns true if the message was logged I<somewhere>. |
152 | |
164 | |
153 | For C<fatal> log levels, the program will abort. |
165 | For loglevel C<fatal>, the program will abort. |
154 | |
166 | |
155 | 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 |
156 | C<$msg> is interpreted as an sprintf format string. |
168 | C<$msg> is interpreted as an sprintf format string. |
157 | |
169 | |
158 | 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 |
… | |
… | |
203 | info => 7, |
215 | info => 7, |
204 | debug => 8, |
216 | debug => 8, |
205 | trace => 9, |
217 | trace => 9, |
206 | ); |
218 | ); |
207 | |
219 | |
208 | 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 | } |
209 | |
232 | |
210 | AnyEvent::post_detect { |
233 | AnyEvent::post_detect { |
211 | *now = \&AE::now; |
234 | exact_time $TIME_EXACT; |
212 | }; |
235 | }; |
213 | |
236 | |
214 | 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); |
215 | |
238 | |
216 | # time, ctx, level, msg |
239 | # time, ctx, level, msg |
… | |
… | |
224 | push @res, "$ts$ct$_\n"; |
247 | push @res, "$ts$ct$_\n"; |
225 | $ct = " + "; |
248 | $ct = " + "; |
226 | } |
249 | } |
227 | |
250 | |
228 | join "", @res |
251 | join "", @res |
|
|
252 | } |
|
|
253 | |
|
|
254 | sub fatal_exit() { |
|
|
255 | exit 1; |
229 | } |
256 | } |
230 | |
257 | |
231 | sub _log { |
258 | sub _log { |
232 | my ($ctx, $level, $format, @args) = @_; |
259 | my ($ctx, $level, $format, @args) = @_; |
233 | |
260 | |
… | |
… | |
249 | # now get raw message, unless we have it already |
276 | # now get raw message, unless we have it already |
250 | unless ($now) { |
277 | unless ($now) { |
251 | $format = $format->() if ref $format; |
278 | $format = $format->() if ref $format; |
252 | $format = sprintf $format, @args if @args; |
279 | $format = sprintf $format, @args if @args; |
253 | $format =~ s/\n$//; |
280 | $format =~ s/\n$//; |
254 | $now = AE::now; |
281 | $now = _ts; |
255 | }; |
282 | }; |
256 | |
283 | |
257 | # format msg |
284 | # format msg |
258 | my $str = $ctx->[4] |
285 | my $str = $ctx->[4] |
259 | ? $ctx->[4]($now, $_[0], $level, $format) |
286 | ? $ctx->[4]($now, $_[0], $level, $format) |
… | |
… | |
268 | } |
295 | } |
269 | } |
296 | } |
270 | } |
297 | } |
271 | while $ctx = pop @ctx; |
298 | while $ctx = pop @ctx; |
272 | |
299 | |
273 | exit 1 if $level <= 1; |
300 | fatal_exit if $level <= 1; |
274 | |
301 | |
275 | $success |
302 | $success |
276 | } |
303 | } |
277 | |
304 | |
278 | sub log($$;@) { |
305 | sub log($$;@) { |
279 | _log |
306 | _log |
280 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
307 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
281 | @_; |
308 | @_; |
282 | } |
309 | } |
283 | |
310 | |
284 | *AnyEvent::log = *AE::log = \&log; |
|
|
285 | |
|
|
286 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
311 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
287 | |
312 | |
288 | Creates a code reference that, when called, acts as if the |
313 | Creates a code reference that, when called, acts as if the |
289 | C<AnyEvent::Log::log> function was called at this point with the given |
314 | C<AnyEvent::Log::log> function was called at this point with the given |
290 | 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 |
… | |
… | |
354 | |
379 | |
355 | $LOGGER{$logger+0} = $logger; |
380 | $LOGGER{$logger+0} = $logger; |
356 | |
381 | |
357 | _reassess $logger+0; |
382 | _reassess $logger+0; |
358 | |
383 | |
|
|
384 | require AnyEvent::Util unless $AnyEvent::Util::VERSION; |
359 | my $guard = AnyEvent::Util::guard { |
385 | my $guard = AnyEvent::Util::guard (sub { |
360 | # "clean up" |
386 | # "clean up" |
361 | delete $LOGGER{$logger+0}; |
387 | delete $LOGGER{$logger+0}; |
362 | }; |
388 | }); |
363 | |
389 | |
364 | sub { |
390 | sub { |
365 | $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 |
366 | |
392 | |
367 | _log $ctx, $level, @_ |
393 | _log $ctx, $level, @_ |
… | |
… | |
372 | sub logger($;$) { |
398 | sub logger($;$) { |
373 | _logger |
399 | _logger |
374 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
400 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
375 | @_ |
401 | @_ |
376 | } |
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. |
377 | |
418 | |
378 | =back |
419 | =back |
379 | |
420 | |
380 | =head1 LOGGING CONTEXTS |
421 | =head1 LOGGING CONTEXTS |
381 | |
422 | |
… | |
… | |
501 | 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 |
502 | configuration, reset all contexts. |
543 | configuration, reset all contexts. |
503 | |
544 | |
504 | =cut |
545 | =cut |
505 | |
546 | |
|
|
547 | our $ORIG_VERBOSE = $AnyEvent::VERBOSE; |
|
|
548 | $AnyEvent::VERBOSE = 9; |
|
|
549 | |
506 | sub reset { |
550 | sub reset { |
507 | # hard to kill complex data structures |
551 | # hard to kill complex data structures |
508 | # we "recreate" all package loggers and reset the hierarchy |
552 | # we "recreate" all package loggers and reset the hierarchy |
509 | while (my ($k, $v) = each %CTX) { |
553 | while (my ($k, $v) = each %CTX) { |
510 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
554 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
… | |
… | |
513 | } |
557 | } |
514 | |
558 | |
515 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
559 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
516 | for $LOG, $FILTER, $COLLECT; |
560 | for $LOG, $FILTER, $COLLECT; |
517 | |
561 | |
518 | $LOG->slaves; |
562 | #$LOG->slaves; |
519 | $LOG->title ('$AnyEvent::Log::LOG'); |
563 | $LOG->title ('$AnyEvent::Log::LOG'); |
520 | $LOG->log_cb (sub { |
564 | $LOG->log_to_warn; |
521 | warn shift; |
|
|
522 | 0 |
|
|
523 | }); |
|
|
524 | |
565 | |
525 | $FILTER->slaves ($LOG); |
566 | $FILTER->slaves ($LOG); |
526 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
567 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
527 | $FILTER->level ($AnyEvent::VERBOSE); |
568 | $FILTER->level ($ORIG_VERBOSE); |
528 | |
569 | |
529 | $COLLECT->slaves ($FILTER); |
570 | $COLLECT->slaves ($FILTER); |
530 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
571 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
531 | |
572 | |
532 | _reassess; |
573 | _reassess; |
533 | } |
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; |
534 | |
583 | |
535 | # create the default logger contexts |
584 | # create the default logger contexts |
536 | $LOG = ctx undef; |
585 | $LOG = ctx undef; |
537 | $FILTER = ctx undef; |
586 | $FILTER = ctx undef; |
538 | $COLLECT = ctx undef; |
587 | $COLLECT = ctx undef; |
… | |
… | |
789 | logging context, the (numeric) logging level and the raw message string |
838 | 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 |
839 | 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 |
840 | string, but it could just as well be an array reference that just stores |
792 | the values. |
841 | the values. |
793 | |
842 | |
794 | 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 |
795 | 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 |
796 | inside the C<AnyEvent::Log> package. |
845 | inside the C<AnyEvent::Log> package. |
797 | |
846 | |
798 | 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 |
799 | brackets. |
848 | brackets. |
… | |
… | |
818 | "$msg->[3]"; |
867 | "$msg->[3]"; |
819 | |
868 | |
820 | 0 |
869 | 0 |
821 | }); |
870 | }); |
822 | |
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 | |
823 | =item $ctx->log_to_file ($path) |
877 | =item $ctx->log_to_file ($path) |
824 | |
878 | |
825 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
879 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
826 | |
880 | |
827 | =item $ctx->log_to_path ($path) |
881 | =item $ctx->log_to_path ($path) |
828 | |
882 | |
829 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
883 | 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 |
884 | is much slower, but allows you to change/move/rename/delete the file at |
831 | basically any time. |
885 | basically any time. |
832 | |
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 | |
833 | =item $ctx->log_to_syslog ([$log_flags]) |
891 | =item $ctx->log_to_syslog ([$facility]) |
834 | |
892 | |
835 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
893 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and |
836 | the others in the obvious way. If specified, then the C<$log_flags> are |
894 | all the others in the obvious way. If specified, then the C<$facility> is |
837 | simply or'ed onto the priority argument and can contain any C<LOG_xxx> |
895 | used as the facility (C<user>, C<auth>, C<local0> and so on). The default |
838 | flags valid for Sys::Syslog::syslog, except for the priority levels. |
896 | facility is C<user>. |
839 | |
897 | |
840 | Note that this function also sets a C<fmt_cb> - the logging part requires |
898 | Note that this function also sets a C<fmt_cb> - the logging part requires |
841 | an array reference with [$level, $str] as input. |
899 | an array reference with [$level, $str] as input. |
842 | |
900 | |
843 | =cut |
901 | =cut |
… | |
… | |
850 | |
908 | |
851 | sub fmt_cb { |
909 | sub fmt_cb { |
852 | my ($ctx, $cb) = @_; |
910 | my ($ctx, $cb) = @_; |
853 | |
911 | |
854 | $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 | }); |
855 | } |
922 | } |
856 | |
923 | |
857 | sub log_to_file { |
924 | sub log_to_file { |
858 | my ($ctx, $path) = @_; |
925 | my ($ctx, $path) = @_; |
859 | |
926 | |
… | |
… | |
864 | syswrite $fh, shift; |
931 | syswrite $fh, shift; |
865 | 0 |
932 | 0 |
866 | }); |
933 | }); |
867 | } |
934 | } |
868 | |
935 | |
869 | sub log_to_file { |
936 | sub log_to_path { |
870 | my ($ctx, $path) = @_; |
937 | my ($ctx, $path) = @_; |
871 | |
938 | |
872 | $ctx->log_cb (sub { |
939 | $ctx->log_cb (sub { |
873 | open my $fh, ">>", $path |
940 | open my $fh, ">>", $path |
874 | or die "$path: $!"; |
941 | or die "$path: $!"; |
… | |
… | |
877 | 0 |
944 | 0 |
878 | }); |
945 | }); |
879 | } |
946 | } |
880 | |
947 | |
881 | sub log_to_syslog { |
948 | sub log_to_syslog { |
882 | my ($ctx, $flags) = @_; |
949 | my ($ctx, $facility) = @_; |
883 | |
950 | |
884 | require Sys::Syslog; |
951 | require Sys::Syslog; |
885 | |
952 | |
886 | $ctx->fmt_cb (sub { |
953 | $ctx->fmt_cb (sub { |
887 | my $str = $_[3]; |
954 | my $str = $_[3]; |
888 | $str =~ s/\n(?=.)/\n+ /g; |
955 | $str =~ s/\n(?=.)/\n+ /g; |
889 | |
956 | |
890 | [$_[2], "($_[1][0]) $str"] |
957 | [$_[2], "($_[1][0]) $str"] |
891 | }); |
958 | }); |
892 | |
959 | |
|
|
960 | $facility ||= "user"; |
|
|
961 | |
893 | $ctx->log_cb (sub { |
962 | $ctx->log_cb (sub { |
894 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
963 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
895 | |
964 | |
896 | Sys::Syslog::syslog ($flags | ($lvl - 1), $_) |
965 | Sys::Syslog::syslog ("$facility|" . ($lvl - 1), $_) |
897 | for split /\n/, $_[0][1]; |
966 | for split /\n/, $_[0][1]; |
898 | |
967 | |
899 | 0 |
968 | 0 |
900 | }); |
969 | }); |
901 | } |
970 | } |
… | |
… | |
921 | =cut |
990 | =cut |
922 | |
991 | |
923 | *log = \&AnyEvent::Log::_log; |
992 | *log = \&AnyEvent::Log::_log; |
924 | *logger = \&AnyEvent::Log::_logger; |
993 | *logger = \&AnyEvent::Log::_logger; |
925 | |
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 | |
926 | 1; |
1220 | 1; |
927 | |
1221 | |
928 | =back |
|
|
929 | |
|
|
930 | =head1 EXAMPLES |
1222 | =head1 EXAMPLES |
931 | |
1223 | |
932 | This section shows some common configurations. |
1224 | This section shows some common configurations, both as code, and as |
|
|
1225 | C<PERL_ANYEVENT_LOG> string. |
933 | |
1226 | |
934 | =over 4 |
1227 | =over 4 |
935 | |
1228 | |
936 | =item Setting the global logging level. |
1229 | =item Setting the global logging level. |
937 | |
1230 | |
938 | Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
1231 | Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before |
939 | 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: |
940 | |
1234 | |
941 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1235 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
942 | |
1236 | |
|
|
1237 | PERL_ANYEVENT_LOG=log=warn |
|
|
1238 | |
943 | $AnyEvent::Log::FILTER->level ("warn"); |
1239 | $AnyEvent::Log::FILTER->level ("warn"); |
944 | |
1240 | |
945 | =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. |
946 | |
1242 | |
947 | This is affected by the global logging level. |
1243 | This is affected by the global logging level. |
948 | |
1244 | |
949 | $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 |
950 | |
1248 | |
951 | =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. |
952 | |
1250 | |
953 | 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 |
954 | 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 |
955 | filtering. |
1253 | filtering. |
956 | |
1254 | |
957 | $AnyEvent::Log::FILTER->attach |
1255 | $AnyEvent::Log::FILTER->attach ( |
958 | 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 |
959 | |
1259 | |
960 | 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 |
961 | attached to the toplevel context, which receives all messages I<before> |
1261 | attached to the toplevel context, which receives all messages I<before> |
962 | the global filtering. |
1262 | the global filtering. |
963 | |
1263 | |
964 | $AnyEvent::Log::COLLECT->attach ( |
1264 | $AnyEvent::Log::COLLECT->attach ( |
965 | new AnyEvent::Log::Ctx log_to_file => $path); |
1265 | new AnyEvent::Log::Ctx log_to_file => $path); |
966 | |
1266 | |
|
|
1267 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
|
|
1268 | |
967 | In both cases, messages are still written to STDERR. |
1269 | In both cases, messages are still written to STDERR. |
968 | |
1270 | |
969 | =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). |
970 | |
1272 | |
971 | 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> |
972 | context - this simply circumvents the global filtering for trace messages. |
1274 | context - this simply circumvents the global filtering for trace messages. |
973 | |
1275 | |
974 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1276 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
975 | $debug->attach ($AnyEvent::Log::LOG); |
1277 | $debug->attach ($AnyEvent::Log::LOG); |
|
|
1278 | |
|
|
1279 | PERL_ANYEVENT_LOG=AnyEvent::Debug=+log |
976 | |
1280 | |
977 | 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 |
978 | 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 |
979 | default. |
1283 | default. |
980 | |
1284 | |
… | |
… | |
984 | |
1288 | |
985 | Marc Lehmann <schmorp@schmorp.de> |
1289 | Marc Lehmann <schmorp@schmorp.de> |
986 | http://home.schmorp.de/ |
1290 | http://home.schmorp.de/ |
987 | |
1291 | |
988 | =cut |
1292 | =cut |
|
|
1293 | |