[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Log.pm

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC vs.
Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC

…		…
2		2
3	AnyEvent::Log - simple logging "framework"	3	AnyEvent::Log - simple logging "framework"
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	# simple use	7	Simple uses:
		8
8	use AnyEvent;	9	use AnyEvent;
9		10
10	AE::log debug => "hit my knee";	11	AE::log debug => "hit my knee";
11	AE::log warn => "it's a bit too hot";	12	AE::log warn => "it's a bit too hot";
12	AE::log error => "the flag was false!";	13	AE::log error => "the flag was false!";
13	AE::log fatal => "the bit toggled! run!";	14	AE::log fatal => "the bit toggled! run!"; # never returns
14		15
15	# "complex" use	16	"Complex" uses (for speed sensitive code):
		17
16	use AnyEvent::Log;	18	use AnyEvent::Log;
17		19
18	my $tracer = AnyEvent::Log::logger trace => \$my $trace;	20	my $tracer = AnyEvent::Log::logger trace => \$my $trace;
19		21
20	$tracer->("i am here") if $trace;	22	$tracer->("i am here") if $trace;
21	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;	23	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;
22		24
23	# configuration	25	Configuration (also look at the EXAMPLES section):
24		26
25	# set logging for the current package to errors and higher only	27	# set logging for the current package to errors and higher only
26	AnyEvent::Log::ctx->level ("error");	28	AnyEvent::Log::ctx->level ("error");
27		29
28	# set logging globally to anything below debug	30	# set logging level to suppress anything below "notice"
29	$AnyEvent::Log::FILTER->level ("notice");	31	$AnyEvent::Log::FILTER->level ("notice");
30		32
31	# see also EXAMPLES, below	33	# send all critical and higher priority messages to syslog,
		34	# regardless of (most) other settings
		35	$AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx
		36	level => "critical",
		37	log_to_syslog => 0,
		38	);
32		39
33	=head1 DESCRIPTION	40	=head1 DESCRIPTION
34		41
35	This module implements a relatively simple "logging framework". It doesn't	42	This module implements a relatively simple "logging framework". It doesn't
36	attempt to be "the" logging solution or even "a" logging solution for	43	attempt to be "the" logging solution or even "a" logging solution for
37	AnyEvent - AnyEvent simply creates logging messages internally, and this	44	AnyEvent - AnyEvent simply creates logging messages internally, and this
38	module more or less exposes the mechanism, with some extra spiff to allow	45	module more or less exposes the mechanism, with some extra spiff to allow
39	using it from other modules as well.	46	using it from other modules as well.
40		47
41	Remember that the default verbosity level is C<0>, so nothing will be	48	Remember that the default verbosity level is C<0> (C<off>), so nothing
42	logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before	49	will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number
43	starting your program, or change the logging level at runtime with	50	before starting your program, or change the logging level at runtime with
44	something like:	51	something like:
45		52
46	use AnyEvent::Log;	53	use AnyEvent::Log;
47	AnyEvent::Log::FILTER->level ("info");	54	$AnyEvent::Log::FILTER->level ("info");
48		55
49	The design goal behind this module was to keep it simple (and small),	56	The design goal behind this module was to keep it simple (and small),
50	but make it powerful enough to be potentially useful for any module, and	57	but make it powerful enough to be potentially useful for any module, and
51	extensive enough for the most common tasks, such as logging to multiple	58	extensive enough for the most common tasks, such as logging to multiple
52	targets, or being able to log into a database.	59	targets, or being able to log into a database.
53		60
		61	The module is also usable before AnyEvent itself is initialised, in which
		62	case some of the functionality might be reduced.
		63
