… | |
… | |
6 | |
6 | |
7 | Simple uses: |
7 | Simple uses: |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
11 | AE::log debug => "hit my knee"; |
11 | AE::log fatal => "No config found, cannot continue!"; # never returns |
12 | AE::log warn => "it's a bit too hot"; |
12 | AE::log alert => "The battery died!"; |
13 | AE::log error => "the flag was false!"; |
13 | AE::log crit => "The battery is too hot!"; |
14 | AE::log fatal => "the bit toggled! run!"; # never returns |
14 | AE::log error => "Division by zero attempted."; |
|
|
15 | AE::log warn => "Couldn't delete the file."; |
|
|
16 | AE::log note => "Attempted 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"; |
15 | |
20 | |
|
|
21 | Log level overview: |
|
|
22 | |
|
|
23 | LVL NAME SYSLOG PERL NOTE |
|
|
24 | 1 fatal emerg exit system unusable, aborts program! |
|
|
25 | 2 alert failure in primary system |
|
|
26 | 3 critical crit failure in backup system |
|
|
27 | 4 error err die non-urgent program errors, a bug |
|
|
28 | 5 warn warning possible problem, not necessarily error |
|
|
29 | 6 note notice unusual conditions |
|
|
30 | 7 info normal messages, no action required |
|
|
31 | 8 debug debugging messages for development |
|
|
32 | 9 trace copious tracing output |
|
|
33 | |
16 | "Complex" uses (for speed sensitive code): |
34 | "Complex" uses (for speed sensitive code, e.g. trace/debug messages): |
17 | |
35 | |
18 | use AnyEvent::Log; |
36 | use AnyEvent::Log; |
19 | |
37 | |
20 | my $tracer = AnyEvent::Log::logger trace => \$my $trace; |
38 | my $tracer = AnyEvent::Log::logger trace => \my $trace; |
21 | |
39 | |
22 | $tracer->("i am here") if $trace; |
40 | $tracer->("i am here") if $trace; |
23 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
41 | $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; |
24 | |
42 | |
25 | Configuration (also look at the EXAMPLES section): |
43 | Configuration (also look at the EXAMPLES section): |
26 | |
44 | |
|
|
45 | # set default logging level to suppress anything below "notice" |
|
|
46 | # i.e. enable logging at "notice" or above - the default is to |
|
|
47 | # to not log anything at all. |
|
|
48 | $AnyEvent::Log::FILTER->level ("notice"); |
|
|
49 | |
27 | # set logging for the current package to errors and higher only |
50 | # set logging for the current package to errors and higher only |
28 | AnyEvent::Log::ctx->level ("error"); |
51 | AnyEvent::Log::ctx->level ("error"); |
29 | |
52 | |
30 | # set logging level to suppress anything below "notice" |
53 | # enable logging for the current package, regardless of global logging level |
31 | $AnyEvent::Log::FILTER->level ("notice"); |
54 | AnyEvent::Log::ctx->attach ($AnyEvent::Log::LOG); |
|
|
55 | |
|
|
56 | # enable debug logging for module some::mod and enable logging by default |
|
|
57 | (AnyEvent::Log::ctx "some::mod")->level ("debug"); |
|
|
58 | (AnyEvent::Log::ctx "some::mod")->attach ($AnyEvent::Log::LOG); |
32 | |
59 | |
33 | # send all critical and higher priority messages to syslog, |
60 | # send all critical and higher priority messages to syslog, |
34 | # regardless of (most) other settings |
61 | # regardless of (most) other settings |
35 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
62 | $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx |
36 | level => "critical", |
63 | level => "critical", |
37 | log_to_syslog => 0, |
64 | log_to_syslog => "user", |
38 | ); |
65 | ); |
39 | |
66 | |
40 | =head1 DESCRIPTION |
67 | =head1 DESCRIPTION |
41 | |
68 | |
42 | This module implements a relatively simple "logging framework". It doesn't |
69 | This module implements a relatively simple "logging framework". It doesn't |
43 | attempt to be "the" logging solution or even "a" logging solution for |
70 | attempt to be "the" logging solution or even "a" logging solution for |
44 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
71 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
45 | module more or less exposes the mechanism, with some extra spiff to allow |
72 | module more or less exposes the mechanism, with some extra spiff to allow |
46 | using it from other modules as well. |
73 | using it from other modules as well. |
47 | |
74 | |
48 | Remember that the default verbosity level is C<0> (C<off>), so nothing |
75 | Remember that the default verbosity level is C<4> (C<error>), so only |
49 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
76 | errors and more important messages will be logged, unless you set |
50 | before starting your program, or change the logging level at runtime with |
77 | C<PERL_ANYEVENT_VERBOSE> to a higher number before starting your program |
51 | something like: |
78 | (C<AE_VERBOSE=5> is recommended during development), or change the logging |
|
|
79 | level at runtime with something like: |
52 | |
80 | |
53 | use AnyEvent::Log; |
81 | use AnyEvent::Log; |
54 | AnyEvent::Log::FILTER->level ("info"); |
82 | $AnyEvent::Log::FILTER->level ("info"); |
55 | |
83 | |
56 | The design goal behind this module was to keep it simple (and small), |
84 | 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 |
85 | but make it powerful enough to be potentially useful for any module, |
58 | extensive enough for the most common tasks, such as logging to multiple |
86 | and extensive enough for the most common tasks, such as logging to |
59 | targets, or being able to log into a database. |
87 | multiple targets, or being able to log into a database. |
60 | |
88 | |
|
|
89 | The module is also usable before AnyEvent itself is initialised, in which |
|
|
90 | case some of the functionality might be reduced. |
|
|
91 | |
61 | The amount of documentation might indicate otherwise, but the module is |
92 | The amount of documentation might indicate otherwise, but the runtime part |
62 | still just below 300 lines of code. |
93 | of the module is still just below 300 lines of code. |
63 | |
94 | |
64 | =head1 LOGGING LEVELS |
95 | =head1 LOGGING LEVELS |
65 | |
96 | |
66 | Logging levels in this module range from C<1> (highest priority) to C<9> |
97 | 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 |
98 | (lowest priority). Note that the lowest numerical value is the highest |
… | |
… | |
69 | numerical value". |
100 | numerical value". |
70 | |
101 | |
71 | Instead of specifying levels by name you can also specify them by aliases: |
102 | Instead of specifying levels by name you can also specify them by aliases: |
72 | |
103 | |
73 | LVL NAME SYSLOG PERL NOTE |
104 | LVL NAME SYSLOG PERL NOTE |
74 | 1 fatal emerg exit aborts program! |
105 | 1 fatal emerg exit system unusable, aborts program! |
75 | 2 alert |
106 | 2 alert failure in primary system |
76 | 3 critical crit |
107 | 3 critical crit failure in backup system |
77 | 4 error err die |
108 | 4 error err die non-urgent program errors, a bug |
78 | 5 warn warning |
109 | 5 warn warning possible problem, not necessarily error |
79 | 6 note notice |
110 | 6 note notice unusual conditions |
80 | 7 info |
111 | 7 info normal messages, no action required |
81 | 8 debug |
112 | 8 debug debugging messages for development |
82 | 9 trace |
113 | 9 trace copious tracing output |
83 | |
114 | |
84 | As you can see, some logging levels have multiple aliases - the first one |
115 | 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) |
116 | 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 |
117 | and the third one the "perl" name, suggesting (only!) that you log C<die> |
87 | at C<error> priority. |
118 | messages at C<error> priority. The NOTE column tries to provide some |
|
|
119 | rationale on how to chose a logging level. |
88 | |
120 | |
|
|
121 | As a rough guideline, levels 1..3 are primarily meant for users of the |
|
|
122 | program (admins, staff), and are the only ones logged to STDERR by |
|
|
123 | default. Levels 4..6 are meant for users and developers alike, while |
|
|
124 | levels 7..9 are usually meant for developers. |
|
|
125 | |
89 | You can normally only log a single message at highest priority level |
126 | You can normally only log a message once at highest priority level (C<1>, |
90 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
127 | C<fatal>), because logging a fatal message will also quit the program - so |
91 | program - so use it sparingly :) |
128 | use it sparingly :) |
|
|
129 | |
|
|
130 | For example, a program that finds an unknown switch on the commandline |
|
|
131 | might well use a fatal logging level to tell users about it - the "system" |
|
|
132 | in this case would be the program, or module. |
92 | |
133 | |
93 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
134 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
94 | or C<all> - these are only valid in the methods they are documented for. |
135 | or C<all> - these are only valid for the methods that document them. |
95 | |
136 | |
96 | =head1 LOGGING FUNCTIONS |
137 | =head1 LOGGING FUNCTIONS |
97 | |
138 | |
98 | These functions allow you to log messages. They always use the caller's |
139 | The following functions allow you to log messages. They always use the |
99 | package as a "logging context". Also, the main logging function C<log> is |
140 | caller's package as a "logging context". Also, the main logging function, |
100 | callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is |
141 | C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent> |
101 | loaded. |
142 | module is loaded. |
102 | |
143 | |
103 | =over 4 |
144 | =over 4 |
104 | |
145 | |
105 | =cut |
146 | =cut |
106 | |
147 | |
107 | package AnyEvent::Log; |
148 | package AnyEvent::Log; |
108 | |
149 | |
109 | use Carp (); |
150 | use Carp (); |
110 | use POSIX (); |
151 | use POSIX (); |
111 | |
152 | |
|
|
153 | # layout of a context |
|
|
154 | # 0 1 2 3 4, 5 |
|
|
155 | # [$title, $level, %$slaves, &$logcb, &$fmtcb, $cap] |
|
|
156 | |
112 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
157 | use AnyEvent (); BEGIN { AnyEvent::common_sense } |
113 | use AnyEvent::Util (); |
158 | #use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log |
114 | |
159 | |
115 | our $VERSION = $AnyEvent::VERSION; |
160 | our $VERSION = $AnyEvent::VERSION; |
116 | |
161 | |
117 | our ($COLLECT, $FILTER, $LOG); |
162 | our ($COLLECT, $FILTER, $LOG); |
118 | |
163 | |
119 | our ($now_int, $now_str1, $now_str2); |
164 | our ($now_int, $now_str1, $now_str2); |
120 | |
165 | |
121 | # Format Time, not public - yet? |
166 | # Format Time, not public - yet? |
122 | sub ft($) { |
167 | sub format_time($) { |
123 | my $i = int $_[0]; |
168 | my $i = int $_[0]; |
124 | my $f = sprintf "%06d", 1e6 * ($_[0] - $i); |
169 | my $f = sprintf "%06d", 1e6 * ($_[0] - $i); |
125 | |
170 | |
126 | ($now_int, $now_str1, $now_str2) = ($i, split /\x01/, POSIX::strftime "%Y-%m-%d %H:%M:%S.\x01 %z", localtime $i) |
171 | ($now_int, $now_str1, $now_str2) = ($i, split /\x01/, POSIX::strftime "%Y-%m-%d %H:%M:%S.\x01 %z", localtime $i) |
127 | if $now_int != $i; |
172 | if $now_int != $i; |
… | |
… | |
148 | =item AnyEvent::Log::log $level, $msg[, @args] |
193 | =item AnyEvent::Log::log $level, $msg[, @args] |
149 | |
194 | |
150 | Requests logging of the given C<$msg> with the given log level, and |
195 | Requests logging of the given C<$msg> with the given log level, and |
151 | returns true if the message was logged I<somewhere>. |
196 | returns true if the message was logged I<somewhere>. |
152 | |
197 | |
153 | For C<fatal> log levels, the program will abort. |
198 | For loglevel C<fatal>, the program will abort. |
154 | |
199 | |
155 | If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the |
200 | 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. |
201 | C<$msg> is interpreted as an sprintf format string. |
157 | |
202 | |
158 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
203 | The C<$msg> should not end with C<\n>, but may if that is convenient for |
… | |
… | |
160 | |
205 | |
161 | Last not least, C<$msg> might be a code reference, in which case it is |
206 | Last not least, C<$msg> might be a code reference, in which case it is |
162 | supposed to return the message. It will be called only then the message |
207 | supposed to return the message. It will be called only then the message |
163 | actually gets logged, which is useful if it is costly to create the |
208 | actually gets logged, which is useful if it is costly to create the |
164 | message in the first place. |
209 | message in the first place. |
|
|
210 | |
|
|
211 | This function takes care of saving and restoring C<$!> and C<$@>, so you |
|
|
212 | don't have to. |
165 | |
213 | |
166 | Whether the given message will be logged depends on the maximum log level |
214 | Whether the given message will be logged depends on the maximum log level |
167 | and the caller's package. The return value can be used to ensure that |
215 | 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 |
216 | 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 |
217 | runtime error it tries to log it at C<die> level, but if that message is |
… | |
… | |
203 | info => 7, |
251 | info => 7, |
204 | debug => 8, |
252 | debug => 8, |
205 | trace => 9, |
253 | trace => 9, |
206 | ); |
254 | ); |
207 | |
255 | |
208 | sub now () { time } |
256 | our $TIME_EXACT; |
|
|
257 | |
|
|
258 | sub exact_time($) { |
|
|
259 | $TIME_EXACT = shift; |
|
|
260 | *_ts = $AnyEvent::MODEL |
|
|
261 | ? $TIME_EXACT ? \&AE::now : \&AE::time |
|
|
262 | : sub () { $TIME_EXACT ? do { require Time::HiRes; Time::HiRes::time () } : time }; |
|
|
263 | } |
|
|
264 | |
|
|
265 | BEGIN { |
|
|
266 | exact_time 0; |
|
|
267 | } |
209 | |
268 | |
210 | AnyEvent::post_detect { |
269 | AnyEvent::post_detect { |
211 | *now = \&AE::now; |
270 | exact_time $TIME_EXACT; |
212 | }; |
271 | }; |
213 | |
272 | |
214 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
273 | our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); |
215 | |
274 | |
216 | # time, ctx, level, msg |
275 | # time, ctx, level, msg |
217 | sub _format($$$$) { |
276 | sub default_format($$$$) { |
218 | my $ts = ft $_[0]; |
277 | my $ts = format_time $_[0]; |
219 | my $ct = " "; |
278 | my $ct = " "; |
220 | |
279 | |
221 | my @res; |
280 | my @res; |
222 | |
281 | |
223 | for (split /\n/, sprintf "%-5s %s: %s", $LEVEL2STR[$_[2]], $_[1][0], $_[3]) { |
282 | for (split /\n/, sprintf "%-5s %s: %s", $LEVEL2STR[$_[2]], $_[1][0], $_[3]) { |
… | |
… | |
226 | } |
285 | } |
227 | |
286 | |
228 | join "", @res |
287 | join "", @res |
229 | } |
288 | } |
230 | |
289 | |
|
|
290 | sub fatal_exit() { |
|
|
291 | exit 1; |
|
|
292 | } |
|
|
293 | |
231 | sub _log { |
294 | sub _log { |
232 | my ($ctx, $level, $format, @args) = @_; |
295 | my ($ctx, $level, $format, @args) = @_; |
233 | |
296 | |
234 | $level = $level > 0 && $level <= 9 |
297 | $level = $level > 0 && $level <= 9 |
235 | ? $level+0 |
298 | ? $level+0 |
236 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
299 | : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; |
237 | |
300 | |
238 | my $mask = 1 << $level; |
301 | my $mask = 1 << $level; |
239 | |
302 | |
240 | my ($success, %seen, @ctx, $now, $fmt); |
303 | my ($success, %seen, @ctx, $now, @fmt); |
241 | |
304 | |
242 | do |
305 | do |
243 | { |
306 | { |
244 | # skip if masked |
307 | # if !ref, then it's a level number |
|
|
308 | if (!ref $ctx) { |
|
|
309 | $level = $ctx; |
245 | if ($ctx->[1] & $mask && !$seen{$ctx+0}++) { |
310 | } elsif ($ctx->[1] & $mask and !$seen{$ctx+0}++) { |
|
|
311 | # logging/recursing into this context |
|
|
312 | |
|
|
313 | # level cap |
|
|
314 | if ($ctx->[5] > $level) { |
|
|
315 | push @ctx, $level; # restore level when going up in tree |
|
|
316 | $level = $ctx->[5]; |
|
|
317 | } |
|
|
318 | |
|
|
319 | # log if log cb |
246 | if ($ctx->[3]) { |
320 | if ($ctx->[3]) { |
247 | # logging target found |
321 | # logging target found |
|
|
322 | |
|
|
323 | local ($!, $@); |
248 | |
324 | |
249 | # now get raw message, unless we have it already |
325 | # now get raw message, unless we have it already |
250 | unless ($now) { |
326 | unless ($now) { |
251 | $format = $format->() if ref $format; |
327 | $format = $format->() if ref $format; |
252 | $format = sprintf $format, @args if @args; |
328 | $format = sprintf $format, @args if @args; |
253 | $format =~ s/\n$//; |
329 | $format =~ s/\n$//; |
254 | $now = AE::now; |
330 | $now = _ts; |
255 | }; |
331 | }; |
256 | |
332 | |
257 | # format msg |
333 | # format msg |
258 | my $str = $ctx->[4] |
334 | my $str = $ctx->[4] |
259 | ? $ctx->[4]($now, $_[0], $level, $format) |
335 | ? $ctx->[4]($now, $_[0], $level, $format) |
260 | : ($fmt ||= _format $now, $_[0], $level, $format); |
336 | : ($fmt[$level] ||= default_format $now, $_[0], $level, $format); |
261 | |
337 | |
262 | $success = 1; |
338 | $success = 1; |
263 | |
339 | |
264 | $ctx->[3]($str) |
340 | $ctx->[3]($str) |
265 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
341 | or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate |
… | |
… | |
268 | } |
344 | } |
269 | } |
345 | } |
270 | } |
346 | } |
271 | while $ctx = pop @ctx; |
347 | while $ctx = pop @ctx; |
272 | |
348 | |
273 | exit 1 if $level <= 1; |
349 | fatal_exit if $level <= 1; |
274 | |
350 | |
275 | $success |
351 | $success |
276 | } |
352 | } |
277 | |
353 | |
278 | sub log($$;@) { |
354 | sub log($$;@) { |
279 | _log |
355 | _log |
280 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
356 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
281 | @_; |
357 | @_; |
282 | } |
358 | } |
283 | |
359 | |
284 | *AnyEvent::log = *AE::log = \&log; |
|
|
285 | |
|
|
286 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
360 | =item $logger = AnyEvent::Log::logger $level[, \$enabled] |
287 | |
361 | |
288 | Creates a code reference that, when called, acts as if the |
362 | 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 |
363 | 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 |
364 | level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with |
… | |
… | |
354 | |
428 | |
355 | $LOGGER{$logger+0} = $logger; |
429 | $LOGGER{$logger+0} = $logger; |
356 | |
430 | |
357 | _reassess $logger+0; |
431 | _reassess $logger+0; |
358 | |
432 | |
|
|
433 | require AnyEvent::Util unless $AnyEvent::Util::VERSION; |
359 | my $guard = AnyEvent::Util::guard { |
434 | my $guard = AnyEvent::Util::guard (sub { |
360 | # "clean up" |
435 | # "clean up" |
361 | delete $LOGGER{$logger+0}; |
436 | delete $LOGGER{$logger+0}; |
362 | }; |
437 | }); |
363 | |
438 | |
364 | sub { |
439 | sub { |
365 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
440 | $guard if 0; # keep guard alive, but don't cause runtime overhead |
366 | |
441 | |
367 | _log $ctx, $level, @_ |
442 | _log $ctx, $level, @_ |
… | |
… | |
372 | sub logger($;$) { |
447 | sub logger($;$) { |
373 | _logger |
448 | _logger |
374 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
449 | $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], |
375 | @_ |
450 | @_ |
376 | } |
451 | } |
|
|
452 | |
|
|
453 | =item AnyEvent::Log::exact_time $on |
|
|
454 | |
|
|
455 | By default, C<AnyEvent::Log> will use C<AE::now>, i.e. the cached |
|
|
456 | eventloop time, for the log timestamps. After calling this function with a |
|
|
457 | true value it will instead resort to C<AE::time>, i.e. fetch the current |
|
|
458 | time on each log message. This only makes a difference for event loops |
|
|
459 | that actually cache the time (such as L<EV> or L<AnyEvent::Loop>). |
|
|
460 | |
|
|
461 | This setting can be changed at any time by calling this function. |
|
|
462 | |
|
|
463 | Since C<AnyEvent::Log> has to work even before L<AnyEvent> has been |
|
|
464 | initialised, this switch will also decide whether to use C<CORE::time> or |
|
|
465 | C<Time::HiRes::time> when logging a message before L<AnyEvent> becomes |
|
|
466 | available. |
|
|
467 | |
|
|
468 | =item AnyEvent::Log::format_time $timestamp |
|
|
469 | |
|
|
470 | Formats a timestamp as returned by C<< AnyEvent->now >> or C<< |
|
|
471 | AnyEvent->time >> or many other functions in the same way as |
|
|
472 | C<AnyEvent::Log> does. |
|
|
473 | |
|
|
474 | In your main program (as opposed to in your module) you can override |
|
|
475 | the default timestamp display format by loading this module and then |
|
|
476 | redefining this function. |
|
|
477 | |
|
|
478 | Most commonly, this function can be used in formatting callbacks. |
|
|
479 | |
|
|
480 | =item AnyEvent::Log::default_format $time, $ctx, $level, $msg |
|
|
481 | |
|
|
482 | Format a log message using the given timestamp, logging context, log level |
|
|
483 | and log message. |
|
|
484 | |
|
|
485 | This is the formatting function used to format messages when no custom |
|
|
486 | function is provided. |
|
|
487 | |
|
|
488 | In your main program (as opposed to in your module) you can override the |
|
|
489 | default message format by loading this module and then redefining this |
|
|
490 | function. |
|
|
491 | |
|
|
492 | =item AnyEvent::Log::fatal_exit() |
|
|
493 | |
|
|
494 | This is the function that is called after logging a C<fatal> log |
|
|
495 | message. It must not return. |
|
|
496 | |
|
|
497 | The default implementation simply calls C<exit 1>. |
|
|
498 | |
|
|
499 | In your main program (as opposed to in your module) you can override |
|
|
500 | the fatal exit function by loading this module and then redefining this |
|
|
501 | function. Make sure you don't return. |
377 | |
502 | |
378 | =back |
503 | =back |
379 | |
504 | |
380 | =head1 LOGGING CONTEXTS |
505 | =head1 LOGGING CONTEXTS |
381 | |
506 | |
… | |
… | |
405 | context, so it does not matter (much) if there are cycles or if the |
530 | context, so it does not matter (much) if there are cycles or if the |
406 | message can arrive at the same context via multiple paths. |
531 | message can arrive at the same context via multiple paths. |
407 | |
532 | |
408 | =head2 DEFAULTS |
533 | =head2 DEFAULTS |
409 | |
534 | |
410 | By default, all logging contexts have an full set of log levels ("all"), a |
535 | By default, all logging contexts have a full set of log levels ("all"), a |
411 | disabled logging callback and the default formatting callback. |
536 | disabled logging callback and the default formatting callback. |
412 | |
537 | |
413 | Package contexts have the package name as logging title by default. |
538 | Package contexts have the package name as logging title by default. |
414 | |
539 | |
415 | They have exactly one slave - the context of the "parent" package. The |
540 | They have exactly one slave - the context of the "parent" package. The |
… | |
… | |
469 | |
594 | |
470 | =item $ctx = AnyEvent::Log::ctx [$pkg] |
595 | =item $ctx = AnyEvent::Log::ctx [$pkg] |
471 | |
596 | |
472 | This function creates or returns a logging context (which is an object). |
597 | This function creates or returns a logging context (which is an object). |
473 | |
598 | |
474 | If a package name is given, then the context for that packlage is |
599 | If a package name is given, then the context for that package is |
475 | returned. If it is called without any arguments, then the context for the |
600 | returned. If it is called without any arguments, then the context for the |
476 | callers package is returned (i.e. the same context as a C<AE::log> call |
601 | callers package is returned (i.e. the same context as a C<AE::log> call |
477 | would use). |
602 | would use). |
478 | |
603 | |
479 | If C<undef> is given, then it creates a new anonymous context that is not |
604 | If C<undef> is given, then it creates a new anonymous context that is not |
… | |
… | |
501 | This can be used to implement config-file (re-)loading: before loading a |
626 | This can be used to implement config-file (re-)loading: before loading a |
502 | configuration, reset all contexts. |
627 | configuration, reset all contexts. |
503 | |
628 | |
504 | =cut |
629 | =cut |
505 | |
630 | |
|
|
631 | our $ORIG_VERBOSE = $AnyEvent::VERBOSE; |
|
|
632 | $AnyEvent::VERBOSE = 9; |
|
|
633 | |
506 | sub reset { |
634 | sub reset { |
507 | # hard to kill complex data structures |
635 | # hard to kill complex data structures |
508 | # we "recreate" all package loggers and reset the hierarchy |
636 | # we "recreate" all package loggers and reset the hierarchy |
509 | while (my ($k, $v) = each %CTX) { |
637 | while (my ($k, $v) = each %CTX) { |
510 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
638 | @$v = ($k, (1 << 10) - 1 - 1, { }); |
… | |
… | |
513 | } |
641 | } |
514 | |
642 | |
515 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
643 | @$_ = ($_->[0], (1 << 10) - 1 - 1) |
516 | for $LOG, $FILTER, $COLLECT; |
644 | for $LOG, $FILTER, $COLLECT; |
517 | |
645 | |
518 | $LOG->slaves; |
646 | #$LOG->slaves; |
519 | $LOG->title ('$AnyEvent::Log::LOG'); |
647 | $LOG->title ('$AnyEvent::Log::LOG'); |
520 | $LOG->log_to_warn; |
648 | $LOG->log_to_warn; |
521 | |
649 | |
522 | $FILTER->slaves ($LOG); |
650 | $FILTER->slaves ($LOG); |
523 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
651 | $FILTER->title ('$AnyEvent::Log::FILTER'); |
524 | $FILTER->level ($AnyEvent::VERBOSE); |
652 | $FILTER->level ($ORIG_VERBOSE); |
525 | |
653 | |
526 | $COLLECT->slaves ($FILTER); |
654 | $COLLECT->slaves ($FILTER); |
527 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
655 | $COLLECT->title ('$AnyEvent::Log::COLLECT'); |
528 | |
656 | |
529 | _reassess; |
657 | _reassess; |
530 | } |
658 | } |
|
|
659 | |
|
|
660 | # override AE::log/logger |
|
|
661 | *AnyEvent::log = *AE::log = \&log; |
|
|
662 | *AnyEvent::logger = *AE::logger = \&logger; |
|
|
663 | |
|
|
664 | # convert AnyEvent loggers to AnyEvent::Log loggers |
|
|
665 | $_->[0] = ctx $_->[0] # convert "pkg" to "ctx" |
|
|
666 | for values %LOGGER; |
531 | |
667 | |
532 | # create the default logger contexts |
668 | # create the default logger contexts |
533 | $LOG = ctx undef; |
669 | $LOG = ctx undef; |
534 | $FILTER = ctx undef; |
670 | $FILTER = ctx undef; |
535 | $COLLECT = ctx undef; |
671 | $COLLECT = ctx undef; |
… | |
… | |
544 | package AnyEvent::Log::COLLECT; |
680 | package AnyEvent::Log::COLLECT; |
545 | package AE::Log::COLLECT; |
681 | package AE::Log::COLLECT; |
546 | |
682 | |
547 | package AnyEvent::Log::Ctx; |
683 | package AnyEvent::Log::Ctx; |
548 | |
684 | |
549 | # 0 1 2 3 4 |
|
|
550 | # [$title, $level, %$slaves, &$logcb, &$fmtcb] |
|
|
551 | |
|
|
552 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
685 | =item $ctx = new AnyEvent::Log::Ctx methodname => param... |
553 | |
686 | |
554 | This is a convenience constructor that makes it simpler to construct |
687 | This is a convenience constructor that makes it simpler to construct |
555 | anonymous logging contexts. |
688 | anonymous logging contexts. |
556 | |
689 | |
… | |
… | |
643 | |
776 | |
644 | =item $ctx->disable ($level[, $level...]) |
777 | =item $ctx->disable ($level[, $level...]) |
645 | |
778 | |
646 | Disables logging for the given levels, leaving all others unchanged. |
779 | Disables logging for the given levels, leaving all others unchanged. |
647 | |
780 | |
|
|
781 | =item $ctx->cap ($level) |
|
|
782 | |
|
|
783 | Caps the maximum priority to the given level, for all messages logged |
|
|
784 | to, or passing through, this context. That is, while this doesn't affect |
|
|
785 | whether a message is logged or passed on, the maximum priority of messages |
|
|
786 | will be limited to the specified level - messages with a higher priority |
|
|
787 | will be set to the specified priority. |
|
|
788 | |
|
|
789 | Another way to view this is that C<< ->level >> filters out messages with |
|
|
790 | a too low priority, while C<< ->cap >> modifies messages with a too high |
|
|
791 | priority. |
|
|
792 | |
|
|
793 | This is useful when different log targets have different interpretations |
|
|
794 | of priority. For example, for a specific command line program, a wrong |
|
|
795 | command line switch might well result in a C<fatal> log message, while the |
|
|
796 | same message, logged to syslog, is likely I<not> fatal to the system or |
|
|
797 | syslog facility as a whole, but more likely a mere C<error>. |
|
|
798 | |
|
|
799 | This can be modeled by having a stderr logger that logs messages "as-is" |
|
|
800 | and a syslog logger that logs messages with a level cap of, say, C<error>, |
|
|
801 | or, for truly system-critical components, actually C<critical>. |
|
|
802 | |
648 | =cut |
803 | =cut |
649 | |
804 | |
650 | sub _lvl_lst { |
805 | sub _lvl_lst { |
651 | map { |
806 | map { |
652 | $_ > 0 && $_ <= 9 ? $_+0 |
807 | $_ > 0 && $_ <= 9 ? $_+0 |
653 | : $_ eq "all" ? (1 .. 9) |
808 | : $_ eq "all" ? (1 .. 9) |
654 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
809 | : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" |
655 | } @_ |
810 | } @_ |
656 | } |
811 | } |
657 | |
812 | |
|
|
813 | sub _lvl { |
|
|
814 | $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1] |
|
|
815 | } |
|
|
816 | |
658 | our $NOP_CB = sub { 0 }; |
817 | our $NOP_CB = sub { 0 }; |
659 | |
818 | |
660 | sub levels { |
819 | sub levels { |
661 | my $ctx = shift; |
820 | my $ctx = shift; |
662 | $ctx->[1] = 0; |
821 | $ctx->[1] = 0; |
… | |
… | |
665 | AnyEvent::Log::_reassess; |
824 | AnyEvent::Log::_reassess; |
666 | } |
825 | } |
667 | |
826 | |
668 | sub level { |
827 | sub level { |
669 | my $ctx = shift; |
828 | my $ctx = shift; |
670 | my $lvl = $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1]; |
|
|
671 | |
|
|
672 | $ctx->[1] = ((1 << $lvl) - 1) << 1; |
829 | $ctx->[1] = ((1 << &_lvl) - 1) << 1; |
673 | AnyEvent::Log::_reassess; |
830 | AnyEvent::Log::_reassess; |
674 | } |
831 | } |
675 | |
832 | |
676 | sub enable { |
833 | sub enable { |
677 | my $ctx = shift; |
834 | my $ctx = shift; |
… | |
… | |
685 | $ctx->[1] &= ~(1 << $_) |
842 | $ctx->[1] &= ~(1 << $_) |
686 | for &_lvl_lst; |
843 | for &_lvl_lst; |
687 | AnyEvent::Log::_reassess; |
844 | AnyEvent::Log::_reassess; |
688 | } |
845 | } |
689 | |
846 | |
|
|
847 | sub cap { |
|
|
848 | my $ctx = shift; |
|
|
849 | $ctx->[5] = &_lvl; |
|
|
850 | } |
|
|
851 | |
690 | =back |
852 | =back |
691 | |
853 | |
692 | =head3 SLAVE CONTEXTS |
854 | =head3 SLAVE CONTEXTS |
693 | |
855 | |
694 | The following methods attach and detach another logging context to a |
856 | The following methods attach and detach another logging context to a |
… | |
… | |
722 | sub attach { |
884 | sub attach { |
723 | my $ctx = shift; |
885 | my $ctx = shift; |
724 | |
886 | |
725 | $ctx->[2]{$_+0} = $_ |
887 | $ctx->[2]{$_+0} = $_ |
726 | for map { AnyEvent::Log::ctx $_ } @_; |
888 | for map { AnyEvent::Log::ctx $_ } @_; |
|
|
889 | AnyEvent::Log::_reassess; |
727 | } |
890 | } |
728 | |
891 | |
729 | sub detach { |
892 | sub detach { |
730 | my $ctx = shift; |
893 | my $ctx = shift; |
731 | |
894 | |
732 | delete $ctx->[2]{$_+0} |
895 | delete $ctx->[2]{$_+0} |
733 | for map { AnyEvent::Log::ctx $_ } @_; |
896 | for map { AnyEvent::Log::ctx $_ } @_; |
|
|
897 | AnyEvent::Log::_reassess; |
734 | } |
898 | } |
735 | |
899 | |
736 | sub slaves { |
900 | sub slaves { |
737 | undef $_[0][2]; |
901 | undef $_[0][2]; |
738 | &attach; |
902 | &attach; |
|
|
903 | AnyEvent::Log::_reassess; |
739 | } |
904 | } |
740 | |
905 | |
741 | =back |
906 | =back |
742 | |
907 | |
743 | =head3 LOG TARGETS |
908 | =head3 LOG TARGETS |
… | |
… | |
746 | the logging (which consists of formatting the message and printing it or |
911 | the logging (which consists of formatting the message and printing it or |
747 | whatever it wants to do with it). |
912 | whatever it wants to do with it). |
748 | |
913 | |
749 | =over 4 |
914 | =over 4 |
750 | |
915 | |
751 | =item $ctx->log_cb ($cb->($str) |
916 | =item $ctx->log_cb ($cb->($str)) |
752 | |
917 | |
753 | Replaces the logging callback on the context (C<undef> disables the |
918 | Replaces the logging callback on the context (C<undef> disables the |
754 | logging callback). |
919 | logging callback). |
755 | |
920 | |
756 | The logging callback is responsible for handling formatted log messages |
921 | The logging callback is responsible for handling formatted log messages |
… | |
… | |
781 | |
946 | |
782 | Replaces the formatting callback on the context (C<undef> restores the |
947 | Replaces the formatting callback on the context (C<undef> restores the |
783 | default formatter). |
948 | default formatter). |
784 | |
949 | |
785 | The callback is passed the (possibly fractional) timestamp, the original |
950 | The callback is passed the (possibly fractional) timestamp, the original |
786 | logging context, the (numeric) logging level and the raw message string |
951 | logging context (object, not title), the (numeric) logging level and |
787 | and needs to return a formatted log message. In most cases this will be a |
952 | the raw message string and needs to return a formatted log message. In |
788 | string, but it could just as well be an array reference that just stores |
953 | most cases this will be a string, but it could just as well be an array |
789 | the values. |
954 | reference that just stores the values. |
790 | |
955 | |
791 | If, for some reason, you want to use C<caller> to find out more baout the |
956 | If, for some reason, you want to use C<caller> to find out more about the |
792 | logger then you should walk up the call stack until you are no longer |
957 | logger then you should walk up the call stack until you are no longer |
793 | inside the C<AnyEvent::Log> package. |
958 | inside the C<AnyEvent::Log> package. |
794 | |
959 | |
|
|
960 | To implement your own logging callback, you might find the |
|
|
961 | C<AnyEvent::Log::format_time> and C<AnyEvent::Log::default_format> |
|
|
962 | functions useful. |
|
|
963 | |
|
|
964 | Example: format the message just as AnyEvent::Log would, by letting |
|
|
965 | AnyEvent::Log do the work. This is a good basis to design a formatting |
|
|
966 | callback that only changes minor aspects of the formatting. |
|
|
967 | |
|
|
968 | $ctx->fmt_cb (sub { |
|
|
969 | my ($time, $ctx, $lvl, $msg) = @_; |
|
|
970 | |
|
|
971 | AnyEvent::Log::default_format $time, $ctx, $lvl, $msg |
|
|
972 | }); |
|
|
973 | |
795 | Example: format just the raw message, with numeric log level in angle |
974 | Example: format just the raw message, with numeric log level in angle |
796 | brackets. |
975 | brackets. |
797 | |
976 | |
798 | $ctx->fmt_cb (sub { |
977 | $ctx->fmt_cb (sub { |
799 | my ($time, $ctx, $lvl, $msg) = @_; |
978 | my ($time, $ctx, $lvl, $msg) = @_; |
800 | |
979 | |
801 | "<$lvl>$msg\n" |
980 | "<$lvl>$msg\n" |
802 | }); |
981 | }); |
803 | |
982 | |
804 | Example: return an array reference with just the log values, and use |
983 | Example: return an array reference with just the log values, and use |
805 | C<PApp::SQL::sql_exec> to store the emssage in a database. |
984 | C<PApp::SQL::sql_exec> to store the message in a database. |
806 | |
985 | |
807 | $ctx->fmt_cb (sub { \@_ }); |
986 | $ctx->fmt_cb (sub { \@_ }); |
808 | $ctx->log_cb (sub { |
987 | $ctx->log_cb (sub { |
809 | my ($msg) = @_; |
988 | my ($msg) = @_; |
810 | |
989 | |
… | |
… | |
822 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
1001 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
823 | (usually this logs to STDERR). |
1002 | (usually this logs to STDERR). |
824 | |
1003 | |
825 | =item $ctx->log_to_file ($path) |
1004 | =item $ctx->log_to_file ($path) |
826 | |
1005 | |
827 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
1006 | Sets the C<log_cb> to log to a file (by appending), unbuffered. The |
|
|
1007 | function might return before the log file has been opened or created. |
828 | |
1008 | |
829 | =item $ctx->log_to_path ($path) |
1009 | =item $ctx->log_to_path ($path) |
830 | |
1010 | |
831 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
1011 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
832 | is much slower, but allows you to change/move/rename/delete the file at |
1012 | is much slower, but allows you to change/move/rename/delete the file at |
… | |
… | |
834 | |
1014 | |
835 | Needless(?) to say, if you do not want to be bitten by some evil person |
1015 | 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 |
1016 | calling C<chdir>, the path should be absolute. Doesn't help with |
837 | C<chroot>, but hey... |
1017 | C<chroot>, but hey... |
838 | |
1018 | |
839 | =item $ctx->log_to_syslog ([$log_flags]) |
1019 | =item $ctx->log_to_syslog ([$facility]) |
840 | |
1020 | |
841 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all |
1021 | Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and |
842 | the others in the obvious way. If specified, then the C<$log_flags> are |
1022 | all the others in the obvious way. If specified, then the C<$facility> is |
843 | simply or'ed onto the priority argument and can contain any C<LOG_xxx> |
1023 | used as the facility (C<user>, C<auth>, C<local0> and so on). The default |
844 | flags valid for Sys::Syslog::syslog, except for the priority levels. |
1024 | facility is C<user>. |
845 | |
1025 | |
846 | Note that this function also sets a C<fmt_cb> - the logging part requires |
1026 | Note that this function also sets a C<fmt_cb> - the logging part requires |
847 | an array reference with [$level, $str] as input. |
1027 | an array reference with [$level, $str] as input. |
848 | |
1028 | |
849 | =cut |
1029 | =cut |
… | |
… | |
867 | warn shift; |
1047 | warn shift; |
868 | 0 |
1048 | 0 |
869 | }); |
1049 | }); |
870 | } |
1050 | } |
871 | |
1051 | |
|
|
1052 | # this function is a good example of why threads are a must, |
|
|
1053 | # simply for priority inversion. |
|
|
1054 | sub _log_to_disk { |
|
|
1055 | # eval'uating this at runtime saves 220kb rss - perl has become |
|
|
1056 | # an insane memory waster. |
|
|
1057 | eval q{ # poor man's autoloading {} |
|
|
1058 | sub _log_to_disk { |
|
|
1059 | my ($ctx, $path, $keepopen) = @_; |
|
|
1060 | |
|
|
1061 | my $fh; |
|
|
1062 | my @queue; |
|
|
1063 | my $delay; |
|
|
1064 | my $disable; |
|
|
1065 | |
|
|
1066 | use AnyEvent::IO (); |
|
|
1067 | |
|
|
1068 | my $kick = sub { |
|
|
1069 | undef $delay; |
|
|
1070 | return unless @queue; |
|
|
1071 | $delay = 1; |
|
|
1072 | |
|
|
1073 | # we pass $kick to $kick, so $kick itself doesn't keep a reference to $kick. |
|
|
1074 | my $kick = shift; |
|
|
1075 | |
|
|
1076 | # write one or more messages |
|
|
1077 | my $write = sub { |
|
|
1078 | # we write as many messages as have been queued |
|
|
1079 | my $data = join "", @queue; |
|
|
1080 | @queue = (); |
|
|
1081 | |
|
|
1082 | AnyEvent::IO::aio_write $fh, $data, sub { |
|
|
1083 | $disable = 1; |
|
|
1084 | @_ |
|
|
1085 | ? ($_[0] == length $data or AE::log 4 => "unable to write to logfile '$path': short write") |
|
|
1086 | : AE::log 4 => "unable to write to logfile '$path': $!"; |
|
|
1087 | undef $disable; |
|
|
1088 | |
|
|
1089 | if ($keepopen) { |
|
|
1090 | $kick->($kick); |
|
|
1091 | } else { |
|
|
1092 | AnyEvent::IO::aio_close ($fh, sub { |
|
|
1093 | undef $fh; |
|
|
1094 | $kick->($kick); |
|
|
1095 | }); |
|
|
1096 | } |
|
|
1097 | }; |
|
|
1098 | }; |
|
|
1099 | |
|
|
1100 | if ($fh) { |
|
|
1101 | $write->(); |
|
|
1102 | } else { |
|
|
1103 | AnyEvent::IO::aio_open |
|
|
1104 | $path, |
|
|
1105 | AnyEvent::IO::O_CREAT | AnyEvent::IO::O_WRONLY | AnyEvent::IO::O_APPEND, |
|
|
1106 | 0666, |
|
|
1107 | sub { |
|
|
1108 | $fh = shift |
|
|
1109 | or do { |
|
|
1110 | $disable = 1; |
|
|
1111 | AE::log 4 => "unable to open logfile '$path': $!"; |
|
|
1112 | undef $disable; |
|
|
1113 | return; |
|
|
1114 | }; |
|
|
1115 | |
|
|
1116 | $write->(); |
|
|
1117 | } |
|
|
1118 | ; |
|
|
1119 | } |
|
|
1120 | }; |
|
|
1121 | |
|
|
1122 | $ctx->log_cb (sub { |
|
|
1123 | return if $disable; |
|
|
1124 | push @queue, shift; |
|
|
1125 | $kick->($kick) unless $delay; |
|
|
1126 | 0 |
|
|
1127 | }); |
|
|
1128 | |
|
|
1129 | $kick->($kick) if $keepopen; # initial open |
|
|
1130 | }; |
|
|
1131 | }; |
|
|
1132 | die if $@; |
|
|
1133 | &_log_to_disk |
|
|
1134 | } |
|
|
1135 | |
872 | sub log_to_file { |
1136 | sub log_to_file { |
873 | my ($ctx, $path) = @_; |
1137 | my ($ctx, $path) = @_; |
874 | |
1138 | |
875 | open my $fh, ">>", $path |
1139 | _log_to_disk $ctx, $path, 1; |
876 | or die "$path: $!"; |
|
|
877 | |
|
|
878 | $ctx->log_cb (sub { |
|
|
879 | syswrite $fh, shift; |
|
|
880 | 0 |
|
|
881 | }); |
|
|
882 | } |
1140 | } |
883 | |
1141 | |
884 | sub log_to_path { |
1142 | sub log_to_path { |
885 | my ($ctx, $path) = @_; |
1143 | my ($ctx, $path) = @_; |
886 | |
1144 | |
887 | $ctx->log_cb (sub { |
1145 | _log_to_disk $ctx, $path, 0; |
888 | open my $fh, ">>", $path |
|
|
889 | or die "$path: $!"; |
|
|
890 | |
|
|
891 | syswrite $fh, shift; |
|
|
892 | 0 |
|
|
893 | }); |
|
|
894 | } |
1146 | } |
895 | |
1147 | |
896 | sub log_to_syslog { |
1148 | sub log_to_syslog { |
897 | my ($ctx, $flags) = @_; |
1149 | my ($ctx, $facility) = @_; |
898 | |
1150 | |
899 | require Sys::Syslog; |
1151 | require Sys::Syslog; |
900 | |
1152 | |
901 | $ctx->fmt_cb (sub { |
1153 | $ctx->fmt_cb (sub { |
902 | my $str = $_[3]; |
1154 | my $str = $_[3]; |
903 | $str =~ s/\n(?=.)/\n+ /g; |
1155 | $str =~ s/\n(?=.)/\n+ /g; |
904 | |
1156 | |
905 | [$_[2], "($_[1][0]) $str"] |
1157 | [$_[2], "($_[1][0]) $str"] |
906 | }); |
1158 | }); |
907 | |
1159 | |
|
|
1160 | $facility ||= "user"; |
|
|
1161 | |
908 | $ctx->log_cb (sub { |
1162 | $ctx->log_cb (sub { |
909 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
1163 | my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; |
910 | |
1164 | |
911 | Sys::Syslog::syslog ($flags | ($lvl - 1), $_) |
1165 | Sys::Syslog::syslog ("$facility|" . ($lvl - 1), $_) |
912 | for split /\n/, $_[0][1]; |
1166 | for split /\n/, $_[0][1]; |
913 | |
1167 | |
914 | 0 |
1168 | 0 |
915 | }); |
1169 | }); |
916 | } |
1170 | } |
… | |
… | |
925 | =over 4 |
1179 | =over 4 |
926 | |
1180 | |
927 | =item $ctx->log ($level, $msg[, @params]) |
1181 | =item $ctx->log ($level, $msg[, @params]) |
928 | |
1182 | |
929 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
1183 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
|
|
1184 | |
|
|
1185 | Example: log a message in the context of another package. |
|
|
1186 | |
|
|
1187 | (AnyEvent::Log::ctx "Other::Package")->log (warn => "heely bo"); |
930 | |
1188 | |
931 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1189 | =item $logger = $ctx->logger ($level[, \$enabled]) |
932 | |
1190 | |
933 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1191 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
934 | context. |
1192 | context. |
… | |
… | |
982 | |
1240 | |
983 | Context names starting with a C<%> are anonymous contexts created when the |
1241 | 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 |
1242 | name is first mentioned. The difference to package contexts is that by |
985 | default they have no attached slaves. |
1243 | default they have no attached slaves. |
986 | |
1244 | |
|
|
1245 | This makes it possible to create new log contexts that can be refered to |
|
|
1246 | multiple times by name within the same log specification. |
|
|
1247 | |
987 | =item a perl package name |
1248 | =item a perl package name |
988 | |
1249 | |
989 | Any other string references the logging context associated with the given |
1250 | 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 |
1251 | 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 |
1252 | context that matches on of the other context name forms, you can add a |
… | |
… | |
1012 | Configures the context to log to a file with the given path. Works like |
1273 | Configures the context to log to a file with the given path. Works like |
1013 | C<log_to_path>. |
1274 | C<log_to_path>. |
1014 | |
1275 | |
1015 | =item C<syslog> or C<syslog=>I<expr> |
1276 | =item C<syslog> or C<syslog=>I<expr> |
1016 | |
1277 | |
1017 | Configured the context to log to syslog. If I<expr> is given, then it is |
1278 | 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: |
1279 | evaluated in the L<Sys::Syslog> package, so you could use: |
1019 | |
1280 | |
1020 | log=syslog=LOG_LOCAL0 |
1281 | log=syslog=LOG_LOCAL0 |
1021 | |
1282 | |
1022 | =item C<nolog> |
1283 | =item C<nolog> |
1023 | |
1284 | |
1024 | Configures the context to not log anything by itself, which is the |
1285 | Configures the context to not log anything by itself, which is the |
1025 | default. Same as C<< $ctx->log_cb (undef) >>. |
1286 | default. Same as C<< $ctx->log_cb (undef) >>. |
1026 | |
1287 | |
|
|
1288 | =item C<cap=>I<level> |
|
|
1289 | |
|
|
1290 | Caps logging messages entering this context at the given level, i.e. |
|
|
1291 | reduces the priority of messages with higher priority than this level. The |
|
|
1292 | default is C<0> (or C<off>), meaning the priority will not be touched. |
|
|
1293 | |
1027 | =item C<0> or C<off> |
1294 | =item C<0> or C<off> |
1028 | |
1295 | |
1029 | Sets the logging level of the context ot C<0>, i.e. all messages will be |
1296 | Sets the logging level of the context to C<0>, i.e. all messages will be |
1030 | filtered out. |
1297 | filtered out. |
1031 | |
1298 | |
1032 | =item C<all> |
1299 | =item C<all> |
1033 | |
1300 | |
1034 | Enables all logging levels, i.e. filtering will effectively be switched |
1301 | Enables all logging levels, i.e. filtering will effectively be switched |
… | |
… | |
1064 | filter=warn |
1331 | filter=warn |
1065 | |
1332 | |
1066 | # or, more verbose |
1333 | # or, more verbose |
1067 | filter=only,level,warn |
1334 | filter=only,level,warn |
1068 | |
1335 | |
1069 | =item C<1>..C<9>, a logging level name (C<error>, C<debug> etc.) |
1336 | =item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.) |
1070 | |
1337 | |
1071 | A numeric loglevel or the name of a loglevel will be interpreted according |
1338 | 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, |
1339 | 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. |
1340 | specifying a logging level enables that and any higher priority messages. |
1074 | |
1341 | |
1075 | =item C<+>I<context> |
1342 | =item C<+>I<context> |
1076 | |
1343 | |
1077 | Adds/attaches the named context as slave to the context. |
1344 | Attaches the named context as slave to the context. |
1078 | |
1345 | |
1079 | =item C<+> |
1346 | =item C<+> |
1080 | |
1347 | |
1081 | A line C<+> clears the slave list form the context. Anonymous (C<%name>) |
1348 | A lone 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 |
1349 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1083 | context as slave by default. |
1350 | but package contexts have the parent context as slave by default. |
1084 | |
1351 | |
1085 | Example: log messages from My::Module to a file, do not send them to the |
1352 | Example: log messages from My::Module to a file, do not send them to the |
1086 | default log collector. |
1353 | default log collector. |
1087 | |
1354 | |
1088 | My::Module=+,file=/tmp/mymodulelog |
1355 | My::Module=+,file=/tmp/mymodulelog |
1089 | |
1356 | |
1090 | =back |
1357 | =back |
1091 | |
1358 | |
|
|
1359 | Any character can be escaped by prefixing it with a C<\> (backslash), as |
|
|
1360 | usual, so to log to a file containing a comma, colon, backslash and some |
|
|
1361 | spaces in the filename, you would do this: |
|
|
1362 | |
|
|
1363 | PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' |
|
|
1364 | |
|
|
1365 | Since whitespace (which includes newlines) is allowed, it is fine to |
|
|
1366 | specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: |
|
|
1367 | |
|
|
1368 | PERL_ANYEVENT_LOG=" |
|
|
1369 | filter=warn |
|
|
1370 | AnyEvent::Debug=+%trace |
|
|
1371 | %trace=only,trace,+log |
|
|
1372 | " myprog |
|
|
1373 | |
|
|
1374 | Also, in the unlikely case when you want to concatenate specifications, |
|
|
1375 | use whitespace as separator, as C<::> will be interpreted as part of a |
|
|
1376 | module name, an empty spec with two separators: |
|
|
1377 | |
|
|
1378 | PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug" |
|
|
1379 | |
1092 | =cut |
1380 | =cut |
1093 | |
1381 | |
1094 | for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { |
1382 | for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { |
1095 | my %anon; |
1383 | my %anon; |
1096 | |
1384 | |
1097 | my $pkg = sub { |
1385 | my $pkg = sub { |
1098 | $_[0] eq "log" ? $LOG |
1386 | $_[0] eq "log" ? $LOG |
1099 | : $_[0] eq "filter" ? $FILTER |
1387 | : $_[0] eq "filter" ? $FILTER |
1100 | : $_[0] eq "collect" ? $COLLECT |
1388 | : $_[0] eq "collect" ? $COLLECT |
1101 | : $_[0] =~ /^%(.+)$/ && $anon{$1} ||= ctx undef |
1389 | : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= do { my $ctx = ctx undef; $ctx->[0] = $_[0]; $ctx }) |
1102 | : $_[0] =~ /^(.*?)(?:::)?$/ && ctx "$1" # egad :/ |
1390 | : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ |
|
|
1391 | : die # never reached? |
1103 | }; |
1392 | }; |
1104 | |
1393 | |
|
|
1394 | /\G[[:space:]]+/gc; # skip initial whitespace |
|
|
1395 | |
1105 | while (/\G((?:[^:=]+|::|\\.)+)=/gc) { |
1396 | while (/\G((?:[^:=[:space:]]+|::|\\.)+)=/gc) { |
1106 | my $ctx = $pkg->($1); |
1397 | my $ctx = $pkg->($1); |
1107 | my $level = "level"; |
1398 | my $level = "level"; |
1108 | |
1399 | |
1109 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
1400 | while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { |
1110 | for ("$1") { |
1401 | for ("$1") { |
1111 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
1402 | if ($_ eq "stderr" ) { $ctx->log_to_warn; |
1112 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
1403 | } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); |
1113 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
1404 | } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); |
1114 | } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog (eval "package Sys::Syslog; $1"); |
1405 | } elsif (/^syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ("$1"); |
1115 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
1406 | } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); |
|
|
1407 | } elsif (/^cap=(.+)/ ) { $ctx->cap ("$1"); |
1116 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
1408 | } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); |
1117 | } elsif ($_ eq "+" ) { $ctx->slaves; |
1409 | } elsif ($_ eq "+" ) { $ctx->slaves; |
1118 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
1410 | } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); |
1119 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
1411 | } elsif ($_ eq "all" ) { $ctx->level ("all"); |
1120 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
1412 | } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; |
… | |
… | |
1127 | } |
1419 | } |
1128 | |
1420 | |
1129 | /\G,/gc or last; |
1421 | /\G,/gc or last; |
1130 | } |
1422 | } |
1131 | |
1423 | |
1132 | /\G[:[:space:]]/gc or last; |
1424 | /\G[:[:space:]]+/gc or last; |
1133 | } |
1425 | } |
|
|
1426 | |
|
|
1427 | /\G[[:space:]]+/gc; # skip trailing whitespace |
1134 | |
1428 | |
1135 | if (/\G(.+)/g) { |
1429 | if (/\G(.+)/g) { |
1136 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1430 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1137 | } |
1431 | } |
1138 | } |
1432 | } |
1139 | |
1433 | |
1140 | 1; |
|
|
1141 | |
|
|
1142 | =head1 EXAMPLES |
1434 | =head1 EXAMPLES |
1143 | |
1435 | |
1144 | This section shows some common configurations. |
1436 | This section shows some common configurations, both as code, and as |
|
|
1437 | C<PERL_ANYEVENT_LOG> string. |
1145 | |
1438 | |
1146 | =over 4 |
1439 | =over 4 |
1147 | |
1440 | |
1148 | =item Setting the global logging level. |
1441 | =item Setting the global logging level. |
1149 | |
1442 | |
1150 | Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before |
1443 | Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before |
1151 | running your program, or modify the log level of the root context: |
1444 | running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of |
|
|
1445 | the root context at runtime: |
1152 | |
1446 | |
1153 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1447 | PERL_ANYEVENT_VERBOSE=5 ./myprog |
1154 | |
1448 | |
|
|
1449 | PERL_ANYEVENT_LOG=log=warn |
|
|
1450 | |
1155 | $AnyEvent::Log::FILTER->level ("warn"); |
1451 | $AnyEvent::Log::FILTER->level ("warn"); |
1156 | |
1452 | |
1157 | =item Append all messages to a file instead of sending them to STDERR. |
1453 | =item Append all messages to a file instead of sending them to STDERR. |
1158 | |
1454 | |
1159 | This is affected by the global logging level. |
1455 | This is affected by the global logging level. |
1160 | |
1456 | |
1161 | $AnyEvent::Log::LOG->log_to_file ($path); (sub { |
1457 | $AnyEvent::Log::LOG->log_to_file ($path); |
|
|
1458 | |
|
|
1459 | PERL_ANYEVENT_LOG=log=file=/some/path |
1162 | |
1460 | |
1163 | =item Write all messages with priority C<error> and higher to a file. |
1461 | =item Write all messages with priority C<error> and higher to a file. |
1164 | |
1462 | |
1165 | This writes them only when the global logging level allows it, because |
1463 | This writes them only when the global logging level allows it, because |
1166 | it is attached to the default context which is invoked I<after> global |
1464 | it is attached to the default context which is invoked I<after> global |
1167 | filtering. |
1465 | filtering. |
1168 | |
1466 | |
1169 | $AnyEvent::Log::FILTER->attach |
1467 | $AnyEvent::Log::FILTER->attach ( |
1170 | new AnyEvent::Log::Ctx log_to_file => $path); |
1468 | new AnyEvent::Log::Ctx log_to_file => $path); |
|
|
1469 | |
|
|
1470 | PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path |
1171 | |
1471 | |
1172 | This writes them regardless of the global logging level, because it is |
1472 | This writes them regardless of the global logging level, because it is |
1173 | attached to the toplevel context, which receives all messages I<before> |
1473 | attached to the toplevel context, which receives all messages I<before> |
1174 | the global filtering. |
1474 | the global filtering. |
1175 | |
1475 | |
1176 | $AnyEvent::Log::COLLECT->attach ( |
1476 | $AnyEvent::Log::COLLECT->attach ( |
1177 | new AnyEvent::Log::Ctx log_to_file => $path); |
1477 | new AnyEvent::Log::Ctx log_to_file => $path); |
1178 | |
1478 | |
|
|
1479 | PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger |
|
|
1480 | |
1179 | In both cases, messages are still written to STDERR. |
1481 | In both cases, messages are still written to STDERR. |
|
|
1482 | |
|
|
1483 | =item Additionally log all messages with C<warn> and higher priority to |
|
|
1484 | C<syslog>, but cap at C<error>. |
|
|
1485 | |
|
|
1486 | This logs all messages to the default log target, but also logs messages |
|
|
1487 | with priority C<warn> or higher (and not filtered otherwise) to syslog |
|
|
1488 | facility C<user>. Messages with priority higher than C<error> will be |
|
|
1489 | logged with level C<error>. |
|
|
1490 | |
|
|
1491 | $AnyEvent::Log::LOG->attach ( |
|
|
1492 | new AnyEvent::Log::Ctx |
|
|
1493 | level => "warn", |
|
|
1494 | cap => "error", |
|
|
1495 | syslog => "user", |
|
|
1496 | ); |
|
|
1497 | |
|
|
1498 | PERL_ANYEVENT_LOG=log=+%syslog:%syslog=warn,cap=error,syslog |
1180 | |
1499 | |
1181 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1500 | =item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s). |
1182 | |
1501 | |
1183 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1502 | Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> |
1184 | context - this simply circumvents the global filtering for trace messages. |
1503 | context - this simply circumvents the global filtering for trace messages. |
1185 | |
1504 | |
1186 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1505 | my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; |
1187 | $debug->attach ($AnyEvent::Log::LOG); |
1506 | $debug->attach ($AnyEvent::Log::LOG); |
|
|
1507 | |
|
|
1508 | PERL_ANYEVENT_LOG=AnyEvent::Debug=+log |
1188 | |
1509 | |
1189 | This of course works for any package, not just L<AnyEvent::Debug>, but |
1510 | This of course works for any package, not just L<AnyEvent::Debug>, but |
1190 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
1511 | assumes the log level for AnyEvent::Debug hasn't been changed from the |
1191 | default. |
1512 | default. |
1192 | |
1513 | |
1193 | =back |
1514 | =back |
1194 | |
1515 | |
|
|
1516 | =head1 ASYNCHRONOUS DISK I/O |
|
|
1517 | |
|
|
1518 | This module uses L<AnyEvent::IO> to actually write log messages (in |
|
|
1519 | C<log_to_file> and C<log_to_path>), so it doesn't block your program when |
|
|
1520 | the disk is busy and a non-blocking L<AnyEvent::IO> backend is available. |
|
|
1521 | |
1195 | =head1 AUTHOR |
1522 | =head1 AUTHOR |
1196 | |
1523 | |
1197 | Marc Lehmann <schmorp@schmorp.de> |
1524 | Marc Lehmann <schmorp@schmorp.de> |
1198 | http://home.schmorp.de/ |
1525 | http://anyevent.schmorp.de |
1199 | |
1526 | |
1200 | =cut |
1527 | =cut |
|
|
1528 | |
|
|
1529 | 1 |
|
|
1530 | |