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.41 by root, Thu Sep 1 04:07:18 2011 UTC vs.
Revision 1.59 by root, Mon Apr 9 02:25:48 2012 UTC

… …
6 6
7Simple uses: 7Simple 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 temperature 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 => "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";
15 20
16 # available log levels in order: 21Log level overview:
17 # fatal alert critical error warn note info debug trace
18 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
19"Complex" uses (for speed sensitive code): 34"Complex" uses (for speed sensitive code, e.g. trace/debug messages):
20 35
21 use AnyEvent::Log; 36 use AnyEvent::Log;
22 37
23 my $tracer = AnyEvent::Log::logger trace => \$my $trace; 38 my $tracer = AnyEvent::Log::logger trace => \$my $trace;
24 39
… …
46attempt to be "the" logging solution or even "a" logging solution for 61attempt to be "the" logging solution or even "a" logging solution for
47AnyEvent - AnyEvent simply creates logging messages internally, and this 62AnyEvent - AnyEvent simply creates logging messages internally, and this
48module more or less exposes the mechanism, with some extra spiff to allow 63module more or less exposes the mechanism, with some extra spiff to allow
49using it from other modules as well. 64using it from other modules as well.
50 65
51Remember that the default verbosity level is C<0> (C<off>), so nothing 66Remember that the default verbosity level is C<4> (C<error>), so only
52will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number 67errors and more important messages will be logged, unless you set
53before starting your program, or change the logging level at runtime with 68C<PERL_ANYEVENT_VERBOSE> to a higher number before starting your program
54something like: 69(C<AE_VERBOSE=5> is recommended during development), or change the logging
70level at runtime with something like:
55 71
56 use AnyEvent::Log; 72 use AnyEvent::Log;
57 $AnyEvent::Log::FILTER->level ("info"); 73 $AnyEvent::Log::FILTER->level ("info");
58 74
59The design goal behind this module was to keep it simple (and small), 75The design goal behind this module was to keep it simple (and small),
… …
75numerical value". 91numerical value".
76 92
77Instead of specifying levels by name you can also specify them by aliases: 93Instead of specifying levels by name you can also specify them by aliases:
78 94
79 LVL NAME SYSLOG PERL NOTE 95 LVL NAME SYSLOG PERL NOTE
80 1 fatal emerg exit aborts program! 96 1 fatal emerg exit system unusable, aborts program!
81 2 alert 97 2 alert failure in primary system
82 3 critical crit 98 3 critical crit failure in backup system
83 4 error err die 99 4 error err die non-urgent program errors, a bug
84 5 warn warning 100 5 warn warning possible problem, not necessarily error
85 6 note notice 101 6 note notice unusual conditions
86 7 info 102 7 info normal messages, no action required
87 8 debug 103 8 debug debugging messages for development
88 9 trace 104 9 trace copious tracing output
89 105
90As you can see, some logging levels have multiple aliases - the first one 106As you can see, some logging levels have multiple aliases - the first one
91is the "official" name, the second one the "syslog" name (if it differs) 107is the "official" name, the second one the "syslog" name (if it differs)
92and the third one the "perl" name, suggesting (only!) that you log C<die> 108and the third one the "perl" name, suggesting (only!) that you log C<die>
93messages at C<error> priority. 109messages at C<error> priority. The NOTE column tries to provide some
110rationale on how to chose a logging level.
94 111
112As a rough guideline, levels 1..3 are primarily meant for users of the
113program (admins, staff), and are the only ones logged to STDERR by
114default. Levels 4..6 are meant for users and developers alike, while
115levels 7..9 are usually meant for developers.
116
95You can normally only log a single message at highest priority level 117You can normally only log a message once at highest priority level (C<1>,
96(C<1>, C<fatal>), because logging a fatal message will also quit the 118C<fatal>), because logging a fatal message will also quit the program - so
97program - so use it sparingly :) 119use it sparingly :)
120
121For example, a program that finds an unknown switch on the commandline
122might well use a fatal logging level to tell users about it - the "system"
123in this case would be the program, or module.
98 124
99Some methods also offer some extra levels, such as C<0>, C<off>, C<none> 125Some methods also offer some extra levels, such as C<0>, C<off>, C<none>
100or C<all> - these are only valid in the methods they are documented for. 126or C<all> - these are only valid for the methods that documented them.
101 127
102=head1 LOGGING FUNCTIONS 128=head1 LOGGING FUNCTIONS
103 129
104These functions allow you to log messages. They always use the caller's 130The following functions allow you to log messages. They always use the
105package as a "logging context". Also, the main logging function C<log> is 131caller's package as a "logging context". Also, the main logging function,
106callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is 132C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent>
107loaded. 133module is loaded.
108 134
109=over 4 135=over 4
110 136
111=cut 137=cut
112 138
113package AnyEvent::Log; 139package AnyEvent::Log;
114 140
115use Carp (); 141use Carp ();
116use POSIX (); 142use POSIX ();
143
144# layout of a context
145# 0 1 2 3 4, 5
146# [$title, $level, %$slaves, &$logcb, &$fmtcb, $cap]
117 147
118use AnyEvent (); BEGIN { AnyEvent::common_sense } 148use AnyEvent (); BEGIN { AnyEvent::common_sense }
119#use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log 149#use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log
120 150
121our $VERSION = $AnyEvent::VERSION; 151our $VERSION = $AnyEvent::VERSION;
… …
166 196
167Last not least, C<$msg> might be a code reference, in which case it is 197Last not least, C<$msg> might be a code reference, in which case it is
168supposed to return the message. It will be called only then the message 198supposed to return the message. It will be called only then the message
169actually gets logged, which is useful if it is costly to create the 199actually gets logged, which is useful if it is costly to create the
170message in the first place. 200message in the first place.
201
202This function takes care of saving and restoring C<$!> and C<$@>, so you
203don't have to.
171 204
172Whether the given message will be logged depends on the maximum log level 205Whether the given message will be logged depends on the maximum log level
173and the caller's package. The return value can be used to ensure that 206and the caller's package. The return value can be used to ensure that
174messages or not "lost" - for example, when L<AnyEvent::Debug> detects a 207messages or not "lost" - for example, when L<AnyEvent::Debug> detects a
175runtime error it tries to log it at C<die> level, but if that message is 208runtime error it tries to log it at C<die> level, but if that message is
… …
243 } 276 }
244 277
245 join "", @res 278 join "", @res
246} 279}
247 280
281sub fatal_exit() {
282 exit 1;
283}
284
248sub _log { 285sub _log {
249 my ($ctx, $level, $format, @args) = @_; 286 my ($ctx, $level, $format, @args) = @_;
250 287
251 $level = $level > 0 && $level <= 9 288 $level = $level > 0 && $level <= 9
252 ? $level+0 289 ? $level+0
253 : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught"; 290 : $STR2LEVEL{$level} || Carp::croak "$level: not a valid logging level, caught";
254 291
255 my $mask = 1 << $level; 292 my $mask = 1 << $level;
256 293
257 my ($success, %seen, @ctx, $now, $fmt); 294 my ($success, %seen, @ctx, $now, @fmt);
258 295
259 do 296 do
260 { 297 {
261 # skip if masked 298 # if !ref, then it's a level number
299 if (!ref $ctx) {
300 $level = $ctx;
262 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
263 if ($ctx->[3]) { 311 if ($ctx->[3]) {
264 # logging target found 312 # logging target found
313
314 local ($!, $@);
265 315
266 # now get raw message, unless we have it already 316 # now get raw message, unless we have it already
267 unless ($now) { 317 unless ($now) {
268 $format = $format->() if ref $format; 318 $format = $format->() if ref $format;
269 $format = sprintf $format, @args if @args; 319 $format = sprintf $format, @args if @args;
… …
272 }; 322 };
273 323
274 # format msg 324 # format msg
275 my $str = $ctx->[4] 325 my $str = $ctx->[4]
276 ? $ctx->[4]($now, $_[0], $level, $format) 326 ? $ctx->[4]($now, $_[0], $level, $format)
277 : ($fmt ||= _format $now, $_[0], $level, $format); 327 : ($fmt[$level] ||= _format $now, $_[0], $level, $format);
278 328
279 $success = 1; 329 $success = 1;
280 330
281 $ctx->[3]($str) 331 $ctx->[3]($str)
282 or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate 332 or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate
… …
285 } 335 }
286 } 336 }
287 } 337 }
288 while $ctx = pop @ctx; 338 while $ctx = pop @ctx;
289 339
290 exit 1 if $level <= 1; 340 fatal_exit if $level <= 1;
291 341
292 $success 342 $success
293} 343}
294 344
295sub log($$;@) { 345sub log($$;@) {
296 _log 346 _log
297 $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0], 347 $CTX{ (caller)[0] } ||= _pkg_ctx +(caller)[0],
298 @_; 348 @_;
299} 349}
300 350
301*AnyEvent::log = *AE::log = \&log;
302
303=item $logger = AnyEvent::Log::logger $level[, \$enabled] 351=item $logger = AnyEvent::Log::logger $level[, \$enabled]
304 352
305Creates a code reference that, when called, acts as if the 353Creates a code reference that, when called, acts as if the
306C<AnyEvent::Log::log> function was called at this point with the given 354C<AnyEvent::Log::log> function was called at this point with the given
307level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with 355level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with
… …
371 419
372 $LOGGER{$logger+0} = $logger; 420 $LOGGER{$logger+0} = $logger;
373 421
374 _reassess $logger+0; 422 _reassess $logger+0;
375 423
376 require AnyEvent::Util; 424 require AnyEvent::Util unless $AnyEvent::Util::VERSION;
377 my $guard = AnyEvent::Util::guard (sub { 425 my $guard = AnyEvent::Util::guard (sub {
378 # "clean up" 426 # "clean up"
379 delete $LOGGER{$logger+0}; 427 delete $LOGGER{$logger+0};
380 }); 428 });
381 429
… …
534This can be used to implement config-file (re-)loading: before loading a 582This can be used to implement config-file (re-)loading: before loading a
535configuration, reset all contexts. 583configuration, reset all contexts.
536 584
537=cut 585=cut
538 586
587our $ORIG_VERBOSE = $AnyEvent::VERBOSE;
588$AnyEvent::VERBOSE = 9;
589
539sub reset { 590sub reset {
540 # hard to kill complex data structures 591 # hard to kill complex data structures
541 # we "recreate" all package loggers and reset the hierarchy 592 # we "recreate" all package loggers and reset the hierarchy
542 while (my ($k, $v) = each %CTX) { 593 while (my ($k, $v) = each %CTX) {
543 @$v = ($k, (1 << 10) - 1 - 1, { }); 594 @$v = ($k, (1 << 10) - 1 - 1, { });
… …
552 $LOG->title ('$AnyEvent::Log::LOG'); 603 $LOG->title ('$AnyEvent::Log::LOG');
553 $LOG->log_to_warn; 604 $LOG->log_to_warn;
554 605
555 $FILTER->slaves ($LOG); 606 $FILTER->slaves ($LOG);
556 $FILTER->title ('$AnyEvent::Log::FILTER'); 607 $FILTER->title ('$AnyEvent::Log::FILTER');
557 $FILTER->level ($AnyEvent::VERBOSE); 608 $FILTER->level ($ORIG_VERBOSE);
558 609
559 $COLLECT->slaves ($FILTER); 610 $COLLECT->slaves ($FILTER);
560 $COLLECT->title ('$AnyEvent::Log::COLLECT'); 611 $COLLECT->title ('$AnyEvent::Log::COLLECT');
561 612
562 _reassess; 613 _reassess;
563} 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;
564 623
565# create the default logger contexts 624# create the default logger contexts
566$LOG = ctx undef; 625$LOG = ctx undef;
567$FILTER = ctx undef; 626$FILTER = ctx undef;
568$COLLECT = ctx undef; 627$COLLECT = ctx undef;
… …
577package AnyEvent::Log::COLLECT; 636package AnyEvent::Log::COLLECT;
578package AE::Log::COLLECT; 637package AE::Log::COLLECT;
579 638
580package AnyEvent::Log::Ctx; 639package AnyEvent::Log::Ctx;
581 640
582# 0 1 2 3 4
583# [$title, $level, %$slaves, &$logcb, &$fmtcb]
584
585=item $ctx = new AnyEvent::Log::Ctx methodname => param... 641=item $ctx = new AnyEvent::Log::Ctx methodname => param...
586 642
587This is a convenience constructor that makes it simpler to construct 643This is a convenience constructor that makes it simpler to construct
588anonymous logging contexts. 644anonymous logging contexts.
589 645
… …
676 732
677=item $ctx->disable ($level[, $level...]) 733=item $ctx->disable ($level[, $level...])
678 734
679Disables logging for the given levels, leaving all others unchanged. 735Disables logging for the given levels, leaving all others unchanged.
680 736
737=item $ctx->cap ($level)
738
739Caps the maximum priority to the given level, for all messages logged
740to, or passing through, this context. That is, while this doesn't affect
741whether a message is logged or passed on, the maximum priority of messages
742will be limited to the specified level - messages with a higher priority
743will be set to the specified priority.
744
745Another way to view this is that C<< ->level >> filters out messages with
746a too low priority, while C<< ->cap >> modifies messages with a too high
747priority.
748
749This is useful when different log targets have different interpretations
750of priority. For example, for a specific command line program, a wrong
751command line switch might well result in a C<fatal> log message, while the
752same message, logged to syslog, is likely I<not> fatal to the system or
753syslog facility as a whole, but more likely a mere C<error>.
754
755This can be modeled by having a stderr logger that logs messages "as-is"
756and a syslog logger that logs messages with a level cap of, say, C<error>,
757or, for truly system-critical components, actually C<critical>.
758
681=cut 759=cut
682 760
683sub _lvl_lst { 761sub _lvl_lst {
684 map { 762 map {
685 $_ > 0 && $_ <= 9 ? $_+0 763 $_ > 0 && $_ <= 9 ? $_+0
686 : $_ eq "all" ? (1 .. 9) 764 : $_ eq "all" ? (1 .. 9)
687 : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught" 765 : $STR2LEVEL{$_} || Carp::croak "$_: not a valid logging level, caught"
688 } @_ 766 } @_
689} 767}
690 768
769sub _lvl {
770 $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1]
771}
772
691our $NOP_CB = sub { 0 }; 773our $NOP_CB = sub { 0 };
692 774
693sub levels { 775sub levels {
694 my $ctx = shift; 776 my $ctx = shift;
695 $ctx->[1] = 0; 777 $ctx->[1] = 0;
… …
698 AnyEvent::Log::_reassess; 780 AnyEvent::Log::_reassess;
699} 781}
700 782
701sub level { 783sub level {
702 my $ctx = shift; 784 my $ctx = shift;
703 my $lvl = $_[0] =~ /^(?:0|off|none)$/ ? 0 : (_lvl_lst $_[0])[-1];
704
705 $ctx->[1] = ((1 << $lvl) - 1) << 1; 785 $ctx->[1] = ((1 << &_lvl) - 1) << 1;
706 AnyEvent::Log::_reassess; 786 AnyEvent::Log::_reassess;
707} 787}
708 788
709sub enable { 789sub enable {
710 my $ctx = shift; 790 my $ctx = shift;
… …
718 $ctx->[1] &= ~(1 << $_) 798 $ctx->[1] &= ~(1 << $_)
719 for &_lvl_lst; 799 for &_lvl_lst;
720 AnyEvent::Log::_reassess; 800 AnyEvent::Log::_reassess;
721} 801}
722 802
803sub cap {
804 my $ctx = shift;
805 $ctx->[5] = &_lvl;
806}
807
723=back 808=back
724 809
725=head3 SLAVE CONTEXTS 810=head3 SLAVE CONTEXTS
726 811
727The following methods attach and detach another logging context to a 812The following methods attach and detach another logging context to a
… …
779the logging (which consists of formatting the message and printing it or 864the logging (which consists of formatting the message and printing it or
780whatever it wants to do with it). 865whatever it wants to do with it).
781 866
782=over 4 867=over 4
783 868
784=item $ctx->log_cb ($cb->($str) 869=item $ctx->log_cb ($cb->($str))
785 870
786Replaces the logging callback on the context (C<undef> disables the 871Replaces the logging callback on the context (C<undef> disables the
787logging callback). 872logging callback).
788 873
789The logging callback is responsible for handling formatted log messages 874The logging callback is responsible for handling formatted log messages
… …
814 899
815Replaces the formatting callback on the context (C<undef> restores the 900Replaces the formatting callback on the context (C<undef> restores the
816default formatter). 901default formatter).
817 902
818The callback is passed the (possibly fractional) timestamp, the original 903The callback is passed the (possibly fractional) timestamp, the original
819logging context, the (numeric) logging level and the raw message string 904logging context (object, not title), the (numeric) logging level and
820and needs to return a formatted log message. In most cases this will be a 905the raw message string and needs to return a formatted log message. In
821string, but it could just as well be an array reference that just stores 906most cases this will be a string, but it could just as well be an array
822the values. 907reference that just stores the values.
823 908
824If, for some reason, you want to use C<caller> to find out more baout the 909If, for some reason, you want to use C<caller> to find out more about the
825logger then you should walk up the call stack until you are no longer 910logger then you should walk up the call stack until you are no longer
826inside the C<AnyEvent::Log> package. 911inside the C<AnyEvent::Log> package.
827 912
828Example: format just the raw message, with numeric log level in angle 913Example: format just the raw message, with numeric log level in angle
829brackets. 914brackets.
… …
833 918
834 "<$lvl>$msg\n" 919 "<$lvl>$msg\n"
835 }); 920 });
836 921
837Example: return an array reference with just the log values, and use 922Example: return an array reference with just the log values, and use
838C<PApp::SQL::sql_exec> to store the emssage in a database. 923C<PApp::SQL::sql_exec> to store the message in a database.
839 924
840 $ctx->fmt_cb (sub { \@_ }); 925 $ctx->fmt_cb (sub { \@_ });
841 $ctx->log_cb (sub { 926 $ctx->log_cb (sub {
842 my ($msg) = @_; 927 my ($msg) = @_;
843 928
… …
855Sets the C<log_cb> to simply use C<CORE::warn> to report any messages 940Sets the C<log_cb> to simply use C<CORE::warn> to report any messages
856(usually this logs to STDERR). 941(usually this logs to STDERR).
857 942
858=item $ctx->log_to_file ($path) 943=item $ctx->log_to_file ($path)
859 944
860Sets the C<log_cb> to log to a file (by appending), unbuffered. 945Sets the C<log_cb> to log to a file (by appending), unbuffered. The
946function might return before the log file has been opened or created.
861 947
862=item $ctx->log_to_path ($path) 948=item $ctx->log_to_path ($path)
863 949
864Same as C<< ->log_to_file >>, but opens the file for each message. This 950Same as C<< ->log_to_file >>, but opens the file for each message. This
865is much slower, but allows you to change/move/rename/delete the file at 951is much slower, but allows you to change/move/rename/delete the file at
… …
900 warn shift; 986 warn shift;
901 0 987 0
902 }); 988 });
903} 989}
904 990
991# this function is a good example of why threads are a must,
992# simply for priority inversion.
993sub _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
905sub log_to_file { 1075sub log_to_file {
906 my ($ctx, $path) = @_; 1076 my ($ctx, $path) = @_;
907 1077
908 open my $fh, ">>", $path 1078 _log_to_disk $ctx, $path, 1;
909 or die "$path: $!";
910
911 $ctx->log_cb (sub {
912 syswrite $fh, shift;
913 0
914 });
915} 1079}
916 1080
917sub log_to_path { 1081sub log_to_path {
918 my ($ctx, $path) = @_; 1082 my ($ctx, $path) = @_;
919 1083
920 $ctx->log_cb (sub { 1084 _log_to_disk $ctx, $path, 0;
921 open my $fh, ">>", $path
922 or die "$path: $!";
923
924 syswrite $fh, shift;
925 0
926 });
927} 1085}
928 1086
929sub log_to_syslog { 1087sub log_to_syslog {
930 my ($ctx, $facility) = @_; 1088 my ($ctx, $facility) = @_;
931 1089
… …
960=over 4 1118=over 4
961 1119
962=item $ctx->log ($level, $msg[, @params]) 1120=item $ctx->log ($level, $msg[, @params])
963 1121
964Same as C<AnyEvent::Log::log>, but uses the given context as log context. 1122Same as C<AnyEvent::Log::log>, but uses the given context as log context.
1123
1124Example: log a message in the context of another package.
1125
1126 (AnyEvent::Log::ctx "Other::Package")->log (warn => "heely bo");
965 1127
966=item $logger = $ctx->logger ($level[, \$enabled]) 1128=item $logger = $ctx->logger ($level[, \$enabled])
967 1129
968Same as C<AnyEvent::Log::logger>, but uses the given context as log 1130Same as C<AnyEvent::Log::logger>, but uses the given context as log
969context. 1131context.
… …
1057=item C<nolog> 1219=item C<nolog>
1058 1220
1059Configures the context to not log anything by itself, which is the 1221Configures the context to not log anything by itself, which is the
1060default. Same as C<< $ctx->log_cb (undef) >>. 1222default. Same as C<< $ctx->log_cb (undef) >>.
1061 1223
1224=item C<cap=>I<level>
1225
1226Caps logging messages entering this context at the given level, i.e.
1227reduces the priority of messages with higher priority than this level. The
1228default is C<0> (or C<off>), meaning the priority will not be touched.
1229
1062=item C<0> or C<off> 1230=item C<0> or C<off>
1063 1231
1064Sets the logging level of the context ot C<0>, i.e. all messages will be 1232Sets the logging level of the context to C<0>, i.e. all messages will be
1065filtered out. 1233filtered out.
1066 1234
1067=item C<all> 1235=item C<all>
1068 1236
1069Enables all logging levels, i.e. filtering will effectively be switched 1237Enables all logging levels, i.e. filtering will effectively be switched
… …
1111 1279
1112Attaches the named context as slave to the context. 1280Attaches the named context as slave to the context.
1113 1281
1114=item C<+> 1282=item C<+>
1115 1283
1116A line C<+> detaches all contexts, i.e. clears the slave list from the 1284A lone C<+> detaches all contexts, i.e. clears the slave list from the
1117context. Anonymous (C<%name>) contexts have no attached slaves by default, 1285context. Anonymous (C<%name>) contexts have no attached slaves by default,
1118but package contexts have the parent context as slave by default. 1286but package contexts have the parent context as slave by default.
1119 1287
1120Example: log messages from My::Module to a file, do not send them to the 1288Example: log messages from My::Module to a file, do not send them to the
1121default log collector. 1289default log collector.
… …
1152 1320
1153 my $pkg = sub { 1321 my $pkg = sub {
1154 $_[0] eq "log" ? $LOG 1322 $_[0] eq "log" ? $LOG
1155 : $_[0] eq "filter" ? $FILTER 1323 : $_[0] eq "filter" ? $FILTER
1156 : $_[0] eq "collect" ? $COLLECT 1324 : $_[0] eq "collect" ? $COLLECT
1157 : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= ctx undef) 1325 : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= do { my $ctx = ctx undef; $ctx->[0] = $_[0]; $ctx })
1158 : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ 1326 : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/
1159 : die # never reached? 1327 : die # never reached?
1160 }; 1328 };
1161 1329
1162 /\G[[:space:]]+/gc; # skip initial whitespace 1330 /\G[[:space:]]+/gc; # skip initial whitespace
… …
1168 while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { 1336 while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) {
1169 for ("$1") { 1337 for ("$1") {
1170 if ($_ eq "stderr" ) { $ctx->log_to_warn; 1338 if ($_ eq "stderr" ) { $ctx->log_to_warn;
1171 } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); 1339 } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1");
1172 } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); 1340 } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1");
1173 } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ($1); 1341 } elsif (/^syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ("$1");
1174 } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); 1342 } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef);
1343 } elsif (/^cap=(.+)/ ) { $ctx->cap ("$1");
1175 } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); 1344 } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1"));
1176 } elsif ($_ eq "+" ) { $ctx->slaves; 1345 } elsif ($_ eq "+" ) { $ctx->slaves;
1177 } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); 1346 } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0);
1178 } elsif ($_ eq "all" ) { $ctx->level ("all"); 1347 } elsif ($_ eq "all" ) { $ctx->level ("all");
1179 } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; 1348 } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level";
… …
1196 if (/\G(.+)/g) { 1365 if (/\G(.+)/g) {
1197 die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; 1366 die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n";
1198 } 1367 }
1199} 1368}
1200 1369
12011;
1202
1203=head1 EXAMPLES 1370=head1 EXAMPLES
1204 1371
1205This section shows some common configurations, both as code, and as 1372This section shows some common configurations, both as code, and as
1206C<PERL_ANYEVENT_LOG> string. 1373C<PERL_ANYEVENT_LOG> string.
1207 1374
… …
1231 1398
1232This writes them only when the global logging level allows it, because 1399This writes them only when the global logging level allows it, because
1233it is attached to the default context which is invoked I<after> global 1400it is attached to the default context which is invoked I<after> global
1234filtering. 1401filtering.
1235 1402
1236 $AnyEvent::Log::FILTER->attach 1403 $AnyEvent::Log::FILTER->attach (
1237 new AnyEvent::Log::Ctx log_to_file => $path); 1404 new AnyEvent::Log::Ctx log_to_file => $path);
1238 1405
1239 PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path 1406 PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path
1240 1407
1241This writes them regardless of the global logging level, because it is 1408This writes them regardless of the global logging level, because it is
… …
1247 1414
1248 PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger 1415 PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger
1249 1416
1250In both cases, messages are still written to STDERR. 1417In both cases, messages are still written to STDERR.
1251 1418
1419=item Additionally log all messages with C<warn> and higher priority to
1420C<syslog>, but cap at C<error>.
1421
1422This logs all messages to the default log target, but also logs messages
1423with priority C<warn> or higher (and not filtered otherwise) to syslog
1424facility C<user>. Messages with priority higher than C<error> will be
1425logged 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
1435
1252=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).
1253 1437
1254Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug> 1438Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>
1255context - this simply circumvents the global filtering for trace messages. 1439context - this simply circumvents the global filtering for trace messages.
1256 1440
… …
1266=back 1450=back
1267 1451
1268=head1 AUTHOR 1452=head1 AUTHOR
1269 1453
1270 Marc Lehmann <schmorp@schmorp.de> 1454 Marc Lehmann <schmorp@schmorp.de>
1271 http://home.schmorp.de/ 1455 http://anyevent.schmorp.de
1272 1456
1273=cut 1457=cut
1274 1458
14591
1460

Diff Legend

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