54	The amount of documentation might indicate otherwise, but the module is	64	The amount of documentation might indicate otherwise, but the runtime part
55	still just below 300 lines of code.	65	of the module is still just below 300 lines of code.
56		66
57	=head1 LOGGING LEVELS	67	=head1 LOGGING LEVELS
58		68
59	Logging levels in this module range from C<1> (highest priority) to C<9>	69	Logging levels in this module range from C<1> (highest priority) to C<9>
60	(lowest priority). Note that the lowest numerical value is the highest	70	(lowest priority). Note that the lowest numerical value is the highest
…		…
138	$ctx	148	$ctx
139	}	149	}
140		150
141	=item AnyEvent::Log::log $level, $msg[, @args]	151	=item AnyEvent::Log::log $level, $msg[, @args]
142		152
143	Requests logging of the given C<$msg> with the given log level.	153	Requests logging of the given C<$msg> with the given log level, and
		154	returns true if the message was logged I<somewhere>.
144		155
145	For C<fatal> log levels, the program will abort.	156	For C<fatal> log levels, the program will abort.
146		157
147	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the	158	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the
148	C<$msg> is interpreted as an sprintf format string.	159	C<$msg> is interpreted as an sprintf format string.
…		…
154	supposed to return the message. It will be called only then the message	165	supposed to return the message. It will be called only then the message
155	actually gets logged, which is useful if it is costly to create the	166	actually gets logged, which is useful if it is costly to create the
156	message in the first place.	167	message in the first place.
157		168
158	Whether the given message will be logged depends on the maximum log level	169	Whether the given message will be logged depends on the maximum log level
159	and the caller's package.	170	and the caller's package. The return value can be used to ensure that
		171	messages or not "lost" - for example, when L<AnyEvent::Debug> detects a
		172	runtime error it tries to log it at C<die> level, but if that message is
		173	lost it simply uses warn.
160		174
161	Note that you can (and should) call this function as C<AnyEvent::log> or	175	Note that you can (and should) call this function as C<AnyEvent::log> or
162	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't	176	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't
163	need any additional functionality), as those functions will load the	177	need any additional functionality), as those functions will load the
164	logging module on demand only. They are also much shorter to write.	178	logging module on demand only. They are also much shorter to write.
…		…
224	? $level+0	238	? $level+0
225	: $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";	239	: $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";
226		240
227	my $mask = 1 << $level;	241	my $mask = 1 << $level;
228		242
229	my (%seen, @ctx, $now, $fmt);	243	my ($success, %seen, @ctx, $now, $fmt);
230		244
231	do	245	do
232	{	246	{
233	# skip if masked	247	# skip if masked
234	if ($ctx->[1] & $mask && !$seen{$ctx+0}++) {	248	if ($ctx->[1] & $mask && !$seen{$ctx+0}++) {
…		…
238	# now get raw message, unless we have it already	252	# now get raw message, unless we have it already
239	unless ($now) {	253	unless ($now) {
240	$format = $format->() if ref $format;	254	$format = $format->() if ref $format;
241	$format = sprintf $format, @args if @args;	255	$format = sprintf $format, @args if @args;
242	$format =~ s/\n$//;	256	$format =~ s/\n$//;
243	$now = AE::now;	257	$now = now;
244	};	258	};
245		259
246	# format msg	260	# format msg
247	my $str = $ctx->[4]	261	my $str = $ctx->[4]
248	? $ctx->[4]($now, $_[0], $level, $format)	262	? $ctx->[4]($now, $_[0], $level, $format)
249	: $fmt \|\|= _format $now, $_[0], $level, $format;	263	: ($fmt \|\|= _format $now, $_[0], $level, $format);
		264
		265	$success = 1;
250		266
251	$ctx->[3]($str)	267	$ctx->[3]($str)
252	or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate	268	or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate
253	} else {	269	} else {
254	push @ctx, values %{ $ctx->[2] }; # not masked - propagate	270	push @ctx, values %{ $ctx->[2] }; # not masked - propagate
…		…
256	}	272	}
257	}	273	}
258	while $ctx = pop @ctx;	274	while $ctx = pop @ctx;
259		275
260	exit 1 if $level <= 1;	276	exit 1 if $level <= 1;
		277
		278	$success
