… | |
… | |
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 fatal => "No config found, cannot continue!"; # never returns |
11 | AE::log warn => "it's a bit too hot"; |
12 | AE::log alert => "The battery died!"; |
12 | AE::log error => "the flag was false!"; |
13 | AE::log crit => "The battery temperature is too hot!"; |
13 | AE::log fatal => "the bit toggled! run!"; |
14 | AE::log error => "Division by zero attempted."; |
|
|
15 | AE::log warn => "Couldn't delete the file."; |
|
|
16 | AE::log note => "Wanted to create config, but config already exists."; |
|
|
17 | AE::log info => "File soandso successfully deleted."; |
|
|
18 | AE::log debug => "the function returned 3"; |
|
|
19 | AE::log trace => "going to call function abc"; |
14 | |
20 | |
15 | # "complex" use |
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 | |
|
|
34 | "Complex" uses (for speed sensitive code, e.g. trace/debug messages): |
|
|
35 | |
16 | use AnyEvent::Log; |
36 | use AnyEvent::Log; |
17 | |
37 | |
18 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
38 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
19 | |
39 | |
20 | $tracer->("i am here") if $trace; |
40 | $tracer->("i am here") if $trace; |
21 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
41 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
22 | |
42 | |
23 | # configuration |
43 | Configuration (also look at the EXAMPLES section): |
24 | |
44 | |
25 | # set logging for the current package to errors and higher only |
45 | # set logging for the current package to errors and higher only |
26 | AnyEvent::Log::ctx->level ("error"); |
46 | AnyEvent::Log::ctx->level ("error"); |
27 | |
47 | |
28 | # set logging globally to anything below debug |
48 | # set logging level to suppress anything below "notice" |
29 | $AnyEvent::Log::FILTER->level ("notice"); |
49 | $AnyEvent::Log::FILTER->level ("notice"); |
30 | |
50 | |
31 | # see also EXAMPLES, below |
51 | # send all critical and higher priority messages to syslog, |
|
|
52 | # regardless of (most) other settings |
|
|
53 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
|
|
54 | level => "critical", |
|
|
55 | log_to_syslog => "user", |
|
|
56 | ); |
32 | |
57 | |
33 | =head1 DESCRIPTION |
58 | =head1 DESCRIPTION |
34 | |
59 | |
35 | This module implements a relatively simple "logging framework". It doesn't |
60 | This module implements a relatively simple "logging framework". It doesn't |
36 | 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 |
37 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
62 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
38 | 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 |
39 | using it from other modules as well. |
64 | using it from other modules as well. |
40 | |
65 | |
41 | Remember that the default verbosity level is C<0> (C<off>), so nothing |
66 | Remember that the default verbosity level is C<4> (C<error>), so only |
42 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
67 | errors and more important messages will be logged, unless you set |
43 | before starting your program, or change the logging level at runtime with |
68 | C<PERL_ANYEVENT_VERBOSE> to a higher number before starting your program |
44 | something like: |
69 | (C<AE_VERBOSE=5> is recommended during development), or change the logging |
|
|
70 | level at runtime with something like: |
45 | |
71 | |
46 | use AnyEvent::Log; |
72 | use AnyEvent::Log; |
47 | AnyEvent::Log::FILTER->level ("info"); |
73 | $AnyEvent::Log::FILTER->level ("info"); |
48 | |
74 | |
49 | The design goal behind this module was to keep it simple (and small), |
75 | The design goal behind this module was to keep it simple (and small), |
50 | but make it powerful enough to be potentially useful for any module, and |
76 | but make it powerful enough to be potentially useful for any module, and |
51 | extensive enough for the most common tasks, such as logging to multiple |
77 | extensive enough for the most common tasks, such as logging to multiple |
52 | targets, or being able to log into a database. |
78 | targets, or being able to log into a database. |
53 | |
79 | |
|
|
80 | The module is also usable before AnyEvent itself is initialised, in which |
|
|
81 | case some of the functionality might be reduced. |
|
|
82 | |
54 | The amount of documentation might indicate otherwise, but the module is |
83 | The amount of documentation might indicate otherwise, but the runtime part |
55 | still just below 300 lines of code. |
84 | of the module is still just below 300 lines of code. |
56 | |
85 | |
57 | =head1 LOGGING LEVELS |
86 | =head1 LOGGING LEVELS |
58 | |
87 | |
59 | Logging levels in this module range from C<1> (highest priority) to C<9> |
88 | Logging levels in this module range from C<1> (highest priority) to C<9> |
60 | (lowest priority). Note that the lowest numerical value is the highest |
89 | (lowest priority). Note that the lowest numerical value is the highest |
… | |
… | |
62 | numerical value". |
91 | numerical value". |
63 | |
92 | |
64 | Instead of specifying levels by name you can also specify them by aliases: |
93 | Instead of specifying levels by name you can also specify them by aliases: |
65 | |
94 | |
66 | LVL NAME SYSLOG PERL NOTE |
95 | LVL NAME SYSLOG PERL NOTE |
67 | 1 fatal emerg exit aborts program! |
96 | 1 fatal emerg exit system unusable, aborts program! |
68 | 2 alert |
97 | 2 alert failure in primary system |
69 | 3 critical crit |
98 | 3 critical crit failure in backup system |
70 | 4 error err die |
99 | 4 error err die non-urgent program errors, a bug |
71 | 5 warn warning |
100 | 5 warn warning possible problem, not necessarily error |
72 | 6 note notice |
101 | 6 note notice unusual conditions |
73 | 7 info |
102 | 7 info normal messages, no action required |
74 | 8 debug |
103 | 8 debug debugging messages for development |
75 | 9 trace |
104 | 9 trace copious tracing output |
76 | |
105 | |
77 | As you can see, some logging levels have multiple aliases - the first one |
106 | As you can see, some logging levels have multiple aliases - the first one |
78 | is the "official" name, the second one the "syslog" name (if it differs) |
107 | is the "official" name, the second one the "syslog" name (if it differs) |
79 | and the third one the "perl" name, suggesting that you log C<die> messages |
108 | and the third one the "perl" name, suggesting (only!) that you log C<die> |
80 | at C<error> priority. |
109 | messages at C<error> priority. The NOTE column tries to provide some |
|
|
110 | rationale on how to chose a logging level. |
81 | |
111 | |
|
|
112 | As a rough guideline, levels 1..3 are primarily meant for users of the |
|
|
113 | program (admins, staff), and are the only ones logged to STDERR by |
|
|
114 | default. Levels 4..6 are meant for users and developers alike, while |
|
|
115 | levels 7..9 are usually meant for developers. |
|
|
116 | |
82 | You can normally only log a single message at highest priority level |
117 | You can normally only log a message once at highest priority level (C<1>, |
83 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
118 | C<fatal>), because logging a fatal message will also quit the program - so |
84 | program - so use it sparingly :) |
119 | use it sparingly :) |
|
|
120 | |
|
|
121 | For example, a program that finds an unknown switch on the commandline |
|
|
122 | might well use a fatal logging level to tell users about it - the "system" |
|
|
123 | in this case would be the program, or module. |
85 | |
124 | |
86 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
125 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
87 | or C<all> - these are only valid in the methods they are documented for. |
126 | or C<all> - these are only valid for the methods that documented them. |
88 | |
127 | |
89 | =head1 LOGGING FUNCTIONS |
128 | =head1 LOGGING FUNCTIONS |
90 | |
129 | |
91 | These functions allow you to log messages. They always use the caller's |
130 | The following functions allow you to log messages. They always use the |
92 | package as a "logging context". Also, the main logging function C<log> is |
131 | caller's package as a "logging context". Also, the main logging function, |
93 | callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is |
132 | C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent> |
94 | loaded. |
133 | module is loaded. |
95 | |
134 | |
96 | =over 4 |
135 | =over 4 |
97 | |
136 | |
98 | =cut |
137 | =cut |
99 | |
138 | |
100 | package AnyEvent::Log; |
139 | package AnyEvent::Log; |
101 | |
140 | |
102 | use Carp (); |
141 | use Carp (); |
103 | use POSIX (); |
142 | use POSIX (); |
104 | |
143 | |
|
|
144 | # layout of a context |
|
|
145 | # 0 1 2 3 4, 5 |
|
|
146 | # [$title, $level, %$slaves, &$logcb, &$fmtcb, $cap] |
|
|
147 | |
105 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
148 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
106 | use AnyEvent::Util (); |
149 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
107 | |
150 | |
108 | our $VERSION = $AnyEvent::VERSION; |
151 | our $VERSION = $AnyEvent::VERSION; |
109 | |
152 | |
110 | our ($COLLECT, $FILTER, $LOG); |
153 | our ($COLLECT, $FILTER, $LOG); |
111 | |
154 | |
… | |
… | |
138 | $ctx |
181 | $ctx |
139 | } |
182 | } |
140 | |
183 | |
141 | =item AnyEvent::Log::log $level, $msg[, @args] |
184 | =item AnyEvent::Log::log $level, $msg[, @args] |
142 | |
185 | |
143 | Requests logging of the given C<$msg> with the given log level. |
186 | Requests logging of the given C<$msg> with the given log level, and |
|
|
187 | returns true if the message was logged I<somewhere>. |
144 | |
188 | |
145 | For C<fatal> log levels, the program will abort. |
189 | For loglevel C<fatal>, the program will abort. |
146 | |
190 | |
147 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
191 | 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. |
192 | C<$msg> is interpreted as an sprintf format string. |
149 | |
193 | |
150 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
194 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
… | |
… | |
153 | Last not least, C<$msg> might be a code reference, in which case it is |
197 | Last not least, C<$msg> might be a code reference, in which case it is |
154 | supposed to return the message. It will be called only then the message |
198 | 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 |
199 | actually gets logged, which is useful if it is costly to create the |
156 | message in the first place. |
200 | message in the first place. |
157 | |
201 | |
|
|
202 | This function takes care of saving and restoring C<$!> and C<$@>, so you |
|
|
203 | don't have to. |
|
|
204 | |
158 | Whether the given message will be logged depends on the maximum log level |
205 | Whether the given message will be logged depends on the maximum log level |
159 | and the caller's package. |
206 | and the caller's package. The return value can be used to ensure that |
|
|
207 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
|
|
208 | runtime error it tries to log it at C<die> level, but if that message is |
|
|
209 | lost it simply uses warn. |
160 | |
210 | |
161 | Note that you can (and should) call this function as C<AnyEvent::log> or |
211 | 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 |
212 | 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 |
213 | need any additional functionality), as those functions will load the |
164 | logging module on demand only. They are also much shorter to write. |
214 | logging module on demand only. They are also much shorter to write. |
… | |
… | |
192 | info => 7, |
242 | info => 7, |
193 | debug => 8, |
243 | debug => 8, |
194 | trace => 9, |
244 | trace => 9, |
195 | ); |
245 | ); |
196 | |
246 | |
197 | sub now () { time } |
247 | our $TIME_EXACT; |
|
|
248 | |
|
|
249 | sub exact_time($) { |
|
|
250 | $TIME_EXACT = shift; |
|
|
251 | *_ts = $AnyEvent::MODEL |
|
|
252 | ? $TIME_EXACT ? \&AE::now : \&AE::time |
|
|
253 | : sub () { $TIME_EXACT ? do { require Time::HiRes; Time::HiRes::time () } : time }; |
|
|
254 | } |
|
|
255 | |
|
|
256 | BEGIN { |
|
|
257 | exact_time 0; |
|
|
258 | } |
198 | |
259 | |
199 | AnyEvent::post_detect { |
260 | AnyEvent::post_detect { |
200 | *now = \&AE::now; |
261 | exact_time $TIME_EXACT; |
201 | }; |
262 | }; |
202 | |
263 | |
203 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
264 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
204 | |
265 | |
205 | # time, ctx, level, msg |
266 | # time, ctx, level, msg |
… | |
… | |
215 | } |
276 | } |
216 | |
277 | |
217 | join "", @res |
278 | join "", @res |
218 | } |
279 | } |
219 | |
280 | |
|
|
281 | sub fatal_exit() { |
|
|
282 | exit 1; |
|
|
283 | } |
|
|
284 | |
220 | sub _log { |
285 | sub _log { |
221 | my ($ctx, $level, $format, @args) = @_; |
286 | my ($ctx, $level, $format, @args) = @_; |
222 | |
287 | |
223 | $level = $level > 0 && $level <= 9 |
288 | $level = $level > 0 && $level <= 9 |
224 | ? $level+0 |
289 | ? $level+0 |
225 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
290 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
226 | |
291 | |
227 | my $mask = 1 << $level; |
292 | my $mask = 1 << $level; |
228 | |
293 | |
229 | my (%seen, @ctx, $now, $fmt); |
294 | my ($success, %seen, @ctx, $now, @fmt); |
230 | |
295 | |
231 | do |
296 | do |
232 | { |
297 | { |
233 | # skip if masked |
298 | # if !ref, then it's a level number |
|
|
299 | if (!ref $ctx) { |
|
|
300 | $level = $ctx; |
234 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
301 | } elsif ($ctx->[1] & $mask and !$seen{$ctx+0}++) { |
|
|
302 | # logging/recursing into this context |
|
|
303 | |
|
|
304 | # level cap |
|
|
305 | if ($ctx->[5] > $level) { |
|
|
306 | push @ctx, $level; # restore level when going up in tree |
|
|
307 | $level = $ctx->[5]; |
|
|
308 | } |
|
|
309 | |
|
|
310 | # log if log cb |
235 | if ($ctx->[3]) { |
311 | if ($ctx->[3]) { |
236 | # logging target found |
312 | # logging target found |
|
|
313 | |
|
|
314 | local ($!, $@); |
237 | |
315 | |
238 | # now get raw message, unless we have it already |
316 | # now get raw message, unless we have it already |
239 | unless ($now) { |
317 | unless ($now) { |
240 | $format = $format->() if ref $format; |
318 | $format = $format->() if ref $format; |
241 | $format = sprintf $format, @args if @args; |
319 | $format = sprintf $format, @args if @args; |
242 | $format =~ s/\n$//; |
320 | $format =~ s/\n$//; |
243 | $now = AE::now; |
321 | $now = _ts; |
244 | }; |
322 | }; |
245 | |
323 | |
246 | # format msg |
324 | # format msg |
247 | my $str = $ctx->[4] |
325 | my $str = $ctx->[4] |
248 | ? $ctx->[4]($now, $_[0], $level, $format) |
326 | ? $ctx->[4]($now, $_[0], $level, $format) |
249 | : ($fmt ||= _format $now, $_[0], $level, $format); |
327 | : ($fmt[$level] ||= _format $now, $_[0], $level, $format); |
250 | |
328 | |
|
|
329 | $success = 1; |
|
|
330 | |
251 | $ctx->[3]($str, $_[0], $level) |
331 | $ctx->[3]($str) |
252 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
332 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
253 | } else { |
333 | } else { |
254 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
334 | push @ctx, values %{ $ctx->[2] }; # not masked - propagate |
255 | } |
335 | } |
256 | } |
336 | } |
257 | } |
337 | } |
258 | while $ctx = pop @ctx; |
338 | while $ctx = pop @ctx; |
259 | |
339 | |
260 | exit 1 if $level <= 1; |
340 | fatal_exit if $level <= 1; |
|
|
341 | |
|
|
342 | $success |
261 | } |
343 | } |
262 | |
344 | |
263 | sub log($$;@) { |
345 | sub log($$;@) { |
264 | _log |
346 | _log |
265 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
347 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
266 | @_; |
348 | @_; |
267 | } |
349 | } |
268 | |
350 | |
269 | *AnyEvent::log = *AE::log = \&log; |
|
|
270 | |
|
|
271 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
351 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
272 | |
352 | |
273 | Creates a code reference that, when called, acts as if the |
353 | 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 |
354 | 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 |
355 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
276 | the C<AnyEvent::Log::log> function: |
356 | the C<AnyEvent::Log::log> function: |
277 | |
357 | |
278 | my $debug_log = AnyEvent::Log::logger "debug"; |
358 | my $debug_log = AnyEvent::Log::logger "debug"; |
279 | |
359 | |
… | |
… | |
339 | |
419 | |
340 | $LOGGER{$logger+0} = $logger; |
420 | $LOGGER{$logger+0} = $logger; |
341 | |
421 | |
342 | _reassess $logger+0; |
422 | _reassess $logger+0; |
343 | |
423 | |
|
|
424 | require AnyEvent::Util unless $AnyEvent::Util::VERSION; |
344 | my $guard = AnyEvent::Util::guard { |
425 | my $guard = AnyEvent::Util::guard (sub { |
345 | # "clean up" |
426 | # "clean up" |
346 | delete $LOGGER{$logger+0}; |
427 | delete $LOGGER{$logger+0}; |
347 | }; |
428 | }); |
348 | |
429 | |
349 | sub { |
430 | sub { |
350 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
431 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
351 | |
432 | |
352 | _log $ctx, $level, @_ |
433 | _log $ctx, $level, @_ |
… | |
… | |
357 | sub logger($;$) { |
438 | sub logger($;$) { |
358 | _logger |
439 | _logger |
359 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
440 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
360 | @_ |
441 | @_ |
361 | } |
442 | } |
|
|
443 | |
|
|
444 | =item AnyEvent::Log::exact_time $on |
|
|
445 | |
|
|
446 | By default, C<AnyEvent::Log> will use C<AE::now>, i.e. the cached |
|
|
447 | eventloop time, for the log timestamps. After calling this function with a |
|
|
448 | true value it will instead resort to C<AE::time>, i.e. fetch the current |
|
|
449 | time on each log message. This only makes a difference for event loops |
|
|
450 | that actually cache the time (such as L<EV> or L<AnyEvent::Loop>). |
|
|
451 | |
|
|
452 | This setting can be changed at any time by calling this function. |
|
|
453 | |
|
|
454 | Since C<AnyEvent::Log> has to work even before the L<AnyEvent> has been |
|
|
455 | initialised, this switch will also decide whether to use C<CORE::time> or |
|
|
456 | C<Time::HiRes::time> when logging a message before L<AnyEvent> becomes |
|
|
457 | available. |
362 | |
458 | |
363 | =back |
459 | =back |
364 | |
460 | |
365 | =head1 LOGGING CONTEXTS |
461 | =head1 LOGGING CONTEXTS |
366 | |
462 | |
… | |
… | |
486 | This can be used to implement config-file (re-)loading: before loading a |
582 | This can be used to implement config-file (re-)loading: before loading a |
487 | configuration, reset all contexts. |
583 | configuration, reset all contexts. |
488 | |
584 | |
489 | =cut |
585 | =cut |
490 | |
586 | |
|
|
587 | our $ORIG_VERBOSE = $AnyEvent::VERBOSE; |
|
|
588 | $AnyEvent::VERBOSE = 9; |
|
|
589 | |
491 | sub reset { |
590 | sub reset { |
492 | # hard to kill complex data structures |
591 | # hard to kill complex data structures |
493 | # we "recreate" all package loggers and reset the hierarchy |
592 | # we "recreate" all package loggers and reset the hierarchy |
494 | while (my ($k, $v) = each %CTX) { |
593 | while (my ($k, $v) = each %CTX) { |
495 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
594 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
… | |
… | |
498 | } |
597 | } |
499 | |
598 | |
500 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
599 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
501 | for $LOG, $FILTER, $COLLECT; |
600 | for $LOG, $FILTER, $COLLECT; |
502 | |
601 | |
503 | $LOG->slaves; |
602 | #$LOG->slaves; |
504 | $LOG->title ('$AnyEvent::Log::LOG'); |
603 | $LOG->title ('$AnyEvent::Log::LOG'); |
505 | $LOG->log_cb (sub { |
604 | $LOG->log_to_warn; |
506 | warn shift; |
|
|
507 | 0 |
|
|
508 | }); |
|
|
509 | |
605 | |
510 | $FILTER->slaves ($LOG); |
606 | $FILTER->slaves ($LOG); |
511 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
607 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
512 | $FILTER->level ($AnyEvent::VERBOSE); |
608 | $FILTER->level ($ORIG_VERBOSE); |
513 | |
609 | |
514 | $COLLECT->slaves ($FILTER); |
610 | $COLLECT->slaves ($FILTER); |
515 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
611 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
516 | |
612 | |
517 | _reassess; |
613 | _reassess; |
518 | } |
614 | } |
|
|
615 | |
|
|
616 | # override AE::log/logger |
|
|
617 | *AnyEvent::log = *AE::log = \&log; |
|
|
618 | *AnyEvent::logger = *AE::logger = \&logger; |
|
|
619 | |
|
|
620 | # convert AnyEvent loggers to AnyEvent::Log loggers |
|
|
621 | $_->[0] = ctx $_->[0] # convert "pkg" to "ctx" |
|
|
622 | for values %LOGGER; |
519 | |
623 | |
520 | # create the default logger contexts |
624 | # create the default logger contexts |
521 | $LOG = ctx undef; |
625 | $LOG = ctx undef; |
522 | $FILTER = ctx undef; |
626 | $FILTER = ctx undef; |
523 | $COLLECT = ctx undef; |
627 | $COLLECT = ctx undef; |
… | |
… | |
532 | package AnyEvent::Log::COLLECT; |
636 | package AnyEvent::Log::COLLECT; |
533 | package AE::Log::COLLECT; |
637 | package AE::Log::COLLECT; |
534 | |
638 | |
535 | package AnyEvent::Log::Ctx; |
639 | package AnyEvent::Log::Ctx; |
536 | |
640 | |
537 | # 0 1 2 3 4 |
|
|
538 | # [$title, $level, %$slaves, &$logcb, &$fmtcb] |
|
|
539 | |
|
|
540 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
641 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
541 | |
642 | |
542 | This is a convenience constructor that makes it simpler to construct |
643 | This is a convenience constructor that makes it simpler to construct |
543 | anonymous logging contexts. |
644 | anonymous logging contexts. |
544 | |
645 | |
… | |
… | |
631 | |
732 | |
632 | =item $ctx->disable ($level[, $level...]) |
733 | =item $ctx->disable ($level[, $level...]) |
633 | |
734 | |
634 | Disables logging for the given levels, leaving all others unchanged. |
735 | Disables logging for the given levels, leaving all others unchanged. |
635 | |
736 | |
|
|
737 | =item $ctx->cap ($level) |
|
|
738 | |
|
|
739 | Caps the maximum priority to the given level, for all messages logged |
|
|
740 | to, or passing through, this context. That is, while this doesn't affect |
|
|
741 | whether a message is logged or passed on, the maximum priority of messages |
|
|
742 | will be limited to the specified level - messages with a higher priority |
|
|
743 | will be set to the specified priority. |
|
|
744 | |
|
|
745 | Another way to view this is that C<< ->level >> filters out messages with |
|
|
746 | a too low priority, while C<< ->cap >> modifies messages with a too high |
|
|
747 | priority. |
|
|
748 | |
|
|
749 | This is useful when different log targets have different interpretations |
|
|
750 | of priority. For example, for a specific command line program, a wrong |
|
|
751 | command line switch might well result in a C<fatal> log message, while the |
|
|
752 | same message, logged to syslog, is likely I<not> fatal to the system or |
|
|
753 | syslog facility as a whole, but more likely a mere C<error>. |
|
|
754 | |
|
|
755 | This can be modeled by having a stderr logger that logs messages "as-is" |
|
|
756 | and a syslog logger that logs messages with a level cap of, say, C<error>, |
|
|
757 | or, for truly system-critical components, actually C<critical>. |
|
|
758 | |
636 | =cut |
759 | =cut |
637 | |
760 | |
638 | sub _lvl_lst { |
761 | sub _lvl_lst { |
639 | map { |
762 | map { |
640 | $_ > 0 && $_ <= 9 ? $_+0 |
763 | $_ > 0 && $_ <= 9 ? $_+0 |
641 | : $_ eq "all" ? (1 .. 9) |
764 | : $_ eq "all" ? (1 .. 9) |
642 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
765 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
643 | } @_ |
766 | } @_ |
644 | } |
767 | } |
645 | |
768 | |
|
|
769 | sub _lvl { |
|
|
770 | $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1] |
|
|
771 | } |
|
|
772 | |
646 | our $NOP_CB = sub { 0 }; |
773 | our $NOP_CB = sub { 0 }; |
647 | |
774 | |
648 | sub levels { |
775 | sub levels { |
649 | my $ctx = shift; |
776 | my $ctx = shift; |
650 | $ctx->[1] = 0; |
777 | $ctx->[1] = 0; |
… | |
… | |
653 | AnyEvent::Log::_reassess; |
780 | AnyEvent::Log::_reassess; |
654 | } |
781 | } |
655 | |
782 | |
656 | sub level { |
783 | sub level { |
657 | my $ctx = shift; |
784 | my $ctx = shift; |
658 | my $lvl = $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1]; |
|
|
659 | |
|
|
660 | $ctx->[1] = ((1 << $lvl) - 1) << 1; |
785 | $ctx->[1] = ((1 << &_lvl) - 1) << 1; |
661 | AnyEvent::Log::_reassess; |
786 | AnyEvent::Log::_reassess; |
662 | } |
787 | } |
663 | |
788 | |
664 | sub enable { |
789 | sub enable { |
665 | my $ctx = shift; |
790 | my $ctx = shift; |
… | |
… | |
673 | $ctx->[1] &= ~(1 << $_) |
798 | $ctx->[1] &= ~(1 << $_) |
674 | for &_lvl_lst; |
799 | for &_lvl_lst; |
675 | AnyEvent::Log::_reassess; |
800 | AnyEvent::Log::_reassess; |
676 | } |
801 | } |
677 | |
802 | |
|
|
803 | sub cap { |
|
|
804 | my $ctx = shift; |
|
|
805 | $ctx->[5] = &_lvl; |
|
|
806 | } |
|
|
807 | |
678 | =back |
808 | =back |
679 | |
809 | |
680 | =head3 SLAVE CONTEXTS |
810 | =head3 SLAVE CONTEXTS |
681 | |
811 | |
682 | The following methods attach and detach another logging context to a |
812 | The following methods attach and detach another logging context to a |
… | |
… | |
734 | the logging (which consists of formatting the message and printing it or |
864 | the logging (which consists of formatting the message and printing it or |
735 | whatever it wants to do with it). |
865 | whatever it wants to do with it). |
736 | |
866 | |
737 | =over 4 |
867 | =over 4 |
738 | |
868 | |
739 | =item $ctx->log_cb ($cb->($str, $orig_ctx, $level)) |
869 | =item $ctx->log_cb ($cb->($str)) |
740 | |
870 | |
741 | Replaces the logging callback on the context (C<undef> disables the |
871 | Replaces the logging callback on the context (C<undef> disables the |
742 | logging callback). |
872 | logging callback). |
743 | |
873 | |
744 | The logging callback is responsible for handling formatted log messages |
874 | The logging callback is responsible for handling formatted log messages |
745 | (see C<fmt_cb> below) - normally simple text strings that end with a |
875 | (see C<fmt_cb> below) - normally simple text strings that end with a |
746 | newline (and are possibly multiline themselves). In addition to the |
876 | newline (and are possibly multiline themselves). |
747 | message, which is often the only argument you need to look at, it is |
|
|
748 | passed the numeric log level and originating context. |
|
|
749 | |
877 | |
750 | It also has to return true iff it has consumed the log message, and false |
878 | It also has to return true iff it has consumed the log message, and false |
751 | if it hasn't. Consuming a message means that it will not be sent to any |
879 | if it hasn't. Consuming a message means that it will not be sent to any |
752 | slave context. When in doubt, return C<0> from your logging callback. |
880 | slave context. When in doubt, return C<0> from your logging callback. |
753 | |
881 | |
… | |
… | |
765 | your program. |
893 | your program. |
766 | |
894 | |
767 | $ctx->levels ("debug", "trace"); |
895 | $ctx->levels ("debug", "trace"); |
768 | $ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages |
896 | $ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages |
769 | |
897 | |
770 | =item $ctx->log_to_file ($path) |
|
|
771 | |
|
|
772 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
|
|
773 | |
|
|
774 | =item $ctx->log_to_path ($path) |
|
|
775 | |
|
|
776 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
|
|
777 | is much slower, but allows you to change/move/rename/delete the file at |
|
|
778 | basically any time. |
|
|
779 | |
|
|
780 | =item $ctx->log_to_syslog ([$log_flags]) |
|
|
781 | |
|
|
782 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
|
|
783 | the others in the obvious way. If specified, then the C<$log_flags> are |
|
|
784 | simply or'ed onto the priority argument and can contain any C<LOG_xxx> |
|
|
785 | flags valid for Sys::Syslog::syslog, except for the priority levels. |
|
|
786 | |
|
|
787 | Note that the default logging format includes a verbose timestamp, which |
|
|
788 | is not so suited for syslog, so a simpler C<fmt_cb> might be useful: |
|
|
789 | |
|
|
790 | $ctx->log_to_syslog; |
|
|
791 | $ctx->fmt_cb (sub { "($_[1][0]) $_[3]" }); |
|
|
792 | |
|
|
793 | =item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message)) |
898 | =item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message)) |
794 | |
899 | |
795 | Replaces the formatting callback on the context (C<undef> restores the |
900 | Replaces the formatting callback on the context (C<undef> restores the |
796 | default formatter). |
901 | default formatter). |
797 | |
902 | |
798 | The callback is passed the (possibly fractional) timestamp, the original |
903 | The callback is passed the (possibly fractional) timestamp, the original |
799 | logging context, the (numeric) logging level and the raw message string |
904 | logging context (object, not title), the (numeric) logging level and |
800 | and needs to return a formatted log message. In most cases this will be a |
905 | the raw message string and needs to return a formatted log message. In |
801 | string, but it could just as well be an array reference that just stores |
906 | most cases this will be a string, but it could just as well be an array |
802 | the values. |
907 | reference that just stores the values. |
803 | |
908 | |
804 | If, for some reaosn, you want to use C<caller> to find out more baout the |
909 | If, for some reason, you want to use C<caller> to find out more about the |
805 | logger then you should walk up the call stack until you are no longer |
910 | logger then you should walk up the call stack until you are no longer |
806 | inside the C<AnyEvent::Log> package. |
911 | inside the C<AnyEvent::Log> package. |
807 | |
912 | |
808 | Example: format just the raw message, with numeric log level in angle |
913 | Example: format just the raw message, with numeric log level in angle |
809 | brackets. |
914 | brackets. |
… | |
… | |
813 | |
918 | |
814 | "<$lvl>$msg\n" |
919 | "<$lvl>$msg\n" |
815 | }); |
920 | }); |
816 | |
921 | |
817 | Example: return an array reference with just the log values, and use |
922 | Example: return an array reference with just the log values, and use |
818 | C<PApp::SQL::sql_exec> to store the emssage in a database. |
923 | C<PApp::SQL::sql_exec> to store the message in a database. |
819 | |
924 | |
820 | $ctx->fmt_cb (sub { \@_ }); |
925 | $ctx->fmt_cb (sub { \@_ }); |
821 | $ctx->log_cb (sub { |
926 | $ctx->log_cb (sub { |
822 | my ($msg) = @_; |
927 | my ($msg) = @_; |
823 | |
928 | |
… | |
… | |
828 | "$msg->[3]"; |
933 | "$msg->[3]"; |
829 | |
934 | |
830 | 0 |
935 | 0 |
831 | }); |
936 | }); |
832 | |
937 | |
|
|
938 | =item $ctx->log_to_warn |
|
|
939 | |
|
|
940 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
|
|
941 | (usually this logs to STDERR). |
|
|
942 | |
|
|
943 | =item $ctx->log_to_file ($path) |
|
|
944 | |
|
|
945 | Sets the C<log_cb> to log to a file (by appending), unbuffered. The |
|
|
946 | function might return before the log file has been opened or created. |
|
|
947 | |
|
|
948 | =item $ctx->log_to_path ($path) |
|
|
949 | |
|
|
950 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
|
|
951 | is much slower, but allows you to change/move/rename/delete the file at |
|
|
952 | basically any time. |
|
|
953 | |
|
|
954 | Needless(?) to say, if you do not want to be bitten by some evil person |
|
|
955 | calling C<chdir>, the path should be absolute. Doesn't help with |
|
|
956 | C<chroot>, but hey... |
|
|
957 | |
|
|
958 | =item $ctx->log_to_syslog ([$facility]) |
|
|
959 | |
|
|
960 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and |
|
|
961 | all the others in the obvious way. If specified, then the C<$facility> is |
|
|
962 | used as the facility (C<user>, C<auth>, C<local0> and so on). The default |
|
|
963 | facility is C<user>. |
|
|
964 | |
|
|
965 | Note that this function also sets a C<fmt_cb> - the logging part requires |
|
|
966 | an array reference with [$level, $str] as input. |
|
|
967 | |
833 | =cut |
968 | =cut |
834 | |
969 | |
835 | sub log_cb { |
970 | sub log_cb { |
836 | my ($ctx, $cb) = @_; |
971 | my ($ctx, $cb) = @_; |
837 | |
972 | |
… | |
… | |
842 | my ($ctx, $cb) = @_; |
977 | my ($ctx, $cb) = @_; |
843 | |
978 | |
844 | $ctx->[4] = $cb; |
979 | $ctx->[4] = $cb; |
845 | } |
980 | } |
846 | |
981 | |
|
|
982 | sub log_to_warn { |
|
|
983 | my ($ctx, $path) = @_; |
|
|
984 | |
|
|
985 | $ctx->log_cb (sub { |
|
|
986 | warn shift; |
|
|
987 | 0 |
|
|
988 | }); |
|
|
989 | } |
|
|
990 | |
|
|
991 | # this function is a good example of why threads are a must, |
|
|
992 | # simply for priority inversion. |
|
|
993 | sub _log_to_disk { |
|
|
994 | # eval'uating this at runtime saves 220kb rss - perl has become |
|
|
995 | # an insane memory waster. |
|
|
996 | eval q{ # poor man's autoloading {} |
|
|
997 | sub _log_to_disk { |
|
|
998 | my ($ctx, $path, $keepopen) = @_; |
|
|
999 | |
|
|
1000 | my $fh; |
|
|
1001 | my @queue; |
|
|
1002 | my $delay; |
|
|
1003 | my $disable; |
|
|
1004 | |
|
|
1005 | use AnyEvent::IO (); |
|
|
1006 | |
|
|
1007 | my $kick = sub { |
|
|
1008 | undef $delay; |
|
|
1009 | return unless @queue; |
|
|
1010 | $delay = 1; |
|
|
1011 | |
|
|
1012 | # we pass $kick to $kick, so $kick itself doesn't keep a reference to $kick. |
|
|
1013 | my $kick = shift; |
|
|
1014 | |
|
|
1015 | # write one or more messages |
|
|
1016 | my $write = sub { |
|
|
1017 | # we write as many messages as have been queued |
|
|
1018 | my $data = join "", @queue; |
|
|
1019 | @queue = (); |
|
|
1020 | |
|
|
1021 | AnyEvent::IO::aio_write $fh, $data, sub { |
|
|
1022 | $disable = 1; |
|
|
1023 | @_ |
|
|
1024 | ? ($_[0] == length $data or AE::log 4 => "unable to write to logfile '$path': short write") |
|
|
1025 | : AE::log 4 => "unable to write to logfile '$path': $!"; |
|
|
1026 | undef $disable; |
|
|
1027 | |
|
|
1028 | if ($keepopen) { |
|
|
1029 | $kick->($kick); |
|
|
1030 | } else { |
|
|
1031 | AnyEvent::IO::aio_close ($fh, sub { |
|
|
1032 | undef $fh; |
|
|
1033 | $kick->($kick); |
|
|
1034 | }); |
|
|
1035 | } |
|
|
1036 | }; |
|
|
1037 | }; |
|
|
1038 | |
|
|
1039 | if ($fh) { |
|
|
1040 | $write->(); |
|
|
1041 | } else { |
|
|
1042 | AnyEvent::IO::aio_open |
|
|
1043 | $path, |
|
|
1044 | AnyEvent::IO::O_CREAT | AnyEvent::IO::O_WRONLY | AnyEvent::IO::O_APPEND, |
|
|
1045 | 0666, |
|
|
1046 | sub { |
|
|
1047 | $fh = shift |
|
|
1048 | or do { |
|
|
1049 | $disable = 1; |
|
|
1050 | AE::log 4 => "unable to open logfile '$path': $!"; |
|
|
1051 | undef $disable; |
|
|
1052 | return; |
|
|
1053 | }; |
|
|
1054 | |
|
|
1055 | $write->(); |
|
|
1056 | } |
|
|
1057 | ; |
|
|
1058 | } |
|
|
1059 | }; |
|
|
1060 | |
|
|
1061 | $ctx->log_cb (sub { |
|
|
1062 | return if $disable; |
|
|
1063 | push @queue, shift; |
|
|
1064 | $kick->($kick) unless $delay; |
|
|
1065 | 0 |
|
|
1066 | }); |
|
|
1067 | |
|
|
1068 | $kick->($kick) if $keepopen; # initial open |
|
|
1069 | }; |
|
|
1070 | }; |
|
|
1071 | die if $@; |
|
|
1072 | &_log_to_disk |
|
|
1073 | } |
|
|
1074 | |
847 | sub log_to_file { |
1075 | sub log_to_file { |
848 | my ($ctx, $path) = @_; |
1076 | my ($ctx, $path) = @_; |
849 | |
1077 | |
850 | open my $fh, ">>", $path |
1078 | _log_to_disk $ctx, $path, 1; |
851 | or die "$path: $!"; |
1079 | } |
|
|
1080 | |
|
|
1081 | sub log_to_path { |
|
|
1082 | my ($ctx, $path) = @_; |
|
|
1083 | |
|
|
1084 | _log_to_disk $ctx, $path, 0; |
|
|
1085 | } |
|
|
1086 | |
|
|
1087 | sub log_to_syslog { |
|
|
1088 | my ($ctx, $facility) = @_; |
|
|
1089 | |
|
|
1090 | require Sys::Syslog; |
|
|
1091 | |
|
|
1092 | $ctx->fmt_cb (sub { |
|
|
1093 | my $str = $_[3]; |
|
|
1094 | $str =~ s/\n(?=.)/\n+ /g; |
|
|
1095 | |
|
|
1096 | [$_[2], "($_[1][0]) $str"] |
|
|
1097 | }); |
|
|
1098 | |
|
|
1099 | $facility ||= "user"; |
852 | |
1100 | |
853 | $ctx->log_cb (sub { |
1101 | $ctx->log_cb (sub { |
854 | syswrite $fh, shift; |
1102 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
|
|
1103 | |
|
|
1104 | Sys::Syslog::syslog ("$facility|" . ($lvl - 1), $_) |
|
|
1105 | for split /\n/, $_[0][1]; |
|
|
1106 | |
855 | 0 |
1107 | 0 |
856 | }); |
1108 | }); |
857 | } |
1109 | } |
858 | |
1110 | |
859 | sub log_to_file { |
|
|
860 | my ($ctx, $path) = @_; |
|
|
861 | |
|
|
862 | $ctx->log_cb (sub { |
|
|
863 | open my $fh, ">>", $path |
|
|
864 | or die "$path: $!"; |
|
|
865 | |
|
|
866 | syswrite $fh, shift; |
|
|
867 | 0 |
|
|
868 | }); |
|
|
869 | } |
|
|
870 | |
|
|
871 | sub log_to_syslog { |
|
|
872 | my ($ctx, $flags) = @_; |
|
|
873 | |
|
|
874 | require Sys::Syslog; |
|
|
875 | |
|
|
876 | $ctx->log_cb (sub { |
|
|
877 | my $lvl = $_[2] < 9 ? $_[2] : 8; |
|
|
878 | |
|
|
879 | Sys::Syslog::syslog ($flags | ($lvl - 1), $_) |
|
|
880 | for split /\n/, shift; |
|
|
881 | |
|
|
882 | 0 |
|
|
883 | }); |
|
|
884 | } |
|
|
885 | |
|
|
886 | =back |
1111 | =back |
887 | |
1112 | |
888 | =head3 MESSAGE LOGGING |
1113 | =head3 MESSAGE LOGGING |
889 | |
1114 | |
890 | These methods allow you to log messages directly to a context, without |
1115 | These methods allow you to log messages directly to a context, without |
… | |
… | |
894 | |
1119 | |
895 | =item $ctx->log ($level, $msg[, @params]) |
1120 | =item $ctx->log ($level, $msg[, @params]) |
896 | |
1121 | |
897 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
1122 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
898 | |
1123 | |
|
|
1124 | Example: log a message in the context of another package. |
|
|
1125 | |
|
|
1126 | (AnyEvent::Log::ctx "Other::Package")->log (warn => "heely bo"); |
|
|
1127 | |
899 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1128 | =item $logger = $ctx->logger ($level[, \$enabled]) |
900 | |
1129 | |
901 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1130 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
902 | context. |
1131 | context. |
903 | |
1132 | |
904 | =cut |
1133 | =cut |
905 | |
1134 | |
906 | *log = \&AnyEvent::Log::_log; |
1135 | *log = \&AnyEvent::Log::_log; |
907 | *logger = \&AnyEvent::Log::_logger; |
1136 | *logger = \&AnyEvent::Log::_logger; |
908 | |
1137 | |
909 | 1; |
|
|
910 | |
|
|
911 | =back |
1138 | =back |
912 | |
1139 | |
|
|
1140 | =cut |
|
|
1141 | |
|
|
1142 | package AnyEvent::Log; |
|
|
1143 | |
|
|
1144 | =head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG} |
|
|
1145 | |
|
|
1146 | Logging can also be configured by setting the environment variable |
|
|
1147 | C<PERL_ANYEVENT_LOG> (or C<AE_LOG>). |
|
|
1148 | |
|
|
1149 | The value consists of one or more logging context specifications separated |
|
|
1150 | by C<:> or whitespace. Each logging specification in turn starts with a |
|
|
1151 | context name, followed by C<=>, followed by zero or more comma-separated |
|
|
1152 | configuration directives, here are some examples: |
|
|
1153 | |
|
|
1154 | # set default logging level |
|
|
1155 | filter=warn |
|
|
1156 | |
|
|
1157 | # log to file instead of to stderr |
|
|
1158 | log=file=/tmp/mylog |
|
|
1159 | |
|
|
1160 | # log to file in addition to stderr |
|
|
1161 | log=+%file:%file=file=/tmp/mylog |
|
|
1162 | |
|
|
1163 | # enable debug log messages, log warnings and above to syslog |
|
|
1164 | filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0 |
|
|
1165 | |
|
|
1166 | # log trace messages (only) from AnyEvent::Debug to file |
|
|
1167 | AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog |
|
|
1168 | |
|
|
1169 | A context name in the log specification can be any of the following: |
|
|
1170 | |
|
|
1171 | =over 4 |
|
|
1172 | |
|
|
1173 | =item C<collect>, C<filter>, C<log> |
|
|
1174 | |
|
|
1175 | Correspond to the three predefined C<$AnyEvent::Log::COLLECT>, |
|
|
1176 | C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts. |
|
|
1177 | |
|
|
1178 | =item C<%name> |
|
|
1179 | |
|
|
1180 | Context names starting with a C<%> are anonymous contexts created when the |
|
|
1181 | name is first mentioned. The difference to package contexts is that by |
|
|
1182 | default they have no attached slaves. |
|
|
1183 | |
|
|
1184 | =item a perl package name |
|
|
1185 | |
|
|
1186 | Any other string references the logging context associated with the given |
|
|
1187 | Perl C<package>. In the unlikely case where you want to specify a package |
|
|
1188 | context that matches on of the other context name forms, you can add a |
|
|
1189 | C<::> to the package name to force interpretation as a package. |
|
|
1190 | |
|
|
1191 | =back |
|
|
1192 | |
|
|
1193 | The configuration specifications can be any number of the following: |
|
|
1194 | |
|
|
1195 | =over 4 |
|
|
1196 | |
|
|
1197 | =item C<stderr> |
|
|
1198 | |
|
|
1199 | Configures the context to use Perl's C<warn> function (which typically |
|
|
1200 | logs to C<STDERR>). Works like C<log_to_warn>. |
|
|
1201 | |
|
|
1202 | =item C<file=>I<path> |
|
|
1203 | |
|
|
1204 | Configures the context to log to a file with the given path. Works like |
|
|
1205 | C<log_to_file>. |
|
|
1206 | |
|
|
1207 | =item C<path=>I<path> |
|
|
1208 | |
|
|
1209 | Configures the context to log to a file with the given path. Works like |
|
|
1210 | C<log_to_path>. |
|
|
1211 | |
|
|
1212 | =item C<syslog> or C<syslog=>I<expr> |
|
|
1213 | |
|
|
1214 | Configures the context to log to syslog. If I<expr> is given, then it is |
|
|
1215 | evaluated in the L<Sys::Syslog> package, so you could use: |
|
|
1216 | |
|
|
1217 | log=syslog=LOG_LOCAL0 |
|
|
1218 | |
|
|
1219 | =item C<nolog> |
|
|
1220 | |
|
|
1221 | Configures the context to not log anything by itself, which is the |
|
|
1222 | default. Same as C<< $ctx->log_cb (undef) >>. |
|
|
1223 | |
|
|
1224 | =item C<cap=>I<level> |
|
|
1225 | |
|
|
1226 | Caps logging messages entering this context at the given level, i.e. |
|
|
1227 | reduces the priority of messages with higher priority than this level. The |
|
|
1228 | default is C<0> (or C<off>), meaning the priority will not be touched. |
|
|
1229 | |
|
|
1230 | =item C<0> or C<off> |
|
|
1231 | |
|
|
1232 | Sets the logging level of the context to C<0>, i.e. all messages will be |
|
|
1233 | filtered out. |
|
|
1234 | |
|
|
1235 | =item C<all> |
|
|
1236 | |
|
|
1237 | Enables all logging levels, i.e. filtering will effectively be switched |
|
|
1238 | off (the default). |
|
|
1239 | |
|
|
1240 | =item C<only> |
|
|
1241 | |
|
|
1242 | Disables all logging levels, and changes the interpretation of following |
|
|
1243 | level specifications to enable the specified level only. |
|
|
1244 | |
|
|
1245 | Example: only enable debug messages for a context. |
|
|
1246 | |
|
|
1247 | context=only,debug |
|
|
1248 | |
|
|
1249 | =item C<except> |
|
|
1250 | |
|
|
1251 | Enables all logging levels, and changes the interpretation of following |
|
|
1252 | level specifications to disable that level. Rarely used. |
|
|
1253 | |
|
|
1254 | Example: enable all logging levels except fatal and trace (this is rather |
|
|
1255 | nonsensical). |
|
|
1256 | |
|
|
1257 | filter=exept,fatal,trace |
|
|
1258 | |
|
|
1259 | =item C<level> |
|
|
1260 | |
|
|
1261 | Enables all logging levels, and changes the interpretation of following |
|
|
1262 | level specifications to be "that level or any higher priority |
|
|
1263 | message". This is the default. |
|
|
1264 | |
|
|
1265 | Example: log anything at or above warn level. |
|
|
1266 | |
|
|
1267 | filter=warn |
|
|
1268 | |
|
|
1269 | # or, more verbose |
|
|
1270 | filter=only,level,warn |
|
|
1271 | |
|
|
1272 | =item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.) |
|
|
1273 | |
|
|
1274 | A numeric loglevel or the name of a loglevel will be interpreted according |
|
|
1275 | to the most recent C<only>, C<except> or C<level> directive. By default, |
|
|
1276 | specifying a logging level enables that and any higher priority messages. |
|
|
1277 | |
|
|
1278 | =item C<+>I<context> |
|
|
1279 | |
|
|
1280 | Attaches the named context as slave to the context. |
|
|
1281 | |
|
|
1282 | =item C<+> |
|
|
1283 | |
|
|
1284 | A lone C<+> detaches all contexts, i.e. clears the slave list from the |
|
|
1285 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
|
|
1286 | but package contexts have the parent context as slave by default. |
|
|
1287 | |
|
|
1288 | Example: log messages from My::Module to a file, do not send them to the |
|
|
1289 | default log collector. |
|
|
1290 | |
|
|
1291 | My::Module=+,file=/tmp/mymodulelog |
|
|
1292 | |
|
|
1293 | =back |
|
|
1294 | |
|
|
1295 | Any character can be escaped by prefixing it with a C<\> (backslash), as |
|
|
1296 | usual, so to log to a file containing a comma, colon, backslash and some |
|
|
1297 | spaces in the filename, you would do this: |
|
|
1298 | |
|
|
1299 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
|
|
1300 | |
|
|
1301 | Since whitespace (which includes newlines) is allowed, it is fine to |
|
|
1302 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |
|
|
1303 | |
|
|
1304 | PERL_ANYEVENT_LOG=" |
|
|
1305 | filter=warn |
|
|
1306 | AnyEvent::Debug=+%trace |
|
|
1307 | %trace=only,trace,+log |
|
|
1308 | " myprog |
|
|
1309 | |
|
|
1310 | Also, in the unlikely case when you want to concatenate specifications, |
|
|
1311 | use whitespace as separator, as C<::> will be interpreted as part of a |
|
|
1312 | module name, an empty spec with two separators: |
|
|
1313 | |
|
|
1314 | PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug" |
|
|
1315 | |
|
|
1316 | =cut |
|
|
1317 | |
|
|
1318 | for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { |
|
|
1319 | my %anon; |
|
|
1320 | |
|
|
1321 | my $pkg = sub { |
|
|
1322 | $_[0] eq "log" ? $LOG |
|
|
1323 | : $_[0] eq "filter" ? $FILTER |
|
|
1324 | : $_[0] eq "collect" ? $COLLECT |
|
|
1325 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= do { my $ctx = ctx undef; $ctx->[0] = $_[0]; $ctx }) |
|
|
1326 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
|
|
1327 | : die # never reached? |
|
|
1328 | }; |
|
|
1329 | |
|
|
1330 | /\G[[:space:]]+/gc; # skip initial whitespace |
|
|
1331 | |
|
|
1332 | while (/\G((?:[^:=[:space:]]+|::|\\.)+)=/gc) { |
|
|
1333 | my $ctx = $pkg->($1); |
|
|
1334 | my $level = "level"; |
|
|
1335 | |
|
|
1336 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
|
|
1337 | for ("$1") { |
|
|
1338 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
|
|
1339 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
|
|
1340 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
|
|
1341 | } elsif (/^syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ("$1"); |
|
|
1342 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
|
|
1343 | } elsif (/^cap=(.+)/ ) { $ctx->cap ("$1"); |
|
|
1344 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
|
|
1345 | } elsif ($_ eq "+" ) { $ctx->slaves; |
|
|
1346 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
|
|
1347 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
|
|
1348 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
|
|
1349 | } elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable"; |
|
|
1350 | } elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable"; |
|
|
1351 | } elsif (/^\d$/ ) { $ctx->$level ($_); |
|
|
1352 | } elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_); |
|
|
1353 | } else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n"; |
|
|
1354 | } |
|
|
1355 | } |
|
|
1356 | |
|
|
1357 | /\G,/gc or last; |
|
|
1358 | } |
|
|
1359 | |
|
|
1360 | /\G[:[:space:]]+/gc or last; |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | /\G[[:space:]]+/gc; # skip trailing whitespace |
|
|
1364 | |
|
|
1365 | if (/\G(.+)/g) { |
|
|
1366 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
|
|
1367 | } |
|
|
1368 | } |
|
|
1369 | |
913 | =head1 EXAMPLES |
1370 | =head1 EXAMPLES |
914 | |
1371 | |
915 | This section shows some common configurations. |
1372 | This section shows some common configurations, both as code, and as |
|
|
1373 | C<PERL_ANYEVENT_LOG> string. |
916 | |
1374 | |
917 | =over 4 |
1375 | =over 4 |
918 | |
1376 | |
919 | =item Setting the global logging level. |
1377 | =item Setting the global logging level. |
920 | |
1378 | |
921 | Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
1379 | Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before |
922 | running your program, or modify the log level of the root context: |
1380 | running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of |
|
|
1381 | the root context at runtime: |
923 | |
1382 | |
924 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1383 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
925 | |
1384 | |
|
|
1385 | PERL_ANYEVENT_LOG=log=warn |
|
|
1386 | |
926 | $AnyEvent::Log::FILTER->level ("warn"); |
1387 | $AnyEvent::Log::FILTER->level ("warn"); |
927 | |
1388 | |
928 | =item Append all messages to a file instead of sending them to STDERR. |
1389 | =item Append all messages to a file instead of sending them to STDERR. |
929 | |
1390 | |
930 | This is affected by the global logging level. |
1391 | This is affected by the global logging level. |
931 | |
1392 | |
932 | $AnyEvent::Log::LOG->log_to_file ($path); (sub { |
1393 | $AnyEvent::Log::LOG->log_to_file ($path); |
|
|
1394 | |
|
|
1395 | PERL_ANYEVENT_LOG=log=file=/some/path |
933 | |
1396 | |
934 | =item Write all messages with priority C<error> and higher to a file. |
1397 | =item Write all messages with priority C<error> and higher to a file. |
935 | |
1398 | |
936 | This writes them only when the global logging level allows it, because |
1399 | This writes them only when the global logging level allows it, because |
937 | it is attached to the default context which is invoked I<after> global |
1400 | it is attached to the default context which is invoked I<after> global |
938 | filtering. |
1401 | filtering. |
939 | |
1402 | |
940 | $AnyEvent::Log::FILTER->attach |
1403 | $AnyEvent::Log::FILTER->attach ( |
941 | new AnyEvent::Log::Ctx log_to_file => $path); |
1404 | new AnyEvent::Log::Ctx log_to_file => $path); |
|
|
1405 | |
|
|
1406 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
942 | |
1407 | |
943 | This writes them regardless of the global logging level, because it is |
1408 | This writes them regardless of the global logging level, because it is |
944 | attached to the toplevel context, which receives all messages I<before> |
1409 | attached to the toplevel context, which receives all messages I<before> |
945 | the global filtering. |
1410 | the global filtering. |
946 | |
1411 | |
947 | $AnyEvent::Log::COLLECT->attach ( |
1412 | $AnyEvent::Log::COLLECT->attach ( |
948 | new AnyEvent::Log::Ctx log_to_file => $path); |
1413 | new AnyEvent::Log::Ctx log_to_file => $path); |
949 | |
1414 | |
|
|
1415 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
|
|
1416 | |
950 | In both cases, messages are still written to STDERR. |
1417 | In both cases, messages are still written to STDERR. |
|
|
1418 | |
|
|
1419 | =item Additionally log all messages with C<warn> and higher priority to |
|
|
1420 | C<syslog>, but cap at C<error>. |
|
|
1421 | |
|
|
1422 | This logs all messages to the default log target, but also logs messages |
|
|
1423 | with priority C<warn> or higher (and not filtered otherwise) to syslog |
|
|
1424 | facility C<user>. Messages with priority higher than C<error> will be |
|
|
1425 | logged with level C<error>. |
|
|
1426 | |
|
|
1427 | $AnyEvent::Log::LOG->attach ( |
|
|
1428 | new AnyEvent::Log::Ctx |
|
|
1429 | level => "warn", |
|
|
1430 | cap => "error", |
|
|
1431 | syslog => "user", |
|
|
1432 | ); |
|
|
1433 | |
|
|
1434 | PERL_ANYEVENT_LOG=log=+%syslog:%syslog=warn,cap=error,syslog |
951 | |
1435 | |
952 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1436 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
953 | |
1437 | |
954 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1438 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
955 | context - this simply circumvents the global filtering for trace messages. |
1439 | context - this simply circumvents the global filtering for trace messages. |
956 | |
1440 | |
957 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1441 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
958 | $debug->attach ($AnyEvent::Log::LOG); |
1442 | $debug->attach ($AnyEvent::Log::LOG); |
|
|
1443 | |
|
|
1444 | PERL_ANYEVENT_LOG=AnyEvent::Debug=+log |
959 | |
1445 | |
960 | This of course works for any package, not just L<AnyEvent::Debug>, but |
1446 | This of course works for any package, not just L<AnyEvent::Debug>, but |
961 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
1447 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
962 | default. |
1448 | default. |
963 | |
1449 | |
964 | =back |
1450 | =back |
965 | |
1451 | |
966 | =head1 AUTHOR |
1452 | =head1 AUTHOR |
967 | |
1453 | |
968 | Marc Lehmann <schmorp@schmorp.de> |
1454 | Marc Lehmann <schmorp@schmorp.de> |
969 | http://home.schmorp.de/ |
1455 | http://anyevent.schmorp.de |
970 | |
1456 | |
971 | =cut |
1457 | =cut |
|
|
1458 | |
|
|
1459 | 1 |
|
|
1460 | |