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.37 by root, Thu Aug 25 06:34:11 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
… …
354 357
355 $LOGGER{$logger+0} = $logger; 358 $LOGGER{$logger+0} = $logger;
356 359
357 _reassess $logger+0; 360 _reassess $logger+0;
358 361
362 require AnyEvent::Util;
359 my $guard = AnyEvent::Util::guard { 363 my $guard = AnyEvent::Util::guard (sub {
360 # "clean up" 364 # "clean up"
361 delete $LOGGER{$logger+0}; 365 delete $LOGGER{$logger+0};
362 }; 366 });
363 367
364 sub { 368 sub {
365 $guard if 0; # keep guard alive, but don't cause runtime overhead 369 $guard if 0; # keep guard alive, but don't cause runtime overhead
366 370
367 _log $ctx, $level, @_ 371 _log $ctx, $level, @_
… …
513 } 517 }
514 518
515 @$_ = ($_->[0], (1 << 10) - 1 - 1) 519 @$_ = ($_->[0], (1 << 10) - 1 - 1)
516 for $LOG, $FILTER, $COLLECT; 520 for $LOG, $FILTER, $COLLECT;
517 521
518 $LOG->slaves; 522 #$LOG->slaves;
519 $LOG->title ('$AnyEvent::Log::LOG'); 523 $LOG->title ('$AnyEvent::Log::LOG');
520 $LOG->log_to_warn; 524 $LOG->log_to_warn;
521 525
522 $FILTER->slaves ($LOG); 526 $FILTER->slaves ($LOG);
523 $FILTER->title ('$AnyEvent::Log::FILTER'); 527 $FILTER->title ('$AnyEvent::Log::FILTER');
… …
1012Configures the context to log to a file with the given path. Works like 1016Configures the context to log to a file with the given path. Works like
1013C<log_to_path>. 1017C<log_to_path>.
1014 1018
1015=item C<syslog> or C<syslog=>I<expr> 1019=item C<syslog> or C<syslog=>I<expr>
1016 1020
1017Configured the context to log to syslog. If I<expr> is given, then it is 1021Configures 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: 1022evaluated in the L<Sys::Syslog> package, so you could use:
1019 1023
1020 log=syslog=LOG_LOCAL0 1024 log=syslog=LOG_LOCAL0
1021 1025
1022=item C<nolog> 1026=item C<nolog>
… …
1064 filter=warn 1068 filter=warn
1065 1069
1066 # or, more verbose 1070 # or, more verbose
1067 filter=only,level,warn 1071 filter=only,level,warn
1068 1072
1069=item C<1>..C<9>, a logging level name (C<error>, C<debug> etc.) 1073=item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.)
1070 1074
1071A numeric loglevel or the name of a loglevel will be interpreted according 1075A 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, 1076to the most recent C<only>, C<except> or C<level> directive. By default,
1073specifying a logging level enables that and any higher priority messages. 1077specifying a logging level enables that and any higher priority messages.
1074 1078
1075=item C<+>I<context> 1079=item C<+>I<context>
1076 1080
1077Adds/attaches the named context as slave to the context. 1081Attaches the named context as slave to the context.
1078 1082
1079=item C<+> 1083=item C<+>
1080 1084
1081A line C<+> clears the slave list form the context. Anonymous (C<%name>) 1085A 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 1086context. Anonymous (C<%name>) contexts have no attached slaves by default,
1083context as slave by default. 1087but package contexts have the parent context as slave by default.
1084 1088
1085Example: log messages from My::Module to a file, do not send them to the 1089Example: log messages from My::Module to a file, do not send them to the
1086default log collector. 1090default log collector.
1087 1091
1088 My::Module=+,file=/tmp/mymodulelog 1092 My::Module=+,file=/tmp/mymodulelog
1089 1093
1090=back 1094=back
1091 1095
1092Any character can be escaped by prefixing it with a C<\> (backslash), as 1096Any 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 1097usual, so to log to a file containing a comma, colon, backslash and some
1094filename, you would do this: 1098spaces in the filename, you would do this:
1095 1099
1096 PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' 1100 PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes'
1097 1101
1098Since whitespace (which includes newlines) is allowed, it is fine to 1102Since whitespace (which includes newlines) is allowed, it is fine to
1099specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.: 1103specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.:

Diff Legend

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