261	}	279	}
262		280
263	sub log($$;@) {	281	sub log($$;@) {
264	_log	282	_log
265	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],	283	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],
…		…
269	AnyEvent::log = AE::log = \&log;	287	AnyEvent::log = AE::log = \&log;
270		288
271	=item $logger = AnyEvent::Log::logger $level[, \$enabled]	289	=item $logger = AnyEvent::Log::logger $level[, \$enabled]
272		290
273	Creates a code reference that, when called, acts as if the	291	Creates a code reference that, when called, acts as if the
274	C<AnyEvent::Log::log> function was called at this point with the givne	292	C<AnyEvent::Log::log> function was called at this point with the given
275	level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with	293	level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with
276	the C<AnyEvent::Log::log> function:	294	the C<AnyEvent::Log::log> function:
277		295
278	my $debug_log = AnyEvent::Log::logger "debug";	296	my $debug_log = AnyEvent::Log::logger "debug";
279		297
…		…
488		506
489	=cut	507	=cut
490		508
491	sub reset {	509	sub reset {
492	# hard to kill complex data structures	510	# hard to kill complex data structures
493	# we recreate all package loggers and reset the hierarchy	511	# we "recreate" all package loggers and reset the hierarchy
494	while (my ($k, $v) = each %CTX) {	512	while (my ($k, $v) = each %CTX) {
495	@$v = ($k, (1 << 10) - 1 - 1, { });	513	@$v = ($k, (1 << 10) - 1 - 1, { });
496		514
497	$v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log);	515	$v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log::COLLECT);
498	}	516	}
499		517
		518	@$_ = ($_->[0], (1 << 10) - 1 - 1)
		519	for $LOG, $FILTER, $COLLECT;
		520
500	$LOG->slaves;	521	#$LOG->slaves;
501	$LOG->title ('$AnyEvent::Log::LOG');	522	$LOG->title ('$AnyEvent::Log::LOG');
502	$LOG->log_cb (sub {	523	$LOG->log_to_warn;
503	warn shift;
504	0
505	});
506		524
507	$FILTER->slaves ($LOG);	525	$FILTER->slaves ($LOG);
508	$FILTER->title ('$AnyEvent::Log::FILTER');	526	$FILTER->title ('$AnyEvent::Log::FILTER');
509	$FILTER->level ($AnyEvent::VERBOSE);	527	$FILTER->level ($AnyEvent::VERBOSE);
510		528
511	$COLLECT->slaves ($FILTER);	529	$COLLECT->slaves ($FILTER);
512	$COLLECT->title ('$AnyEvent::Log::FILTER');	530	$COLLECT->title ('$AnyEvent::Log::COLLECT');
513		531
514	_reassess;	532	_reassess;
515	}	533	}
516		534
517	# create the default logger contexts	535	# create the default logger contexts
…		…
731	the logging (which consists of formatting the message and printing it or	749	the logging (which consists of formatting the message and printing it or
732	whatever it wants to do with it).	750	whatever it wants to do with it).
733		751
734	=over 4	752	=over 4
735		753
736	=item $ctx->log_cb ($cb->($str))	754	=item $ctx->log_cb ($cb->($str)
737		755
738	Replaces the logging callback on the context (C<undef> disables the	756	Replaces the logging callback on the context (C<undef> disables the
739	logging callback).	757	logging callback).
740		758
741	The logging callback is responsible for handling formatted log messages	759	The logging callback is responsible for handling formatted log messages
…		…
760	your program.	778	your program.
761		779
762	$ctx->levels ("debug", "trace");	780	$ctx->levels ("debug", "trace");
763	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages	781	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages
764		782
765	=item $ctx->log_to_file ($path)
766
767	Sets the C<log_cb> to log to a file (by appending), unbuffered.
768
769	=item $ctx->log_to_path ($path)
770
771	Same as C<< ->log_to_file >>, but opens the file for each message. This
772	is much slower, but allows you to change/move/rename/delete the file at
773	basically any time.
774
775	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))	783	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message))
776		784
777	Replaces the formatting callback on the context (C<undef> restores the	785	Replaces the formatting callback on the context (C<undef> restores the
778	default formatter).	786	default formatter).
779		787
780	The callback is passed the (possibly fractional) timestamp, the original	788	The callback is passed the (possibly fractional) timestamp, the original
781	logging context, the (numeric) logging level and the raw message string	789	logging context, the (numeric) logging level and the raw message string
782	and needs to return a formatted log message. In most cases this will be a	790	and needs to return a formatted log message. In most cases this will be a
783	string, but it could just as well be an array reference that just stores	791	string, but it could just as well be an array reference that just stores
784	the values.	792	the values.
785		793
786	If, for some reaosn, you want to use C<caller> to find out more baout the	794	If, for some reason, you want to use C<caller> to find out more baout the
787	logger then you should walk up the call stack until you are no longer	795	logger then you should walk up the call stack until you are no longer
788	inside the C<AnyEvent::Log> package.	796	inside the C<AnyEvent::Log> package.
789		797
790	Example: format just the raw message, with numeric log level in angle	798	Example: format just the raw message, with numeric log level in angle
791	brackets.	799	brackets.
…		…
810	"$msg->[3]";	818	"$msg->[3]";
811		819
812	0	820	0
813	});	821	});
814		822
		823	=item $ctx->log_to_warn
		824
		825	Sets the C<log_cb> to simply use C<CORE::warn> to report any messages
		826	(usually this logs to STDERR).
		827
		828	=item $ctx->log_to_file ($path)
		829
		830	Sets the C<log_cb> to log to a file (by appending), unbuffered.
		831
		832	=item $ctx->log_to_path ($path)
		833
		834	Same as C<< ->log_to_file >>, but opens the file for each message. This
		835	is much slower, but allows you to change/move/rename/delete the file at
		836	basically any time.
		837
		838	Needless(?) to say, if you do not want to be bitten by some evil person
		839	calling C<chdir>, the path should be absolute. Doesn't help with
		840	C<chroot>, but hey...
		841
		842	=item $ctx->log_to_syslog ([$log_flags])
		843
		844	Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all
		845	the others in the obvious way. If specified, then the C<$log_flags> are
		846	simply or'ed onto the priority argument and can contain any C<LOG_xxx>
		847	flags valid for Sys::Syslog::syslog, except for the priority levels.
		848
		849	Note that this function also sets a C<fmt_cb> - the logging part requires
		850	an array reference with [$level, $str] as input.
		851
