ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Log.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.31 by root, Thu Aug 25 03:08:48 2011 UTC vs.
Revision 1.39 by root, Fri Aug 26 00:37:26 2011 UTC

… …
49will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number 49will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number
50before starting your program, or change the logging level at runtime with 50before starting your program, or change the logging level at runtime with
51something like: 51something like:
52 52
53 use AnyEvent::Log; 53 use AnyEvent::Log;
54 AnyEvent::Log::FILTER->level ("info"); 54 $AnyEvent::Log::FILTER->level ("info");
55 55
56The design goal behind this module was to keep it simple (and small), 56The design goal behind this module was to keep it simple (and small),
57but make it powerful enough to be potentially useful for any module, and 57but make it powerful enough to be potentially useful for any module, and
58extensive enough for the most common tasks, such as logging to multiple 58extensive enough for the most common tasks, such as logging to multiple
59targets, or being able to log into a database. 59targets, or being able to log into a database.
60 60
61The module is also usable before AnyEvent itself is initialised, in which
62case some of the functionality might be reduced.
63
61The amount of documentation might indicate otherwise, but the module is 64The amount of documentation might indicate otherwise, but the runtime part
62still just below 300 lines of code. 65of the module is still just below 300 lines of code.
63 66
64=head1 LOGGING LEVELS 67=head1 LOGGING LEVELS
65 68
66Logging levels in this module range from C<1> (highest priority) to C<9> 69Logging levels in this module range from C<1> (highest priority) to C<9>
67(lowest priority). Note that the lowest numerical value is the highest 70(lowest priority). Note that the lowest numerical value is the highest
… …
108 111
109use Carp (); 112use Carp ();
110use POSIX (); 113use POSIX ();
111 114
112use AnyEvent (); BEGIN { AnyEvent::common_sense } 115use AnyEvent (); BEGIN { AnyEvent::common_sense }
113use AnyEvent::Util (); 116#use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log
114 117
115our $VERSION = $AnyEvent::VERSION; 118our $VERSION = $AnyEvent::VERSION;
116 119
117our ($COLLECT, $FILTER, $LOG); 120our ($COLLECT, $FILTER, $LOG);
118 121
… …
203 info => 7, 206 info => 7,
204 debug => 8, 207 debug => 8,
205 trace => 9, 208 trace => 9,
206); 209);
207 210
208sub now () { time } 211our $TIME_EXACT;
212
213sub exact_time($) {
214 $TIME_EXACT = shift;
215 *_ts = $AnyEvent::MODEL
216 ? $TIME_EXACT ? \&AE::now : \&AE::time
217 : sub () { $TIME_EXACT ? do { require Time::HiRes; Time::HiRes::time () } : time };
218}
219
220BEGIN {
221 exact_time 0;
222}
209 223
210AnyEvent::post_detect { 224AnyEvent::post_detect {
211 *now = \&AE::now; 225 exact_time $TIME_EXACT;
212}; 226};
213 227
214our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace); 228our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace);
215 229
216# time, ctx, level, msg 230# time, ctx, level, msg
… …
249 # now get raw message, unless we have it already 263 # now get raw message, unless we have it already
250 unless ($now) { 264 unless ($now) {
251 $format = $format->() if ref $format; 265 $format = $format->() if ref $format;
252 $format = sprintf $format, @args if @args; 266 $format = sprintf $format, @args if @args;
253 $format =~ s/\n$//; 267 $format =~ s/\n$//;
254 $now = now; 268 $now = _ts;
255 }; 269 };
256 270
257 # format msg 271 # format msg
258 my $str = $ctx->[4] 272 my $str = $ctx->[4]
259 ? $ctx->[4]($now, $_[0], $level, $format) 273 ? $ctx->[4]($now, $_[0], $level, $format)
… …
354 368
355 $LOGGER{$logger+0} = $logger; 369 $LOGGER{$logger+0} = $logger;
356 370
357 _reassess $logger+0; 371 _reassess $logger+0;
358 372
373 require AnyEvent::Util;
359 my $guard = AnyEvent::Util::guard { 374 my $guard = AnyEvent::Util::guard (sub {
360 # "clean up" 375 # "clean up"
361 delete $LOGGER{$logger+0}; 376 delete $LOGGER{$logger+0};
362 }; 377 });
363 378
364 sub { 379 sub {
365 $guard if 0; # keep guard alive, but don't cause runtime overhead 380 $guard if 0; # keep guard alive, but don't cause runtime overhead
366 381
367 _log $ctx, $level, @_ 382 _log $ctx, $level, @_
… …
372sub logger($;$) { 387sub logger($;$) {
373 _logger 388 _logger
374 $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], 389 $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0],
375 @_ 390 @_
376} 391}
392
393=item AnyEvent::Log::exact_time $on
394
395By default, C<AnyEvent::Log> will use C<AE::now>, i.e. the cached
396eventloop time, for the log timestamps. After calling this function with a
397true value it will instead resort to C<AE::time>, i.e. fetch the current
398time on each log message. This only makes a difference for event loops
399that actually cache the time (such as L<EV> or L<AnyEvent::Loop>).
400
401This setting can be changed at any time by calling this function.
402
403Since C<AnyEvent::Log> has to work even before the L<AnyEvent> has been
404initialised, this switch will also decide whether to use C<CORE::time> or
405C<Time::HiRes::time> when logging a message before L<AnyEvent> becomes
406available.
377 407
378=back 408=back
379 409
380=head1 LOGGING CONTEXTS 410=head1 LOGGING CONTEXTS
381 411
… …
513 } 543 }
514 544
515 @$_ = ($_->[0], (1 << 10) - 1 - 1) 545 @$_ = ($_->[0], (1 << 10) - 1 - 1)
516 for $LOG, $FILTER, $COLLECT; 546 for $LOG, $FILTER, $COLLECT;
517 547
518 $LOG->slaves; 548 #$LOG->slaves;
519 $LOG->title ('$AnyEvent::Log::LOG'); 549 $LOG->title ('$AnyEvent::Log::LOG');
520 $LOG->log_to_warn; 550 $LOG->log_to_warn;
521 551
522 $FILTER->slaves ($LOG); 552 $FILTER->slaves ($LOG);
523 $FILTER->title ('$AnyEvent::Log::FILTER'); 553 $FILTER->title ('$AnyEvent::Log::FILTER');
… …
1012Configures the context to log to a file with the given path. Works like 1042Configures the context to log to a file with the given path. Works like
1013C<log_to_path>. 1043C<log_to_path>.
1014 1044
1015=item C<syslog> or C<syslog=>I<expr> 1045=item C<syslog> or C<syslog=>I<expr>
1016 1046
1017Configured the context to log to syslog. If I<expr> is given, then it is 1047Configures the context to log to syslog. If I<expr> is given, then it is
1018evaluated in the L<Sys::Syslog> package, so you could use: 1048evaluated in the L<Sys::Syslog> package, so you could use:
1019 1049
1020 log=syslog=LOG_LOCAL0 1050 log=syslog=LOG_LOCAL0
1021 1051
1022=item C<nolog> 1052=item C<nolog>
… …
1064 filter=warn 1094 filter=warn
1065 1095
1066 # or, more verbose 1096 # or, more verbose
1067 filter=only,level,warn 1097 filter=only,level,warn
1068 1098
1069=item C<1>..C<9>, a logging level name (C<error>, C<debug> etc.) 1099=item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.)
1070 1100
1071A numeric loglevel or the name of a loglevel will be interpreted according 1101A numeric loglevel or the name of a loglevel will be interpreted according
1072to the most recent C<only>, C<except> or C<level> directive. By default, 1102to the most recent C<only>, C<except> or C<level> directive. By default,
1073specifying a logging level enables that and any higher priority messages. 1103specifying a logging level enables that and any higher priority messages.
1074 1104
1075=item C<+>I<context> 1105=item C<+>I<context>
1076 1106
1077Adds/attaches the named context as slave to the context. 1107Attaches the named context as slave to the context.
1078 1108
1079=item C<+> 1109=item C<+>
1080 1110
1081A line C<+> clears the slave list form the context. Anonymous (C<%name>) 1111A line C<+> detaches all contexts, i.e. clears the slave list from the
1082contexts have no slaves by default, but package contexts have the parent 1112context. Anonymous (C<%name>) contexts have no attached slaves by default,
1083context as slave by default. 1113but package contexts have the parent context as slave by default.
1084 1114
1085Example: log messages from My::Module to a file, do not send them to the 1115Example: log messages from My::Module to a file, do not send them to the
1086default log collector. 1116default log collector.
1087 1117
1088 My::Module=+,file=/tmp/mymodulelog 1118 My::Module=+,file=/tmp/mymodulelog
1089 1119
1090=back 1120=back
1091 1121
1092Any character can be escaped by prefixing it with a C<\> (backslash), as 1122Any character can be escaped by prefixing it with a C<\> (backslash), as
1093usual, so to log to a file containing a comma, colon, backslash and space in the 1123usual, so to log to a file containing a comma, colon, backslash and some
1094filename, you would do this: 1124spaces in the filename, you would do this:
1095 1125
1096 PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' 1126 PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes'
1097 1127
1098Since whitespace (which includes newlines) is allowed, it is fine to 1128Since whitespace (which includes newlines) is allowed, it is fine to
1099specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: 1129specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.:

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines