--- AnyEvent/lib/AnyEvent/Log.pm 2011/08/20 02:21:53 1.17 +++ AnyEvent/lib/AnyEvent/Log.pm 2011/08/25 03:08:48 1.31 @@ -4,15 +4,17 @@ =head1 SYNOPSIS - # simple use +Simple uses: + use AnyEvent; AE::log debug => "hit my knee"; AE::log warn => "it's a bit too hot"; AE::log error => "the flag was false!"; - AE::log fatal => "the bit toggled! run!"; + AE::log fatal => "the bit toggled! run!"; # never returns + +"Complex" uses (for speed sensitive code): - # "complex" use use AnyEvent::Log; my $tracer = AnyEvent::Log::logger trace => \$my $trace; @@ -20,15 +22,20 @@ $tracer->("i am here") if $trace; $tracer->(sub { "lots of data: " . Dumper $self }) if $trace; - # configuration +Configuration (also look at the EXAMPLES section): - # set logging for this package to errors and higher only + # set logging for the current package to errors and higher only AnyEvent::Log::ctx->level ("error"); - # set logging globally to anything below debug - $AnyEvent::Log::Root->level ("notice"); + # set logging level to suppress anything below "notice" + $AnyEvent::Log::FILTER->level ("notice"); - # see also EXAMPLES, below + # send all critical and higher priority messages to syslog, + # regardless of (most) other settings + $AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx + level => "critical", + log_to_syslog => 0, + ); =head1 DESCRIPTION @@ -38,13 +45,13 @@ module more or less exposes the mechanism, with some extra spiff to allow using it from other modules as well. -Remember that the default verbosity level is C<0>, so nothing will be -logged, unless you set C to a higher number before -starting your program, or change the logging level at runtime with +Remember that the default verbosity level is C<0> (C), so nothing +will be logged, unless you set C to a higher number +before starting your program, or change the logging level at runtime with something like: - use AnyEvent; - (AnyEvent::Log::ctx "")->level ("info"); + use AnyEvent::Log; + AnyEvent::Log::FILTER->level ("info"); The design goal behind this module was to keep it simple (and small), but make it powerful enough to be potentially useful for any module, and @@ -52,12 +59,44 @@ targets, or being able to log into a database. The amount of documentation might indicate otherwise, but the module is -still just 240 lines or so. +still just below 300 lines of code. + +=head1 LOGGING LEVELS + +Logging levels in this module range from C<1> (highest priority) to C<9> +(lowest priority). Note that the lowest numerical value is the highest +priority, so when this document says "higher priority" it means "lower +numerical value". + +Instead of specifying levels by name you can also specify them by aliases: + + LVL NAME SYSLOG PERL NOTE + 1 fatal emerg exit aborts program! + 2 alert + 3 critical crit + 4 error err die + 5 warn warning + 6 note notice + 7 info + 8 debug + 9 trace + +As you can see, some logging levels have multiple aliases - the first one +is the "official" name, the second one the "syslog" name (if it differs) +and the third one the "perl" name, suggesting that you log C messages +at C priority. + +You can normally only log a single message at highest priority level +(C<1>, C), because logging a fatal message will also quit the +program - so use it sparingly :) + +Some methods also offer some extra levels, such as C<0>, C, C +or C - these are only valid in the methods they are documented for. =head1 LOGGING FUNCTIONS These functions allow you to log messages. They always use the caller's -package as a "logging module/source". Also, the main logging function is +package as a "logging context". Also, the main logging function C is callable as C or C when the C module is loaded. @@ -75,6 +114,8 @@ our $VERSION = $AnyEvent::VERSION; +our ($COLLECT, $FILTER, $LOG); + our ($now_int, $now_str1, $now_str2); # Format Time, not public - yet? @@ -88,27 +129,26 @@ "$now_str1$f$now_str2" } -our %CTX; # all logging contexts +our %CTX; # all package contexts # creates a default package context object for the given package sub _pkg_ctx($) { my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx"; # link "parent" package - my $pkg = $_[0] =~ /^(.+)::/ ? $1 : "AE::Log::Top"; + my $parent = $_[0] =~ /^(.+)::/ + ? $CTX{$1} ||= &_pkg_ctx ("$1") + : $COLLECT; - $pkg = $CTX{$pkg} ||= &_pkg_ctx ($pkg); - $ctx->[2]{$pkg+0} = $pkg; + $ctx->[2]{$parent+0} = $parent; $ctx } =item AnyEvent::Log::log $level, $msg[, @args] -Requests logging of the given C<$msg> with the given log level (1..9). -You can also use the following strings as log level: C (1), -C (2), C (3), C (4), C (5), C (6), -C (7), C (8), C (9). +Requests logging of the given C<$msg> with the given log level, and +returns true if the message was logged I. For C log levels, the program will abort. @@ -124,7 +164,10 @@ message in the first place. Whether the given message will be logged depends on the maximum log level -and the caller's package. +and the caller's package. The return value can be used to ensure that +messages or not "lost" - for example, when L detects a +runtime error it tries to log it at C level, but if that message is +lost it simply uses warn. Note that you can (and should) call this function as C or C, without C-ing this module if possible (i.e. you don't @@ -151,10 +194,10 @@ # also allow syslog equivalent names our %STR2LEVEL = ( - fatal => 1, emerg => 1, + fatal => 1, emerg => 1, exit => 1, alert => 2, critical => 3, crit => 3, - error => 4, err => 4, + error => 4, err => 4, die => 4, warn => 5, warning => 5, note => 6, notice => 6, info => 7, @@ -194,7 +237,7 @@ my $mask = 1 << $level; - my (%seen, @ctx, $now, $fmt); + my ($success, %seen, @ctx, $now, $fmt); do { @@ -208,24 +251,28 @@ $format = $format->() if ref $format; $format = sprintf $format, @args if @args; $format =~ s/\n$//; - $now = AE::now; + $now = now; }; # format msg my $str = $ctx->[4] ? $ctx->[4]($now, $_[0], $level, $format) - : $fmt ||= _format $now, $_[0], $level, $format; + : ($fmt ||= _format $now, $_[0], $level, $format); - $ctx->[3]($str); - } + $success = 1; - # not masked, not consumed - propagate to parent contexts - push @ctx, values %{ $ctx->[2] }; + $ctx->[3]($str) + or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate + } else { + push @ctx, values %{ $ctx->[2] }; # not masked - propagate + } } } while $ctx = pop @ctx; exit 1 if $level <= 1; + + $success } sub log($$;@) { @@ -239,7 +286,7 @@ =item $logger = AnyEvent::Log::logger $level[, \$enabled] Creates a code reference that, when called, acts as if the -C function was called at this point with the givne +C function was called at this point with the given level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with the C function: @@ -349,9 +396,9 @@ actually logging the formatted message and telling C whether it has consumed the message, or whether it should be propagated). -For propagation, a context can have any number of attached I. Any message that is neither masked by the logging mask nor -masked by the logging callback returning true will be passed to all parent +masked by the logging callback returning true will be passed to all slave contexts. Each call to a logging function will log the message at most once per @@ -365,56 +412,56 @@ Package contexts have the package name as logging title by default. -They have exactly one parent - the context of the "parent" package. The +They have exactly one slave - the context of the "parent" package. The parent package is simply defined to be the package name without the last component, i.e. C becomes C, -and C becomes ... C which is the -exception of the rule - just like the parent of any package name in -Perl is C
, the default parent of any top-level package context is -C. +and C becomes ... C<$AnyEvent::Log::COLLECT> which is the +exception of the rule - just like the "parent" of any single-component +package name in Perl is C
, the default slave of any top-level +package context is C<$AnyEvent::Log::COLLECT>. -Since perl packages form only an approximate hierarchy, this parent +Since perl packages form only an approximate hierarchy, this slave context can of course be removed. -All other (anonymous) contexts have no parents and an empty title by +All other (anonymous) contexts have no slaves and an empty title by default. -When the module is loaded it creates the default context called -C (also stored in C<$AnyEvent::Log::Default>), -which simply logs everything via C and doesn't propagate anything -anywhere by default. The purpose of the default context is to provide +When the module is loaded it creates the C<$AnyEvent::Log::LOG> logging +context that simply logs everything via C, without propagating +anything anywhere by default. The purpose of this context is to provide a convenient place to override the global logging target or to attach additional log targets. It's not meant for filtering. -It then creates the root context called C (also -stored in C<$AnyEvent::Log::Root>) and sets its log level set to all -levels up to the one specified by C<$ENV{PERL_ANYEVENT_VERBOSE}>. It -then attached the default logging context to it. The purpose of the root -context is to simply provide filtering according to some global log level. - -Finally it creates the top-level package context called -C (also stored in, you might have guessed, -C<$AnyEvent::Log::Top>) and attached the root context but otherwise leaves -it at default config. It's purpose is simply to collect all log messages -system-wide. - -These three special contexts can also be referred to by the -package/context names C, C and -C. - -The effect of all this is that log messages, by default, wander up -to the root context where log messages with lower priority then -C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered away and then to the -AnyEvent::Log::Default context to be passed to C. - -Splitting the top level context into three contexts makes it easy to set -a global logging level (by modifying the root context), but still allow -other contexts to log, for example, their debug and trace messages to the -default target despite the global logging level, or to attach additional -log targets that log messages, regardless of the global logging level. - -It also makes it easy to replace the default warn-logger by something that -logs to a file, or to attach additional logging targets. +It then creates the C<$AnyEvent::Log::FILTER> context whose +purpose is to suppress all messages with priority higher +than C<$ENV{PERL_ANYEVENT_VERBOSE}>. It then attached the +C<$AnyEvent::Log::LOG> context to it. The purpose of the filter context +is to simply provide filtering according to some global log level. + +Finally it creates the top-level package context C<$AnyEvent::Log::COLLECT> +and attaches the C<$AnyEvent::Log::FILTER> context to it, but otherwise +leaves it at default config. Its purpose is simply to collect all log +messages system-wide. + +The hierarchy is then: + + any package, eventually -> $COLLECT -> $FILTER -> $LOG + +The effect of all this is that log messages, by default, wander up to the +C<$AnyEvent::Log::COLLECT> context where all messages normally end up, +from there to C<$AnyEvent::Log::FILTER> where log messages with lower +priority then C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered out and then +to the C<$AnyEvent::Log::LOG> context to be passed to C. + +This makes it easy to set a global logging level (by modifying $FILTER), +but still allow other contexts to send, for example, their debug and trace +messages to the $LOG target despite the global logging level, or to attach +additional log targets that log messages, regardless of the global logging +level. + +It also makes it easy to modify the default warn-logger ($LOG) to +something that logs to a file, or to attach additional logging targets +(such as loggign to a file) by attaching it to $FILTER. =head2 CREATING/FINDING/DESTROYING CONTEXTS @@ -458,53 +505,49 @@ sub reset { # hard to kill complex data structures - # we recreate all package loggers and reset the hierarchy + # we "recreate" all package loggers and reset the hierarchy while (my ($k, $v) = each %CTX) { @$v = ($k, (1 << 10) - 1 - 1, { }); - my $pkg = $k =~ /^(.+)::/ ? $1 : "AE::Log::Top"; - $v->attach ($CTX{$pkg}); + $v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log::COLLECT); } - $AnyEvent::Log::Default->parents; - $AnyEvent::Log::Default->title ("AnyEvent::Log::Default"); - $AnyEvent::Log::Default->log_cb (sub { - warn shift; - 0 - }); - $CTX{"AnyEvent::Log::Default"} = $CTX{"AE::Log::Default"} = $AnyEvent::Log::Default; + @$_ = ($_->[0], (1 << 10) - 1 - 1) + for $LOG, $FILTER, $COLLECT; + + $LOG->slaves; + $LOG->title ('$AnyEvent::Log::LOG'); + $LOG->log_to_warn; + + $FILTER->slaves ($LOG); + $FILTER->title ('$AnyEvent::Log::FILTER'); + $FILTER->level ($AnyEvent::VERBOSE); - $AnyEvent::Log::Root->parents ($AnyEvent::Log::Default); - $AnyEvent::Log::Root->title ("AnyEvent::Log::Root"); - $AnyEvent::Log::Root->level ($AnyEvent::VERBOSE); - $CTX{"AnyEvent::Log::Root"} = $CTX{"AE::Log::Root"} = $AnyEvent::Log::Root; - - $AnyEvent::Log::Top->parents ($AnyEvent::Log::Root); - $AnyEvent::Log::Top->title ("AnyEvent::Log::Top"); - $CTX{"AnyEvent::Log::Top"} = $CTX{"AE::Log::Top"} = $AnyEvent::Log::Top; + $COLLECT->slaves ($FILTER); + $COLLECT->title ('$AnyEvent::Log::COLLECT'); _reassess; } # create the default logger contexts -$AnyEvent::Log::Default = ctx undef; -$AnyEvent::Log::Root = ctx undef; -$AnyEvent::Log::Top = ctx undef; +$LOG = ctx undef; +$FILTER = ctx undef; +$COLLECT = ctx undef; AnyEvent::Log::reset; # hello, CPAN, please catch me -package AnyEvent::Log::Default; -package AE::Log::Default; -package AnyEvent::Log::Root; -package AE::Log::Root; -package AnyEvent::Log::Top; -package AE::Log::Top; +package AnyEvent::Log::LOG; +package AE::Log::LOG; +package AnyEvent::Log::FILTER; +package AE::Log::FILTER; +package AnyEvent::Log::COLLECT; +package AE::Log::COLLECT; package AnyEvent::Log::Ctx; -# 0 1 2 3 4 -# [$title, $level, %$parents, &$logcb, &$fmtcb] +# 0 1 2 3 4 +# [$title, $level, %$slaves, &$logcb, &$fmtcb] =item $ctx = new AnyEvent::Log::Ctx methodname => param... @@ -517,13 +560,13 @@ array. The methods are called in the same order as specified. Example: create a new logging context and set both the default logging -level, some parent contexts and a logging callback. +level, some slave contexts and a logging callback. $ctx = new AnyEvent::Log::Ctx title => "dubious messages", level => "error", log_cb => sub { print STDOUT shift; 0 }, - parents => [$ctx1, $ctx, $ctx2], + slaves => [$ctx1, $ctx, $ctx2], ; =back @@ -646,33 +689,33 @@ =back -=head3 PARENT CONTEXTS +=head3 SLAVE CONTEXTS The following methods attach and detach another logging context to a logging context. -Log messages are propagated to all parent contexts, unless the logging +Log messages are propagated to all slave contexts, unless the logging callback consumes the message. =over 4 =item $ctx->attach ($ctx2[, $ctx3...]) -Attaches the given contexts as parents to this context. It is not an error +Attaches the given contexts as slaves to this context. It is not an error to add a context twice (the second add will be ignored). A context can be specified either as package name or as a context object. =item $ctx->detach ($ctx2[, $ctx3...]) -Removes the given parents from this context - it's not an error to attempt +Removes the given slaves from this context - it's not an error to attempt to remove a context that hasn't been added. A context can be specified either as package name or as a context object. -=item $ctx->parents ($ctx2[, $ctx3...]) +=item $ctx->slaves ($ctx2[, $ctx3...]) -Replaces all parents attached to this context by the ones given. +Replaces all slaves attached to this context by the ones given. =cut @@ -690,23 +733,22 @@ for map { AnyEvent::Log::ctx $_ } @_; } -sub parents { +sub slaves { undef $_[0][2]; &attach; } =back -=head3 MESSAGE LOGGING +=head3 LOG TARGETS The following methods configure how the logging context actually does the logging (which consists of formatting the message and printing it or -whatever it wants to do with it) and also allows you to log messages -directly to a context, without going via your package context. +whatever it wants to do with it). =over 4 -=item $ctx->log_cb ($cb->($str)) +=item $ctx->log_cb ($cb->($str) Replaces the logging callback on the context (C disables the logging callback). @@ -717,7 +759,7 @@ It also has to return true iff it has consumed the log message, and false if it hasn't. Consuming a message means that it will not be sent to any -parent context. When in doubt, return C<0> from your logging callback. +slave context. When in doubt, return C<0> from your logging callback. Example: a very simple logging callback, simply dump the message to STDOUT and do not consume it. @@ -735,15 +777,20 @@ $ctx->levels ("debug", "trace"); $ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages -=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message)) +=item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message)) Replaces the formatting callback on the context (C restores the default formatter). The callback is passed the (possibly fractional) timestamp, the original -logging context, the (numeric) logging level and the raw message string and needs to -return a formatted log message. In most cases this will be a string, but -it could just as well be an array reference that just stores the values. +logging context, the (numeric) logging level and the raw message string +and needs to return a formatted log message. In most cases this will be a +string, but it could just as well be an array reference that just stores +the values. + +If, for some reason, you want to use C to find out more baout the +logger then you should walk up the call stack until you are no longer +inside the C package. Example: format just the raw message, with numeric log level in angle brackets. @@ -770,6 +817,35 @@ 0 }); +=item $ctx->log_to_warn + +Sets the C to simply use C to report any messages +(usually this logs to STDERR). + +=item $ctx->log_to_file ($path) + +Sets the C to log to a file (by appending), unbuffered. + +=item $ctx->log_to_path ($path) + +Same as C<< ->log_to_file >>, but opens the file for each message. This +is much slower, but allows you to change/move/rename/delete the file at +basically any time. + +Needless(?) to say, if you do not want to be bitten by some evil person +calling C, the path should be absolute. Doesn't help with +C, but hey... + +=item $ctx->log_to_syslog ([$log_flags]) + +Logs all messages via L, mapping C to C and all +the others in the obvious way. If specified, then the C<$log_flags> are +simply or'ed onto the priority argument and can contain any C +flags valid for Sys::Syslog::syslog, except for the priority levels. + +Note that this function also sets a C - the logging part requires +an array reference with [$level, $str] as input. + =cut sub log_cb { @@ -784,6 +860,70 @@ $ctx->[4] = $cb; } +sub log_to_warn { + my ($ctx, $path) = @_; + + $ctx->log_cb (sub { + warn shift; + 0 + }); +} + +sub log_to_file { + my ($ctx, $path) = @_; + + open my $fh, ">>", $path + or die "$path: $!"; + + $ctx->log_cb (sub { + syswrite $fh, shift; + 0 + }); +} + +sub log_to_path { + my ($ctx, $path) = @_; + + $ctx->log_cb (sub { + open my $fh, ">>", $path + or die "$path: $!"; + + syswrite $fh, shift; + 0 + }); +} + +sub log_to_syslog { + my ($ctx, $flags) = @_; + + require Sys::Syslog; + + $ctx->fmt_cb (sub { + my $str = $_[3]; + $str =~ s/\n(?=.)/\n+ /g; + + [$_[2], "($_[1][0]) $str"] + }); + + $ctx->log_cb (sub { + my $lvl = $_[0][0] < 9 ? $_[0][0] : 8; + + Sys::Syslog::syslog ($flags | ($lvl - 1), $_) + for split /\n/, $_[0][1]; + + 0 + }); +} + +=back + +=head3 MESSAGE LOGGING + +These methods allow you to log messages directly to a context, without +going via your package context. + +=over 4 + =item $ctx->log ($level, $msg[, @params]) Same as C, but uses the given context as log context. @@ -798,36 +938,259 @@ *log = \&AnyEvent::Log::_log; *logger = \&AnyEvent::Log::_logger; -1; +=back + +=cut + +package AnyEvent::Log; + +=head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG} + +Logging can also be configured by setting the environment variable +C (or C). + +The value consists of one or more logging context specifications separated +by C<:> or whitespace. Each logging specification in turn starts with a +context name, followed by C<=>, followed by zero or more comma-separated +configuration directives, here are some examples: + + # set default logging level + filter=warn + + # log to file instead of to stderr + log=file=/tmp/mylog + + # log to file in addition to stderr + log=+%file:%file=file=/tmp/mylog + + # enable debug log messages, log warnings and above to syslog + filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0 + + # log trace messages (only) from AnyEvent::Debug to file + AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog + +A context name in the log specification can be any of the following: + +=over 4 + +=item C, C, C + +Correspond to the three predefined C<$AnyEvent::Log::COLLECT>, +C and C<$AnyEvent::Log::LOG> contexts. + +=item C<%name> + +Context names starting with a C<%> are anonymous contexts created when the +name is first mentioned. The difference to package contexts is that by +default they have no attached slaves. + +=item a perl package name + +Any other string references the logging context associated with the given +Perl C. In the unlikely case where you want to specify a package +context that matches on of the other context name forms, you can add a +C<::> to the package name to force interpretation as a package. + +=back + +The configuration specifications can be any number of the following: + +=over 4 + +=item C + +Configures the context to use Perl's C function (which typically +logs to C). Works like C. + +=item CI + +Configures the context to log to a file with the given path. Works like +C. + +=item CI + +Configures the context to log to a file with the given path. Works like +C. + +=item C or CI + +Configured the context to log to syslog. If I is given, then it is +evaluated in the L package, so you could use: + + log=syslog=LOG_LOCAL0 + +=item C + +Configures the context to not log anything by itself, which is the +default. Same as C<< $ctx->log_cb (undef) >>. + +=item C<0> or C + +Sets the logging level of the context ot C<0>, i.e. all messages will be +filtered out. + +=item C + +Enables all logging levels, i.e. filtering will effectively be switched +off (the default). + +=item C + +Disables all logging levels, and changes the interpretation of following +level specifications to enable the specified level only. + +Example: only enable debug messages for a context. + + context=only,debug + +=item C + +Enables all logging levels, and changes the interpretation of following +level specifications to disable that level. Rarely used. + +Example: enable all logging levels except fatal and trace (this is rather +nonsensical). + + filter=exept,fatal,trace + +=item C + +Enables all logging levels, and changes the interpretation of following +level specifications to be "that level or any higher priority +message". This is the default. + +Example: log anything at or above warn level. + + filter=warn + + # or, more verbose + filter=only,level,warn + +=item C<1>..C<9>, a logging level name (C, C etc.) + +A numeric loglevel or the name of a loglevel will be interpreted according +to the most recent C, C or C directive. By default, +specifying a logging level enables that and any higher priority messages. + +=item C<+>I + +Adds/attaches the named context as slave to the context. + +=item C<+> + +A line C<+> clears the slave list form the context. Anonymous (C<%name>) +contexts have no slaves by default, but package contexts have the parent +context as slave by default. + +Example: log messages from My::Module to a file, do not send them to the +default log collector. + + My::Module=+,file=/tmp/mymodulelog =back +Any character can be escaped by prefixing it with a C<\> (backslash), as +usual, so to log to a file containing a comma, colon, backslash and space in the +filename, you would do this: + + PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes' + +Since whitespace (which includes newlines) is allowed, it is fine to +specify multiple lines in C, e.g.: + + PERL_ANYEVENT_LOG=" + filter=warn + AnyEvent::Debug=+%trace + %trace=only,trace,+log + " myprog + +Also, in the unlikely case when you want to concatenate specifications, +use whitespace as separator, as C<::> will be interpreted as part of a +module name, an empty spec with two separators: + + PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug" + +=cut + +for (my $spec = $ENV{PERL_ANYEVENT_LOG}) { + my %anon; + + my $pkg = sub { + $_[0] eq "log" ? $LOG + : $_[0] eq "filter" ? $FILTER + : $_[0] eq "collect" ? $COLLECT + : $_[0] =~ /^%(.+)$/ ? ($anon{$1} ||= ctx undef) + : $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/ + : die # never reached? + }; + + /\G[[:space:]]+/gc; # skip initial whitespace + + while (/\G((?:[^:=[:space:]]+|::|\\.)+)=/gc) { + my $ctx = $pkg->($1); + my $level = "level"; + + while (/\G((?:[^,:[:space:]]+|::|\\.)+)/gc) { + for ("$1") { + if ($_ eq "stderr" ) { $ctx->log_to_warn; + } elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1"); + } elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1"); + } elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog (eval "package Sys::Syslog; $1"); + } elsif ($_ eq "nolog" ) { $ctx->log_cb (undef); + } elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1")); + } elsif ($_ eq "+" ) { $ctx->slaves; + } elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0); + } elsif ($_ eq "all" ) { $ctx->level ("all"); + } elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level"; + } elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable"; + } elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable"; + } elsif (/^\d$/ ) { $ctx->$level ($_); + } elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_); + } else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n"; + } + } + + /\G,/gc or last; + } + + /\G[:[:space:]]+/gc or last; + } + + /\G[[:space:]]+/gc; # skip trailing whitespace + + if (/\G(.+)/g) { + die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; + } +} + +1; + =head1 EXAMPLES -This section shows some common configurations. +This section shows some common configurations, both as code, and as +C string. =over 4 =item Setting the global logging level. -Either put PERL_ANYEVENT_VERBOSE= into your environment before -running your program, or modify the log level of the root context: +Either put C into your environment before +running your program, use C or modify the log level of +the root context at runtime: PERL_ANYEVENT_VERBOSE=5 ./myprog - $AnyEvent::Log::Root->level ("warn"); + PERL_ANYEVENT_LOG=log=warn + + $AnyEvent::Log::FILTER->level ("warn"); =item Append all messages to a file instead of sending them to STDERR. This is affected by the global logging level. - open my $fh, ">>", $path - or die "$path: $!"; + $AnyEvent::Log::LOG->log_to_file ($path); - $AnyEvent::Log::Default->log_cb (sub { - syswrite $fh, shift; - 0 - }); + PERL_ANYEVENT_LOG=log=file=/some/path =item Write all messages with priority C and higher to a file. @@ -835,32 +1198,35 @@ it is attached to the default context which is invoked I global filtering. - open my $fh, ">>", $path - or die "$path: $!"; + $AnyEvent::Log::FILTER->attach + new AnyEvent::Log::Ctx log_to_file => $path); - $AnyEvent::Log::Default->attach (new AnyEvent::Log::Ctx - log_cb => sub { syswrite $fh, shift; 0 }); + PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path This writes them regardless of the global logging level, because it is attached to the toplevel context, which receives all messages I the global filtering. - $AnyEvent::Log::Top->attach (new AnyEvent::Log::Ctx - log_cb => sub { syswrite $fh, shift; 0 }); + $AnyEvent::Log::COLLECT->attach ( + new AnyEvent::Log::Ctx log_to_file => $path); + + PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger -In both cases, messages are still written to STDOUT. +In both cases, messages are still written to STDERR. =item Write trace messages (only) from L to the default logging target(s). -Attach the CyAnyEvent::Log::Default> context to the C -context and increase the C logging level - this simply -circumvents the global filtering for trace messages. +Attach the C<$AnyEvent::Log::LOG> context to the C +context - this simply circumvents the global filtering for trace messages. my $debug = AnyEvent::Debug->AnyEvent::Log::ctx; - $debug->attach ($AnyEvent::Log::Default); - $debug->levels ("trace"); # not "level"! + $debug->attach ($AnyEvent::Log::LOG); -This of course works for any package. + PERL_ANYEVENT_LOG=AnyEvent::Debug=+log + +This of course works for any package, not just L, but +assumes the log level for AnyEvent::Debug hasn't been changed from the +default. =back @@ -870,3 +1236,4 @@ http://home.schmorp.de/ =cut +