815	=cut	852	=cut
816		853
817	sub log_cb {	854	sub log_cb {
818	my ($ctx, $cb) = @_;	855	my ($ctx, $cb) = @_;
819		856
…		…
822		859
823	sub fmt_cb {	860	sub fmt_cb {
824	my ($ctx, $cb) = @_;	861	my ($ctx, $cb) = @_;
825		862
826	$ctx->[4] = $cb;	863	$ctx->[4] = $cb;
		864	}
		865
		866	sub log_to_warn {
		867	my ($ctx, $path) = @_;
		868
		869	$ctx->log_cb (sub {
		870	warn shift;
		871	0
		872	});
827	}	873	}
828		874
829	sub log_to_file {	875	sub log_to_file {
830	my ($ctx, $path) = @_;	876	my ($ctx, $path) = @_;
831		877
…		…
836	syswrite $fh, shift;	882	syswrite $fh, shift;
837	0	883	0
838	});	884	});
839	}	885	}
840		886
841	sub log_to_file {	887	sub log_to_path {
842	my ($ctx, $path) = @_;	888	my ($ctx, $path) = @_;
843		889
844	$ctx->log_cb (sub {	890	$ctx->log_cb (sub {
845	open my $fh, ">>", $path	891	open my $fh, ">>", $path
846	or die "$path: $!";	892	or die "$path: $!";
…		…
848	syswrite $fh, shift;	894	syswrite $fh, shift;
849	0	895	0
850	});	896	});
851	}	897	}
852		898
		899	sub log_to_syslog {
		900	my ($ctx, $flags) = @_;
		901
		902	require Sys::Syslog;
		903
		904	$ctx->fmt_cb (sub {
		905	my $str = $_[3];
		906	$str =~ s/\n(?=.)/\n+ /g;
		907
		908	[$_[2], "($_[1][0]) $str"]
		909	});
		910
		911	$ctx->log_cb (sub {
		912	my $lvl = $_[0][0] < 9 ? $_[0][0] : 8;
		913
		914	Sys::Syslog::syslog ($flags \| ($lvl - 1), $_)
		915	for split /\n/, $_[0][1];
		916
		917	0
		918	});
		919	}
		920
853	=back	921	=back
854		922
855	=head3 MESSAGE LOGGING	923	=head3 MESSAGE LOGGING
856		924
857	These methods allow you to log messages directly to a context, without	925	These methods allow you to log messages directly to a context, without
…		…
871	=cut	939	=cut
872		940
873	*log = \&AnyEvent::Log::_log;	941	*log = \&AnyEvent::Log::_log;
874	*logger = \&AnyEvent::Log::_logger;	942	*logger = \&AnyEvent::Log::_logger;
875		943
		944	=back
		945
		946	=cut
		947
		948	package AnyEvent::Log;
		949
		950	=head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG}
		951
		952	Logging can also be configured by setting the environment variable
		953	C<PERL_ANYEVENT_LOG> (or C<AE_LOG>).
		954
		955	The value consists of one or more logging context specifications separated
		956	by C<:> or whitespace. Each logging specification in turn starts with a
		957	context name, followed by C<=>, followed by zero or more comma-separated
		958	configuration directives, here are some examples:
		959
		960	# set default logging level
		961	filter=warn
		962
		963	# log to file instead of to stderr
		964	log=file=/tmp/mylog
		965
		966	# log to file in addition to stderr
		967	log=+%file:%file=file=/tmp/mylog
		968
		969	# enable debug log messages, log warnings and above to syslog
		970	filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0
		971
		972	# log trace messages (only) from AnyEvent::Debug to file
		973	AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog
		974
		975	A context name in the log specification can be any of the following:
		976
		977	=over 4
		978
		979	=item C<collect>, C<filter>, C<log>
		980
		981	Correspond to the three predefined C<$AnyEvent::Log::COLLECT>,
		982	C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts.
		983
		984	=item C<%name>
		985
		986	Context names starting with a C<%> are anonymous contexts created when the
		987	name is first mentioned. The difference to package contexts is that by
		988	default they have no attached slaves.
		989
		990	=item a perl package name
		991
		992	Any other string references the logging context associated with the given
		993	Perl C<package>. In the unlikely case where you want to specify a package
		994	context that matches on of the other context name forms, you can add a
		995	C<::> to the package name to force interpretation as a package.
		996
		997	=back
		998
		999	The configuration specifications can be any number of the following:
		1000
		1001	=over 4
		1002
		1003	=item C<stderr>
		1004
		1005	Configures the context to use Perl's C<warn> function (which typically
		1006	logs to C<STDERR>). Works like C<log_to_warn>.
		1007
		1008	=item C<file=>I<path>
		1009
		1010	Configures the context to log to a file with the given path. Works like
		1011	C<log_to_file>.
		1012
		1013	=item C<path=>I<path>
		1014
		1015	Configures the context to log to a file with the given path. Works like
		1016	C<log_to_path>.
		1017
		1018	=item C<syslog> or C<syslog=>I<expr>
		1019
		1020	Configures the context to log to syslog. If I<expr> is given, then it is
		1021	evaluated in the L<Sys::Syslog> package, so you could use:
		1022
		1023	log=syslog=LOG_LOCAL0
		1024
		1025	=item C<nolog>
		1026
		1027	Configures the context to not log anything by itself, which is the
		1028	default. Same as C<< $ctx->log_cb (undef) >>.
		1029
		1030	=item C<0> or C<off>
		1031
		1032	Sets the logging level of the context ot C<0>, i.e. all messages will be
		1033	filtered out.
		1034
		1035	=item C<all>
		1036
		1037	Enables all logging levels, i.e. filtering will effectively be switched
		1038	off (the default).
		1039
		1040	=item C<only>
		1041
		1042	Disables all logging levels, and changes the interpretation of following
		1043	level specifications to enable the specified level only.
		1044
		1045	Example: only enable debug messages for a context.
		1046
		1047	context=only,debug
		1048
		1049	=item C<except>
		1050
		1051	Enables all logging levels, and changes the interpretation of following
		1052	level specifications to disable that level. Rarely used.
		1053
		1054	Example: enable all logging levels except fatal and trace (this is rather
		1055	nonsensical).
		1056
		1057	filter=exept,fatal,trace
		1058
		1059	=item C<level>
		1060
		1061	Enables all logging levels, and changes the interpretation of following
		1062	level specifications to be "that level or any higher priority
		1063	message". This is the default.
		1064
		1065	Example: log anything at or above warn level.
		1066
		1067	filter=warn
		1068
		1069	# or, more verbose
		1070	filter=only,level,warn
		1071
		1072	=item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.)
		1073
		1074	A numeric loglevel or the name of a loglevel will be interpreted according
		1075	to the most recent C<only>, C<except> or C<level> directive. By default,
		1076	specifying a logging level enables that and any higher priority messages.
		1077
		1078	=item C<+>I<context>
		1079
		1080	Attaches the named context as slave to the context.
		1081
		1082	=item C<+>
		1083
		1084	A line C<+> detaches all contexts, i.e. clears the slave list from the
		1085	context. Anonymous (C<%name>) contexts have no attached slaves by default,
		1086	but package contexts have the parent context as slave by default.
		1087
		1088	Example: log messages from My::Module to a file, do not send them to the
		1089	default log collector.
		1090
		1091	My::Module=+,file=/tmp/mymodulelog
		1092
		1093	=back
		1094
		1095	Any character can be escaped by prefixing it with a C<\> (backslash), as
		1096	usual, so to log to a file containing a comma, colon, backslash and some
		1097	spaces in the filename, you would do this:
		1098
		1099	PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes'
		1100
		1101	Since whitespace (which includes newlines) is allowed, it is fine to
		1102	specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.:
		1103
		1104	PERL_ANYEVENT_LOG="
		1105	filter=warn
		1106	AnyEvent::Debug=+%trace
		1107	%trace=only,trace,+log
		1108	" myprog
		1109
		1110	Also, in the unlikely case when you want to concatenate specifications,
		1111	use whitespace as separator, as C<::> will be interpreted as part of a
		1112	module name, an empty spec with two separators:
		1113
		1114	PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug"
		1115
		1116	=cut
		1117
		1118	for (my $spec = $ENV{PERL_ANYEVENT_LOG}) {
		1119	my %anon;
		1120
		1121	my $pkg = sub {
		1122	$_[0] eq "log" ? $LOG
		1123	: $_[0] eq "filter" ? $FILTER
		1124	: $_[0] eq "collect" ? $COLLECT
		1125	: $_[0] =~ /^%(.+)$/ ? ($anon{$1} \|\|= ctx undef)
		1126	: $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/
		1127	: die # never reached?
		1128	};
		1129
		1130	/\G[[:space:]]+/gc; # skip initial whitespace
		1131
		1132	while (/\G((?:[^:=[:space:]]+\|::\|\\.)+)=/gc) {
		1133	my $ctx = $pkg->($1);
		1134	my $level = "level";
		1135
		1136	while (/\G((?:[^,:[:space:]]+\|::\|\\.)+)/gc) {
		1137	for ("$1") {
		1138	if ($_ eq "stderr" ) { $ctx->log_to_warn;
		1139	} elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1");
		1140	} elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1");
		1141	} elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog (eval "package Sys::Syslog; $1");
		1142	} elsif ($_ eq "nolog" ) { $ctx->log_cb (undef);
		1143	} elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1"));
		1144	} elsif ($_ eq "+" ) { $ctx->slaves;
		1145	} elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0);
		1146	} elsif ($_ eq "all" ) { $ctx->level ("all");
		1147	} elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level";
		1148	} elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable";
		1149	} elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable";
		1150	} elsif (/^\d$/ ) { $ctx->$level ($_);
		1151	} elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_);
		1152	} else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n";
		1153	}
		1154	}
		1155
		1156	/\G,/gc or last;
		1157	}
		1158
		1159	/\G[:[:space:]]+/gc or last;
		1160	}
		1161
		1162	/\G[[:space:]]+/gc; # skip trailing whitespace
		1163
		1164	if (/\G(.+)/g) {
		1165	die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n";
		1166	}
		1167	}
		1168
876	1;	1169	1;
877		1170
878	=back
879
880	=head1 EXAMPLES	1171	=head1 EXAMPLES
881		1172
882	This section shows some common configurations.	1173	This section shows some common configurations, both as code, and as
		1174	C<PERL_ANYEVENT_LOG> string.
883		1175
884	=over 4	1176	=over 4
885		1177
886	=item Setting the global logging level.	1178	=item Setting the global logging level.
887		1179
888	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before	1180	Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before
889	running your program, or modify the log level of the root context:	1181	running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of
		1182	the root context at runtime:
890		1183
891	PERL_ANYEVENT_VERBOSE=5 ./myprog	1184	PERL_ANYEVENT_VERBOSE=5 ./myprog
892		1185
		1186	PERL_ANYEVENT_LOG=log=warn
		1187
893	$AnyEvent::Log::FILTER->level ("warn");	1188	$AnyEvent::Log::FILTER->level ("warn");
894		1189
895	=item Append all messages to a file instead of sending them to STDERR.	1190	=item Append all messages to a file instead of sending them to STDERR.
896		1191
897	This is affected by the global logging level.	1192	This is affected by the global logging level.
898		1193
899	$AnyEvent::Log::LOG->log_to_file ($path); (sub {	1194	$AnyEvent::Log::LOG->log_to_file ($path);
		1195
		1196	PERL_ANYEVENT_LOG=log=file=/some/path
900		1197
901	=item Write all messages with priority C<error> and higher to a file.	1198	=item Write all messages with priority C<error> and higher to a file.
902		1199
903	This writes them only when the global logging level allows it, because	1200	This writes them only when the global logging level allows it, because
904	it is attached to the default context which is invoked I<after> global	1201	it is attached to the default context which is invoked I<after> global
905	filtering.	1202	filtering.
906		1203
907	$AnyEvent::Log::FILTER->attach	1204	$AnyEvent::Log::FILTER->attach
908	new AnyEvent::Log::Ctx log_to_file => $path);	1205	new AnyEvent::Log::Ctx log_to_file => $path);
909		1206
		1207	PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path
		1208
910	This writes them regardless of the global logging level, because it is	1209	This writes them regardless of the global logging level, because it is
911	attached to the toplevel context, which receives all messages I<before>	1210	attached to the toplevel context, which receives all messages I<before>
912	the global filtering.	1211	the global filtering.
913		1212
914	$AnyEvent::Log::COLLECT->attach (	1213	$AnyEvent::Log::COLLECT->attach (
915	new AnyEvent::Log::Ctx log_to_file => $path);	1214	new AnyEvent::Log::Ctx log_to_file => $path);
916		1215
		1216	PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger
		1217
917	In both cases, messages are still written to STDERR.	1218	In both cases, messages are still written to STDERR.
918		1219
919	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).	1220	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).
920		1221
921	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>	1222	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>
922	context - this simply circumvents the global filtering for trace messages.	1223	context - this simply circumvents the global filtering for trace messages.
923		1224
924	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;	1225	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
925	$debug->attach ($AnyEvent::Log::LOG);	1226	$debug->attach ($AnyEvent::Log::LOG);
		1227
		1228	PERL_ANYEVENT_LOG=AnyEvent::Debug=+log
926		1229
927	This of course works for any package, not just L<AnyEvent::Debug>, but	1230	This of course works for any package, not just L<AnyEvent::Debug>, but
928	assumes the log level for AnyEvent::Debug hasn't been changed from the	1231	assumes the log level for AnyEvent::Debug hasn't been changed from the
929	default.	1232	default.
930		1233
…		…
934		1237
935	Marc Lehmann <schmorp@schmorp.de>	1238	Marc Lehmann <schmorp@schmorp.de>
936	http://home.schmorp.de/	1239	http://home.schmorp.de/
937		1240
938	=cut	1241	=cut
		1242

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC vs. Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC vs.
Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC