… | |
… | |
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 | "Complex" uses (for speed sensitive code): |
|
|
17 | |
16 | use AnyEvent::Log; |
18 | use AnyEvent::Log; |
17 | |
19 | |
18 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
20 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
19 | |
21 | |
20 | $tracer->("i am here") if $trace; |
22 | $tracer->("i am here") if $trace; |
21 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
23 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
22 | |
24 | |
23 | # configuration |
25 | Configuration (also look at the EXAMPLES section): |
24 | |
26 | |
25 | # set logging for the current package to errors and higher only |
27 | # set logging for the current package to errors and higher only |
26 | AnyEvent::Log::ctx->level ("error"); |
28 | AnyEvent::Log::ctx->level ("error"); |
27 | |
29 | |
28 | # set logging globally to anything below debug |
30 | # set logging level to suppress anything below "notice" |
29 | $AnyEvent::Log::FILTER->level ("notice"); |
31 | $AnyEvent::Log::FILTER->level ("notice"); |
30 | |
32 | |
31 | # see also EXAMPLES, below |
33 | # send all critical and higher priority messages to syslog, |
|
|
34 | # regardless of (most) other settings |
|
|
35 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
|
|
36 | level => "critical", |
|
|
37 | log_to_syslog => 0, |
|
|
38 | ); |
32 | |
39 | |
33 | =head1 DESCRIPTION |
40 | =head1 DESCRIPTION |
34 | |
41 | |
35 | This module implements a relatively simple "logging framework". It doesn't |
42 | This module implements a relatively simple "logging framework". It doesn't |
36 | attempt to be "the" logging solution or even "a" logging solution for |
43 | attempt to be "the" logging solution or even "a" logging solution for |
… | |
… | |
138 | $ctx |
145 | $ctx |
139 | } |
146 | } |
140 | |
147 | |
141 | =item AnyEvent::Log::log $level, $msg[, @args] |
148 | =item AnyEvent::Log::log $level, $msg[, @args] |
142 | |
149 | |
143 | Requests logging of the given C<$msg> with the given log level. |
150 | Requests logging of the given C<$msg> with the given log level, and |
|
|
151 | returns true if the message was logged I<somewhere>. |
144 | |
152 | |
145 | For C<fatal> log levels, the program will abort. |
153 | For C<fatal> log levels, the program will abort. |
146 | |
154 | |
147 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
155 | 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. |
156 | C<$msg> is interpreted as an sprintf format string. |
… | |
… | |
154 | supposed to return the message. It will be called only then the message |
162 | 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 |
163 | actually gets logged, which is useful if it is costly to create the |
156 | message in the first place. |
164 | message in the first place. |
157 | |
165 | |
158 | Whether the given message will be logged depends on the maximum log level |
166 | Whether the given message will be logged depends on the maximum log level |
159 | and the caller's package. |
167 | and the caller's package. The return value can be used to ensure that |
|
|
168 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
|
|
169 | runtime error it tries to log it at C<die> level, but if that message is |
|
|
170 | lost it simply uses warn. |
160 | |
171 | |
161 | Note that you can (and should) call this function as C<AnyEvent::log> or |
172 | 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 |
173 | 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 |
174 | need any additional functionality), as those functions will load the |
164 | logging module on demand only. They are also much shorter to write. |
175 | logging module on demand only. They are also much shorter to write. |
… | |
… | |
224 | ? $level+0 |
235 | ? $level+0 |
225 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
236 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
226 | |
237 | |
227 | my $mask = 1 << $level; |
238 | my $mask = 1 << $level; |
228 | |
239 | |
229 | my (%seen, @ctx, $now, $fmt); |
240 | my ($success, %seen, @ctx, $now, $fmt); |
230 | |
241 | |
231 | do |
242 | do |
232 | { |
243 | { |
233 | # skip if masked |
244 | # skip if masked |
234 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
245 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
… | |
… | |
238 | # now get raw message, unless we have it already |
249 | # now get raw message, unless we have it already |
239 | unless ($now) { |
250 | unless ($now) { |
240 | $format = $format->() if ref $format; |
251 | $format = $format->() if ref $format; |
241 | $format = sprintf $format, @args if @args; |
252 | $format = sprintf $format, @args if @args; |
242 | $format =~ s/\n$//; |
253 | $format =~ s/\n$//; |
243 | $now = AE::now; |
254 | $now = now; |
244 | }; |
255 | }; |
245 | |
256 | |
246 | # format msg |
257 | # format msg |
247 | my $str = $ctx->[4] |
258 | my $str = $ctx->[4] |
248 | ? $ctx->[4]($now, $_[0], $level, $format) |
259 | ? $ctx->[4]($now, $_[0], $level, $format) |
249 | : ($fmt ||= _format $now, $_[0], $level, $format); |
260 | : ($fmt ||= _format $now, $_[0], $level, $format); |
|
|
261 | |
|
|
262 | $success = 1; |
250 | |
263 | |
251 | $ctx->[3]($str) |
264 | $ctx->[3]($str) |
252 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
265 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
253 | } else { |
266 | } else { |
254 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
267 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
… | |
… | |
256 | } |
269 | } |
257 | } |
270 | } |
258 | while $ctx = pop @ctx; |
271 | while $ctx = pop @ctx; |
259 | |
272 | |
260 | exit 1 if $level <= 1; |
273 | exit 1 if $level <= 1; |
|
|
274 | |
|
|
275 | $success |
261 | } |
276 | } |
262 | |
277 | |
263 | sub log($$;@) { |
278 | sub log($$;@) { |
264 | _log |
279 | _log |
265 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
280 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
… | |
… | |
269 | *AnyEvent::log = *AE::log = \&log; |
284 | *AnyEvent::log = *AE::log = \&log; |
270 | |
285 | |
271 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
286 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
272 | |
287 | |
273 | Creates a code reference that, when called, acts as if the |
288 | 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 |
289 | 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 |
290 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
276 | the C<AnyEvent::Log::log> function: |
291 | the C<AnyEvent::Log::log> function: |
277 | |
292 | |
278 | my $debug_log = AnyEvent::Log::logger "debug"; |
293 | my $debug_log = AnyEvent::Log::logger "debug"; |
279 | |
294 | |
… | |
… | |
500 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
515 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
501 | for $LOG, $FILTER, $COLLECT; |
516 | for $LOG, $FILTER, $COLLECT; |
502 | |
517 | |
503 | $LOG->slaves; |
518 | $LOG->slaves; |
504 | $LOG->title ('$AnyEvent::Log::LOG'); |
519 | $LOG->title ('$AnyEvent::Log::LOG'); |
505 | $LOG->log_cb (sub { |
520 | $LOG->log_to_warn; |
506 | warn shift; |
|
|
507 | 0 |
|
|
508 | }); |
|
|
509 | |
521 | |
510 | $FILTER->slaves ($LOG); |
522 | $FILTER->slaves ($LOG); |
511 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
523 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
512 | $FILTER->level ($AnyEvent::VERBOSE); |
524 | $FILTER->level ($AnyEvent::VERBOSE); |
513 | |
525 | |
… | |
… | |
774 | logging context, the (numeric) logging level and the raw message string |
786 | logging context, the (numeric) logging level and the raw message string |
775 | and needs to return a formatted log message. In most cases this will be a |
787 | and needs to return a formatted log message. In most cases this will be a |
776 | string, but it could just as well be an array reference that just stores |
788 | string, but it could just as well be an array reference that just stores |
777 | the values. |
789 | the values. |
778 | |
790 | |
779 | If, for some reaosn, you want to use C<caller> to find out more baout the |
791 | If, for some reason, you want to use C<caller> to find out more baout the |
780 | logger then you should walk up the call stack until you are no longer |
792 | logger then you should walk up the call stack until you are no longer |
781 | inside the C<AnyEvent::Log> package. |
793 | inside the C<AnyEvent::Log> package. |
782 | |
794 | |
783 | Example: format just the raw message, with numeric log level in angle |
795 | Example: format just the raw message, with numeric log level in angle |
784 | brackets. |
796 | brackets. |
… | |
… | |
803 | "$msg->[3]"; |
815 | "$msg->[3]"; |
804 | |
816 | |
805 | 0 |
817 | 0 |
806 | }); |
818 | }); |
807 | |
819 | |
|
|
820 | =item $ctx->log_to_warn |
|
|
821 | |
|
|
822 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
|
|
823 | (usually this logs to STDERR). |
|
|
824 | |
808 | =item $ctx->log_to_file ($path) |
825 | =item $ctx->log_to_file ($path) |
809 | |
826 | |
810 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
827 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
811 | |
828 | |
812 | =item $ctx->log_to_path ($path) |
829 | =item $ctx->log_to_path ($path) |
813 | |
830 | |
814 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
831 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
815 | is much slower, but allows you to change/move/rename/delete the file at |
832 | is much slower, but allows you to change/move/rename/delete the file at |
816 | basically any time. |
833 | basically any time. |
|
|
834 | |
|
|
835 | Needless(?) to say, if you do not want to be bitten by some evil person |
|
|
836 | calling C<chdir>, the path should be absolute. Doesn't help with |
|
|
837 | C<chroot>, but hey... |
817 | |
838 | |
818 | =item $ctx->log_to_syslog ([$log_flags]) |
839 | =item $ctx->log_to_syslog ([$log_flags]) |
819 | |
840 | |
820 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
841 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
821 | the others in the obvious way. If specified, then the C<$log_flags> are |
842 | the others in the obvious way. If specified, then the C<$log_flags> are |
… | |
… | |
837 | my ($ctx, $cb) = @_; |
858 | my ($ctx, $cb) = @_; |
838 | |
859 | |
839 | $ctx->[4] = $cb; |
860 | $ctx->[4] = $cb; |
840 | } |
861 | } |
841 | |
862 | |
|
|
863 | sub log_to_warn { |
|
|
864 | my ($ctx, $path) = @_; |
|
|
865 | |
|
|
866 | $ctx->log_cb (sub { |
|
|
867 | warn shift; |
|
|
868 | 0 |
|
|
869 | }); |
|
|
870 | } |
|
|
871 | |
842 | sub log_to_file { |
872 | sub log_to_file { |
843 | my ($ctx, $path) = @_; |
873 | my ($ctx, $path) = @_; |
844 | |
874 | |
845 | open my $fh, ">>", $path |
875 | open my $fh, ">>", $path |
846 | or die "$path: $!"; |
876 | or die "$path: $!"; |
… | |
… | |
849 | syswrite $fh, shift; |
879 | syswrite $fh, shift; |
850 | 0 |
880 | 0 |
851 | }); |
881 | }); |
852 | } |
882 | } |
853 | |
883 | |
854 | sub log_to_file { |
884 | sub log_to_path { |
855 | my ($ctx, $path) = @_; |
885 | my ($ctx, $path) = @_; |
856 | |
886 | |
857 | $ctx->log_cb (sub { |
887 | $ctx->log_cb (sub { |
858 | open my $fh, ">>", $path |
888 | open my $fh, ">>", $path |
859 | or die "$path: $!"; |
889 | or die "$path: $!"; |
… | |
… | |
906 | =cut |
936 | =cut |
907 | |
937 | |
908 | *log = \&AnyEvent::Log::_log; |
938 | *log = \&AnyEvent::Log::_log; |
909 | *logger = \&AnyEvent::Log::_logger; |
939 | *logger = \&AnyEvent::Log::_logger; |
910 | |
940 | |
|
|
941 | =back |
|
|
942 | |
|
|
943 | =cut |
|
|
944 | |
|
|
945 | package AnyEvent::Log; |
|
|
946 | |
|
|
947 | =head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG} |
|
|
948 | |
|
|
949 | Logging can also be configured by setting the environment variable |
|
|
950 | C<PERL_ANYEVENT_LOG> (or C<AE_LOG>). |
|
|
951 | |
|
|
952 | The value consists of one or more logging context specifications separated |
|
|
953 | by C<:> or whitespace. Each logging specification in turn starts with a |
|
|
954 | context name, followed by C<=>, followed by zero or more comma-separated |
|
|
955 | configuration directives, here are some examples: |
|
|
956 | |
|
|
957 | # set default logging level |
|
|
958 | filter=warn |
|
|
959 | |
|
|
960 | # log to file instead of to stderr |
|
|
961 | log=file=/tmp/mylog |
|
|
962 | |
|
|
963 | # log to file in addition to stderr |
|
|
964 | log=+%file:%file=file=/tmp/mylog |
|
|
965 | |
|
|
966 | # enable debug log messages, log warnings and above to syslog |
|
|
967 | filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0 |
|
|
968 | |
|
|
969 | # log trace messages (only) from AnyEvent::Debug to file |
|
|
970 | AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog |
|
|
971 | |
|
|
972 | A context name in the log specification can be any of the following: |
|
|
973 | |
|
|
974 | =over 4 |
|
|
975 | |
|
|
976 | =item C<collect>, C<filter>, C<log> |
|
|
977 | |
|
|
978 | Correspond to the three predefined C<$AnyEvent::Log::COLLECT>, |
|
|
979 | C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts. |
|
|
980 | |
|
|
981 | =item C<%name> |
|
|
982 | |
|
|
983 | Context names starting with a C<%> are anonymous contexts created when the |
|
|
984 | name is first mentioned. The difference to package contexts is that by |
|
|
985 | default they have no attached slaves. |
|
|
986 | |
|
|
987 | =item a perl package name |
|
|
988 | |
|
|
989 | Any other string references the logging context associated with the given |
|
|
990 | Perl C<package>. In the unlikely case where you want to specify a package |
|
|
991 | context that matches on of the other context name forms, you can add a |
|
|
992 | C<::> to the package name to force interpretation as a package. |
|
|
993 | |
|
|
994 | =back |
|
|
995 | |
|
|
996 | The configuration specifications can be any number of the following: |
|
|
997 | |
|
|
998 | =over 4 |
|
|
999 | |
|
|
1000 | =item C<stderr> |
|
|
1001 | |
|
|
1002 | Configures the context to use Perl's C<warn> function (which typically |
|
|
1003 | logs to C<STDERR>). Works like C<log_to_warn>. |
|
|
1004 | |
|
|
1005 | =item C<file=>I<path> |
|
|
1006 | |
|
|
1007 | Configures the context to log to a file with the given path. Works like |
|
|
1008 | C<log_to_file>. |
|
|
1009 | |
|
|
1010 | =item C<path=>I<path> |
|
|
1011 | |
|
|
1012 | Configures the context to log to a file with the given path. Works like |
|
|
1013 | C<log_to_path>. |
|
|
1014 | |
|
|
1015 | =item C<syslog> or C<syslog=>I<expr> |
|
|
1016 | |
|
|
1017 | 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: |
|
|
1019 | |
|
|
1020 | log=syslog=LOG_LOCAL0 |
|
|
1021 | |
|
|
1022 | =item C<nolog> |
|
|
1023 | |
|
|
1024 | Configures the context to not log anything by itself, which is the |
|
|
1025 | default. Same as C<< $ctx->log_cb (undef) >>. |
|
|
1026 | |
|
|
1027 | =item C<0> or C<off> |
|
|
1028 | |
|
|
1029 | Sets the logging level of the context ot C<0>, i.e. all messages will be |
|
|
1030 | filtered out. |
|
|
1031 | |
|
|
1032 | =item C<all> |
|
|
1033 | |
|
|
1034 | Enables all logging levels, i.e. filtering will effectively be switched |
|
|
1035 | off (the default). |
|
|
1036 | |
|
|
1037 | =item C<only> |
|
|
1038 | |
|
|
1039 | Disables all logging levels, and changes the interpretation of following |
|
|
1040 | level specifications to enable the specified level only. |
|
|
1041 | |
|
|
1042 | Example: only enable debug messages for a context. |
|
|
1043 | |
|
|
1044 | context=only,debug |
|
|
1045 | |
|
|
1046 | =item C<except> |
|
|
1047 | |
|
|
1048 | Enables all logging levels, and changes the interpretation of following |
|
|
1049 | level specifications to disable that level. Rarely used. |
|
|
1050 | |
|
|
1051 | Example: enable all logging levels except fatal and trace (this is rather |
|
|
1052 | nonsensical). |
|
|
1053 | |
|
|
1054 | filter=exept,fatal,trace |
|
|
1055 | |
|
|
1056 | =item C<level> |
|
|
1057 | |
|
|
1058 | Enables all logging levels, and changes the interpretation of following |
|
|
1059 | level specifications to be "that level or any higher priority |
|
|
1060 | message". This is the default. |
|
|
1061 | |
|
|
1062 | Example: log anything at or above warn level. |
|
|
1063 | |
|
|
1064 | filter=warn |
|
|
1065 | |
|
|
1066 | # or, more verbose |
|
|
1067 | filter=only,level,warn |
|
|
1068 | |
|
|
1069 | =item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.) |
|
|
1070 | |
|
|
1071 | 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, |
|
|
1073 | specifying a logging level enables that and any higher priority messages. |
|
|
1074 | |
|
|
1075 | =item C<+>I<context> |
|
|
1076 | |
|
|
1077 | Attaches the named context as slave to the context. |
|
|
1078 | |
|
|
1079 | =item C<+> |
|
|
1080 | |
|
|
1081 | A line C<+> detaches all contexts, i.e. clears the slave list from the |
|
|
1082 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
|
|
1083 | but package contexts have the parent context as slave by default. |
|
|
1084 | |
|
|
1085 | Example: log messages from My::Module to a file, do not send them to the |
|
|
1086 | default log collector. |
|
|
1087 | |
|
|
1088 | My::Module=+,file=/tmp/mymodulelog |
|
|
1089 | |
|
|
1090 | =back |
|
|
1091 | |
|
|
1092 | 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 |
|
|
1094 | filename, you would do this: |
|
|
1095 | |
|
|
1096 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
|
|
1097 | |
|
|
1098 | Since whitespace (which includes newlines) is allowed, it is fine to |
|
|
1099 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |
|
|
1100 | |
|
|
1101 | PERL_ANYEVENT_LOG=" |
|
|
1102 | filter=warn |
|
|
1103 | AnyEvent::Debug=+%trace |
|
|
1104 | %trace=only,trace,+log |
|
|
1105 | " myprog |
|
|
1106 | |
|
|
1107 | Also, in the unlikely case when you want to concatenate specifications, |
|
|
1108 | use whitespace as separator, as C<::> will be interpreted as part of a |
|
|
1109 | module name, an empty spec with two separators: |
|
|
1110 | |
|
|
1111 | PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug" |
|
|
1112 | |
|
|
1113 | =cut |
|
|
1114 | |
|
|
1115 | for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1116 | my %anon; |
|
|
1117 | |
|
|
1118 | my $pkg = sub { |
|
|
1119 | $_[0] eq "log" ? $LOG |
|
|
1120 | : $_[0] eq "filter" ? $FILTER |
|
|
1121 | : $_[0] eq "collect" ? $COLLECT |
|
|
1122 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= ctx undef) |
|
|
1123 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
|
|
1124 | : die # never reached? |
|
|
1125 | }; |
|
|
1126 | |
|
|
1127 | /\G[[:space:]]+/gc; # skip initial whitespace |
|
|
1128 | |
|
|
1129 | while (/\G((?:[^:=[:space:]]+|::|\\.)+)=/gc) { |
|
|
1130 | my $ctx = $pkg->($1); |
|
|
1131 | my $level = "level"; |
|
|
1132 | |
|
|
1133 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
|
|
1134 | for ("$1") { |
|
|
1135 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
|
|
1136 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
|
|
1137 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
|
|
1138 | } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog (eval "package Sys::Syslog; $1"); |
|
|
1139 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
|
|
1140 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
|
|
1141 | } elsif ($_ eq "+" ) { $ctx->slaves; |
|
|
1142 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
|
|
1143 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
|
|
1144 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
|
|
1145 | } elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable"; |
|
|
1146 | } elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable"; |
|
|
1147 | } elsif (/^\d$/ ) { $ctx->$level ($_); |
|
|
1148 | } elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_); |
|
|
1149 | } else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n"; |
|
|
1150 | } |
|
|
1151 | } |
|
|
1152 | |
|
|
1153 | /\G,/gc or last; |
|
|
1154 | } |
|
|
1155 | |
|
|
1156 | /\G[:[:space:]]+/gc or last; |
|
|
1157 | } |
|
|
1158 | |
|
|
1159 | /\G[[:space:]]+/gc; # skip trailing whitespace |
|
|
1160 | |
|
|
1161 | if (/\G(.+)/g) { |
|
|
1162 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
|
|
1163 | } |
|
|
1164 | } |
|
|
1165 | |
911 | 1; |
1166 | 1; |
912 | |
1167 | |
913 | =back |
|
|
914 | |
|
|
915 | =head1 EXAMPLES |
1168 | =head1 EXAMPLES |
916 | |
1169 | |
917 | This section shows some common configurations. |
1170 | This section shows some common configurations, both as code, and as |
|
|
1171 | C<PERL_ANYEVENT_LOG> string. |
918 | |
1172 | |
919 | =over 4 |
1173 | =over 4 |
920 | |
1174 | |
921 | =item Setting the global logging level. |
1175 | =item Setting the global logging level. |
922 | |
1176 | |
923 | Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
1177 | Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before |
924 | running your program, or modify the log level of the root context: |
1178 | running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of |
|
|
1179 | the root context at runtime: |
925 | |
1180 | |
926 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1181 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
927 | |
1182 | |
|
|
1183 | PERL_ANYEVENT_LOG=log=warn |
|
|
1184 | |
928 | $AnyEvent::Log::FILTER->level ("warn"); |
1185 | $AnyEvent::Log::FILTER->level ("warn"); |
929 | |
1186 | |
930 | =item Append all messages to a file instead of sending them to STDERR. |
1187 | =item Append all messages to a file instead of sending them to STDERR. |
931 | |
1188 | |
932 | This is affected by the global logging level. |
1189 | This is affected by the global logging level. |
933 | |
1190 | |
934 | $AnyEvent::Log::LOG->log_to_file ($path); (sub { |
1191 | $AnyEvent::Log::LOG->log_to_file ($path); |
|
|
1192 | |
|
|
1193 | PERL_ANYEVENT_LOG=log=file=/some/path |
935 | |
1194 | |
936 | =item Write all messages with priority C<error> and higher to a file. |
1195 | =item Write all messages with priority C<error> and higher to a file. |
937 | |
1196 | |
938 | This writes them only when the global logging level allows it, because |
1197 | This writes them only when the global logging level allows it, because |
939 | it is attached to the default context which is invoked I<after> global |
1198 | it is attached to the default context which is invoked I<after> global |
940 | filtering. |
1199 | filtering. |
941 | |
1200 | |
942 | $AnyEvent::Log::FILTER->attach |
1201 | $AnyEvent::Log::FILTER->attach |
943 | new AnyEvent::Log::Ctx log_to_file => $path); |
1202 | new AnyEvent::Log::Ctx log_to_file => $path); |
944 | |
1203 | |
|
|
1204 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
|
|
1205 | |
945 | This writes them regardless of the global logging level, because it is |
1206 | This writes them regardless of the global logging level, because it is |
946 | attached to the toplevel context, which receives all messages I<before> |
1207 | attached to the toplevel context, which receives all messages I<before> |
947 | the global filtering. |
1208 | the global filtering. |
948 | |
1209 | |
949 | $AnyEvent::Log::COLLECT->attach ( |
1210 | $AnyEvent::Log::COLLECT->attach ( |
950 | new AnyEvent::Log::Ctx log_to_file => $path); |
1211 | new AnyEvent::Log::Ctx log_to_file => $path); |
951 | |
1212 | |
|
|
1213 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
|
|
1214 | |
952 | In both cases, messages are still written to STDERR. |
1215 | In both cases, messages are still written to STDERR. |
953 | |
1216 | |
954 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1217 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
955 | |
1218 | |
956 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1219 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
957 | context - this simply circumvents the global filtering for trace messages. |
1220 | context - this simply circumvents the global filtering for trace messages. |
958 | |
1221 | |
959 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1222 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
960 | $debug->attach ($AnyEvent::Log::LOG); |
1223 | $debug->attach ($AnyEvent::Log::LOG); |
|
|
1224 | |
|
|
1225 | PERL_ANYEVENT_LOG=AnyEvent::Debug=+log |
961 | |
1226 | |
962 | This of course works for any package, not just L<AnyEvent::Debug>, but |
1227 | This of course works for any package, not just L<AnyEvent::Debug>, but |
963 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
1228 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
964 | default. |
1229 | default. |
965 | |
1230 | |
… | |
… | |
969 | |
1234 | |
970 | Marc Lehmann <schmorp@schmorp.de> |
1235 | Marc Lehmann <schmorp@schmorp.de> |
971 | http://home.schmorp.de/ |
1236 | http://home.schmorp.de/ |
972 | |
1237 | |
973 | =cut |
1238 | =cut |
|
|
1239 | |