… | |
… | |
49 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
49 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
50 | before starting your program, or change the logging level at runtime with |
50 | before starting your program, or change the logging level at runtime with |
51 | something like: |
51 | something like: |
52 | |
52 | |
53 | use AnyEvent::Log; |
53 | use AnyEvent::Log; |
54 | AnyEvent::Log::FILTER->level ("info"); |
54 | $AnyEvent::Log::FILTER->level ("info"); |
55 | |
55 | |
56 | The design goal behind this module was to keep it simple (and small), |
56 | 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 |
57 | but make it powerful enough to be potentially useful for any module, and |
58 | extensive enough for the most common tasks, such as logging to multiple |
58 | extensive enough for the most common tasks, such as logging to multiple |
59 | targets, or being able to log into a database. |
59 | targets, or being able to log into a database. |
60 | |
60 | |
|
|
61 | The module is also usable before AnyEvent itself is initialised, in which |
|
|
62 | case some of the functionality might be reduced. |
|
|
63 | |
61 | The amount of documentation might indicate otherwise, but the module is |
64 | The amount of documentation might indicate otherwise, but the runtime part |
62 | still just below 300 lines of code. |
65 | of the module is still just below 300 lines of code. |
63 | |
66 | |
64 | =head1 LOGGING LEVELS |
67 | =head1 LOGGING LEVELS |
65 | |
68 | |
66 | Logging levels in this module range from C<1> (highest priority) to C<9> |
69 | 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 |
70 | (lowest priority). Note that the lowest numerical value is the highest |
… | |
… | |
108 | |
111 | |
109 | use Carp (); |
112 | use Carp (); |
110 | use POSIX (); |
113 | use POSIX (); |
111 | |
114 | |
112 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
115 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
113 | use AnyEvent::Util (); |
116 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
114 | |
117 | |
115 | our $VERSION = $AnyEvent::VERSION; |
118 | our $VERSION = $AnyEvent::VERSION; |
116 | |
119 | |
117 | our ($COLLECT, $FILTER, $LOG); |
120 | our ($COLLECT, $FILTER, $LOG); |
118 | |
121 | |
… | |
… | |
249 | # now get raw message, unless we have it already |
252 | # now get raw message, unless we have it already |
250 | unless ($now) { |
253 | unless ($now) { |
251 | $format = $format->() if ref $format; |
254 | $format = $format->() if ref $format; |
252 | $format = sprintf $format, @args if @args; |
255 | $format = sprintf $format, @args if @args; |
253 | $format =~ s/\n$//; |
256 | $format =~ s/\n$//; |
254 | $now = AE::now; |
257 | $now = now; |
255 | }; |
258 | }; |
256 | |
259 | |
257 | # format msg |
260 | # format msg |
258 | my $str = $ctx->[4] |
261 | my $str = $ctx->[4] |
259 | ? $ctx->[4]($now, $_[0], $level, $format) |
262 | ? $ctx->[4]($now, $_[0], $level, $format) |
… | |
… | |
354 | |
357 | |
355 | $LOGGER{$logger+0} = $logger; |
358 | $LOGGER{$logger+0} = $logger; |
356 | |
359 | |
357 | _reassess $logger+0; |
360 | _reassess $logger+0; |
358 | |
361 | |
|
|
362 | require AnyEvent::Util; |
359 | my $guard = AnyEvent::Util::guard { |
363 | my $guard = AnyEvent::Util::guard (sub { |
360 | # "clean up" |
364 | # "clean up" |
361 | delete $LOGGER{$logger+0}; |
365 | delete $LOGGER{$logger+0}; |
362 | }; |
366 | }); |
363 | |
367 | |
364 | sub { |
368 | sub { |
365 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
369 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
366 | |
370 | |
367 | _log $ctx, $level, @_ |
371 | _log $ctx, $level, @_ |
… | |
… | |
513 | } |
517 | } |
514 | |
518 | |
515 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
519 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
516 | for $LOG, $FILTER, $COLLECT; |
520 | for $LOG, $FILTER, $COLLECT; |
517 | |
521 | |
518 | $LOG->slaves; |
522 | #$LOG->slaves; |
519 | $LOG->title ('$AnyEvent::Log::LOG'); |
523 | $LOG->title ('$AnyEvent::Log::LOG'); |
520 | $LOG->log_to_warn; |
524 | $LOG->log_to_warn; |
521 | |
525 | |
522 | $FILTER->slaves ($LOG); |
526 | $FILTER->slaves ($LOG); |
523 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
527 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
… | |
… | |
1012 | Configures the context to log to a file with the given path. Works like |
1016 | Configures the context to log to a file with the given path. Works like |
1013 | C<log_to_path>. |
1017 | C<log_to_path>. |
1014 | |
1018 | |
1015 | =item C<syslog> or C<syslog=>I<expr> |
1019 | =item C<syslog> or C<syslog=>I<expr> |
1016 | |
1020 | |
1017 | Configured the context to log to syslog. If I<expr> is given, then it is |
1021 | Configures the context to log to syslog. If I<expr> is given, then it is |
1018 | evaluated in the L<Sys::Syslog> package, so you could use: |
1022 | evaluated in the L<Sys::Syslog> package, so you could use: |
1019 | |
1023 | |
1020 | log=syslog=LOG_LOCAL0 |
1024 | log=syslog=LOG_LOCAL0 |
1021 | |
1025 | |
1022 | =item C<nolog> |
1026 | =item C<nolog> |
… | |
… | |
1064 | filter=warn |
1068 | filter=warn |
1065 | |
1069 | |
1066 | # or, more verbose |
1070 | # or, more verbose |
1067 | filter=only,level,warn |
1071 | filter=only,level,warn |
1068 | |
1072 | |
1069 | =item C<1>..C<9>, a logging level name (C<error>, C<debug> etc.) |
1073 | =item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.) |
1070 | |
1074 | |
1071 | A numeric loglevel or the name of a loglevel will be interpreted according |
1075 | A numeric loglevel or the name of a loglevel will be interpreted according |
1072 | to the most recent C<only>, C<except> or C<level> directive. By default, |
1076 | to the most recent C<only>, C<except> or C<level> directive. By default, |
1073 | specifying a logging level enables that and any higher priority messages. |
1077 | specifying a logging level enables that and any higher priority messages. |
1074 | |
1078 | |
1075 | =item C<+>I<context> |
1079 | =item C<+>I<context> |
1076 | |
1080 | |
1077 | Adds/attaches the named context as slave to the context. |
1081 | Attaches the named context as slave to the context. |
1078 | |
1082 | |
1079 | =item C<+> |
1083 | =item C<+> |
1080 | |
1084 | |
1081 | A line C<+> clears the slave list form the context. Anonymous (C<%name>) |
1085 | A line C<+> detaches all contexts, i.e. clears the slave list from the |
1082 | contexts have no slaves by default, but package contexts have the parent |
1086 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1083 | context as slave by default. |
1087 | but package contexts have the parent context as slave by default. |
1084 | |
1088 | |
1085 | Example: log messages from My::Module to a file, do not send them to the |
1089 | Example: log messages from My::Module to a file, do not send them to the |
1086 | default log collector. |
1090 | default log collector. |
1087 | |
1091 | |
1088 | My::Module=+,file=/tmp/mymodulelog |
1092 | My::Module=+,file=/tmp/mymodulelog |
1089 | |
1093 | |
1090 | =back |
1094 | =back |
1091 | |
1095 | |
1092 | Any character can be escaped by prefixing it with a C<\> (backslash), as |
1096 | Any character can be escaped by prefixing it with a C<\> (backslash), as |
1093 | usual, so to log to a file containing a comma, colon, backslash and space in the |
1097 | usual, so to log to a file containing a comma, colon, backslash and some |
1094 | filename, you would do this: |
1098 | spaces in the filename, you would do this: |
1095 | |
1099 | |
1096 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
1100 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
1097 | |
1101 | |
1098 | Since whitespace (which includes newlines) is allowed, it is fine to |
1102 | Since whitespace (which includes newlines) is allowed, it is fine to |
1099 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |
1103 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |