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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC vs.
Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC

…		…
20	$tracer->("i am here") if $trace;	20	$tracer->("i am here") if $trace;
21	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;	21	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;
22		22
23	# configuration	23	# configuration
24		24
25	# set logging for this package to errors and higher only	25	# set logging for the current package to errors and higher only
26	AnyEvent::Log::ctx->level ("error");	26	AnyEvent::Log::ctx->level ("error");
27		27
28	# set logging globally to anything below debug	28	# set logging globally to anything below debug
29	$AnyEvent::Log::Root->level ("notice");	29	$AnyEvent::Log::FILTER->level ("notice");
30		30
31	# see also EXAMPLES, below	31	# see also EXAMPLES, below
32		32
33	=head1 DESCRIPTION	33	=head1 DESCRIPTION
34		34
…		…
41	Remember that the default verbosity level is C<0>, so nothing will be	41	Remember that the default verbosity level is C<0>, so nothing will be
42	logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before	42	logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before
43	starting your program, or change the logging level at runtime with	43	starting your program, or change the logging level at runtime with
44	something like:	44	something like:
45		45
46	use AnyEvent;	46	use AnyEvent::Log;
47	(AnyEvent::Log::ctx "")->level ("info");	47	AnyEvent::Log::FILTER->level ("info");
48		48
49	The design goal behind this module was to keep it simple (and small),	49	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	50	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	51	extensive enough for the most common tasks, such as logging to multiple
52	targets, or being able to log into a database.	52	targets, or being able to log into a database.
53		53
54	The amount of documentation might indicate otherwise, but the module is	54	The amount of documentation might indicate otherwise, but the module is
55	still just 240 lines or so.	55	still just below 300 lines of code.
		56
		57	=head1 LOGGING LEVELS
		58
		59	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
		61	priority, so when this document says "higher priority" it means "lower
		62	numerical value".
		63
		64	Instead of specifying levels by name you can also specify them by aliases:
		65
		66	LVL NAME SYSLOG PERL NOTE
		67	1 fatal emerg exit aborts program!
		68	2 alert
		69	3 critical crit
		70	4 error err die
		71	5 warn warning
		72	6 note notice
		73	7 info
		74	8 debug
		75	9 trace
		76
		77	As you can see, some logging levels have multiple aliases - the first one
		78	is the "official" name, the second one the "syslog" name (if it differs)
		79	and the third one the "perl" name, suggesting that you log C<die> messages
		80	at C<error> priority.
		81
		82	You can normally only log a single message at highest priority level
		83	(C<1>, C<fatal>), because logging a fatal message will also quit the
		84	program - so use it sparingly :)
		85
		86	Some methods also offer some extra levels, such as C<0>, C<off>, C<none>
		87	or C<all> - these are only valid in the methods they are documented for.
56		88
57	=head1 LOGGING FUNCTIONS	89	=head1 LOGGING FUNCTIONS
58		90
59	These functions allow you to log messages. They always use the caller's	91	These functions allow you to log messages. They always use the caller's
60	package as a "logging module/source". Also, the main logging function is	92	package as a "logging context". Also, the main logging function C<log> is
61	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is	93	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is
62	loaded.	94	loaded.
63		95
64	=over 4	96	=over 4
65		97
…		…
72		104
73	use AnyEvent (); BEGIN { AnyEvent::common_sense }	105	use AnyEvent (); BEGIN { AnyEvent::common_sense }
74	use AnyEvent::Util ();	106	use AnyEvent::Util ();
75		107
76	our $VERSION = $AnyEvent::VERSION;	108	our $VERSION = $AnyEvent::VERSION;
		109
		110	our ($COLLECT, $FILTER, $LOG);
77		111
78	our ($now_int, $now_str1, $now_str2);	112	our ($now_int, $now_str1, $now_str2);
79		113
80	# Format Time, not public - yet?	114	# Format Time, not public - yet?
81	sub ft($) {	115	sub ft($) {
…		…
86	if $now_int != $i;	120	if $now_int != $i;
87		121
88	"$now_str1$f$now_str2"	122	"$now_str1$f$now_str2"
89	}	123	}
90		124
91	our %CTX; # all logging contexts	125	our %CTX; # all package contexts
92		126
93	# creates a default package context object for the given package	127	# creates a default package context object for the given package
94	sub _pkg_ctx($) {	128	sub _pkg_ctx($) {
95	my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx";	129	my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx";
96		130
97	# link "parent" package	131	# link "parent" package
98	my $pkg = $_[0] =~ /^(.+)::/ ? $1 : "AE::Log::Top";	132	my $parent = $_[0] =~ /^(.+)::/
		133	? $CTX{$1} \|\|= &_pkg_ctx ("$1")
		134	: $COLLECT;
99		135
100	$pkg = $CTX{$pkg} \|\|= &_pkg_ctx ($pkg);
101	$ctx->[2]{$pkg+0} = $pkg;	136	$ctx->[2]{$parent+0} = $parent;
102		137
103	$ctx	138	$ctx
104	}	139	}
105		140
106	=item AnyEvent::Log::log $level, $msg[, @args]	141	=item AnyEvent::Log::log $level, $msg[, @args]
107		142
108	Requests logging of the given C<$msg> with the given log level (1..9).	143	Requests logging of the given C<$msg> with the given log level.
109	You can also use the following strings as log level: C<fatal> (1),
110	C<alert> (2), C<critical> (3), C<error> (4), C<warn> (5), C<note> (6),
111	C<info> (7), C<debug> (8), C<trace> (9).
112		144
113	For C<fatal> log levels, the program will abort.	145	For C<fatal> log levels, the program will abort.
114		146
115	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the	147	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the
116	C<$msg> is interpreted as an sprintf format string.	148	C<$msg> is interpreted as an sprintf format string.
…		…
149		181
150	=cut	182	=cut
151		183
152	# also allow syslog equivalent names	184	# also allow syslog equivalent names
153	our %STR2LEVEL = (	185	our %STR2LEVEL = (
154	fatal => 1, emerg => 1,	186	fatal => 1, emerg => 1, exit => 1,
155	alert => 2,	187	alert => 2,
156	critical => 3, crit => 3,	188	critical => 3, crit => 3,
157	error => 4, err => 4,	189	error => 4, err => 4, die => 4,
158	warn => 5, warning => 5,	190	warn => 5, warning => 5,
159	note => 6, notice => 6,	191	note => 6, notice => 6,
160	info => 7,	192	info => 7,
161	debug => 8,	193	debug => 8,
162	trace => 9,	194	trace => 9,
…		…
214	# format msg	246	# format msg
215	my $str = $ctx->[4]	247	my $str = $ctx->[4]
216	? $ctx->[4]($now, $_[0], $level, $format)	248	? $ctx->[4]($now, $_[0], $level, $format)
217	: $fmt \|\|= _format $now, $_[0], $level, $format;	249	: $fmt \|\|= _format $now, $_[0], $level, $format;
218		250
219	$ctx->[3]($str);	251	$ctx->[3]($str)
		252	or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate
		253	} else {
		254	push @ctx, values %{ $ctx->[2] }; # not masked - propagate
220	}	255	}
221
222	# not masked, not consumed - propagate to parent contexts
223	push @ctx, values %{ $ctx->[2] };
224	}	256	}
225	}	257	}
226	while $ctx = pop @ctx;	258	while $ctx = pop @ctx;
227		259
228	exit 1 if $level <= 1;	260	exit 1 if $level <= 1;
…		…
347	timestamp, context, level and string message and formats it in the way	379	timestamp, context, level and string message and formats it in the way
348	it should be logged) and a logging callback (which is responsible for	380	it should be logged) and a logging callback (which is responsible for
349	actually logging the formatted message and telling C<AnyEvent::Log>	381	actually logging the formatted message and telling C<AnyEvent::Log>
350	whether it has consumed the message, or whether it should be propagated).	382	whether it has consumed the message, or whether it should be propagated).
351		383
352	For propagation, a context can have any number of attached I<parent	384	For propagation, a context can have any number of attached I<slave
353	contexts>. Any message that is neither masked by the logging mask nor	385	contexts>. Any message that is neither masked by the logging mask nor
354	masked by the logging callback returning true will be passed to all parent	386	masked by the logging callback returning true will be passed to all slave
355	contexts.	387	contexts.
356		388
357	Each call to a logging function will log the message at most once per	389	Each call to a logging function will log the message at most once per
358	context, so it does not matter (much) if there are cycles or if the	390	context, so it does not matter (much) if there are cycles or if the
359	message can arrive at the same context via multiple paths.	391	message can arrive at the same context via multiple paths.
…		…
363	By default, all logging contexts have an full set of log levels ("all"), a	395	By default, all logging contexts have an full set of log levels ("all"), a
364	disabled logging callback and the default formatting callback.	396	disabled logging callback and the default formatting callback.
365		397
366	Package contexts have the package name as logging title by default.	398	Package contexts have the package name as logging title by default.
367		399
368	They have exactly one parent - the context of the "parent" package. The	400	They have exactly one slave - the context of the "parent" package. The
369	parent package is simply defined to be the package name without the last	401	parent package is simply defined to be the package name without the last
370	component, i.e. C<AnyEvent::Debug::Wrapped> becomes C<AnyEvent::Debug>,	402	component, i.e. C<AnyEvent::Debug::Wrapped> becomes C<AnyEvent::Debug>,
371	and C<AnyEvent> becomes ... C<AnyEvent::Log::Top> which is the	403	and C<AnyEvent> becomes ... C<$AnyEvent::Log::COLLECT> which is the
372	exception of the rule - just like the parent of any package name in	404	exception of the rule - just like the "parent" of any single-component
373	Perl is C<main>, the default parent of any top-level package context is	405	package name in Perl is C<main>, the default slave of any top-level
374	C<AnyEvent::Log::Top>.	406	package context is C<$AnyEvent::Log::COLLECT>.
375		407
376	Since perl packages form only an approximate hierarchy, this parent	408	Since perl packages form only an approximate hierarchy, this slave
377	context can of course be removed.	409	context can of course be removed.
378		410
379	All other (anonymous) contexts have no parents and an empty title by	411	All other (anonymous) contexts have no slaves and an empty title by
380	default.	412	default.
381		413
382	When the module is loaded it creates the default context called	414	When the module is loaded it creates the C<$AnyEvent::Log::LOG> logging
383	C<AnyEvent::Log::Default> (also stored in C<$AnyEvent::Log::Default>),	415	context that simply logs everything via C<warn>, without propagating
384	which simply logs everything via C<warn> and doesn't propagate anything
385	anywhere by default. The purpose of the default context is to provide	416	anything anywhere by default. The purpose of this context is to provide
386	a convenient place to override the global logging target or to attach	417	a convenient place to override the global logging target or to attach
387	additional log targets. It's not meant for filtering.	418	additional log targets. It's not meant for filtering.
388		419
389	It then creates the root context called C<AnyEvent::Log::Root> (also	420	It then creates the C<$AnyEvent::Log::FILTER> context whose
390	stored in C<$AnyEvent::Log::Root>) and sets its log level set to all	421	purpose is to suppress all messages with priority higher
391	levels up to the one specified by C<$ENV{PERL_ANYEVENT_VERBOSE}>. It	422	than C<$ENV{PERL_ANYEVENT_VERBOSE}>. It then attached the
392	then attached the default logging context to it. The purpose of the root	423	C<$AnyEvent::Log::LOG> context to it. The purpose of the filter context
393	context is to simply provide filtering according to some global log level.	424	is to simply provide filtering according to some global log level.
394		425
395	Finally it creates the top-level package context called	426	Finally it creates the top-level package context C<$AnyEvent::Log::COLLECT>
396	C<AnyEvent::Log::Top> (also stored in, you might have guessed,	427	and attaches the C<$AnyEvent::Log::FILTER> context to it, but otherwise
397	C<$AnyEvent::Log::Top>) and attached the root context but otherwise leaves
398	it at default config. It's purpose is simply to collect all log messages	428	leaves it at default config. Its purpose is simply to collect all log
399	system-wide.	429	messages system-wide.
400		430
401	These three special contexts can also be referred to by the	431	The hierarchy is then:
402	package/context names C<AE::Log::Default>, C<AE::Log::Root> and
403	C<AE::Log::Top>.
404		432
		433	any package, eventually -> $COLLECT -> $FILTER -> $LOG
		434
405	The effect of all this is that log messages, by default, wander up	435	The effect of all this is that log messages, by default, wander up to the
406	to the root context where log messages with lower priority then	436	C<$AnyEvent::Log::COLLECT> context where all messages normally end up,
		437	from there to C<$AnyEvent::Log::FILTER> where log messages with lower
407	C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered away and then to the	438	priority then C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered out and then
408	AnyEvent::Log::Default context to be passed to C<warn>.	439	to the C<$AnyEvent::Log::LOG> context to be passed to C<warn>.
409		440
410	Splitting the top level context into three contexts makes it easy to set	441	This makes it easy to set a global logging level (by modifying $FILTER),
411	a global logging level (by modifying the root context), but still allow	442	but still allow other contexts to send, for example, their debug and trace
412	other contexts to log, for example, their debug and trace messages to the
413	default target despite the global logging level, or to attach additional	443	messages to the $LOG target despite the global logging level, or to attach
414	log targets that log messages, regardless of the global logging level.	444	additional log targets that log messages, regardless of the global logging
		445	level.
415		446
416	It also makes it easy to replace the default warn-logger by something that	447	It also makes it easy to modify the default warn-logger ($LOG) to
417	logs to a file, or to attach additional logging targets.	448	something that logs to a file, or to attach additional logging targets
		449	(such as loggign to a file) by attaching it to $FILTER.
418		450
419	=head2 CREATING/FINDING/DESTROYING CONTEXTS	451	=head2 CREATING/FINDING/DESTROYING CONTEXTS
420		452
421	=over 4	453	=over 4
422		454
…		…
460	# hard to kill complex data structures	492	# hard to kill complex data structures
461	# we recreate all package loggers and reset the hierarchy	493	# we recreate all package loggers and reset the hierarchy
462	while (my ($k, $v) = each %CTX) {	494	while (my ($k, $v) = each %CTX) {
463	@$v = ($k, (1 << 10) - 1 - 1, { });	495	@$v = ($k, (1 << 10) - 1 - 1, { });
464		496
465	my $pkg = $k =~ /^(.+)::/ ? $1 : "AE::Log::Top";	497	$v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log);
466	$v->attach ($CTX{$pkg});
467	}	498	}
468		499
469	$AnyEvent::Log::Default->parents;	500	$LOG->slaves;
470	$AnyEvent::Log::Default->title ("AnyEvent::Log::Default");	501	$LOG->title ('$AnyEvent::Log::LOG');
471	$AnyEvent::Log::Default->log_cb (sub {	502	$LOG->log_cb (sub {
472	warn shift;	503	warn shift;
473	0	504	0
474	});	505	});
475	$CTX{"AnyEvent::Log::Default"} = $CTX{"AE::Log::Default"} = $AnyEvent::Log::Default;
476		506
477	$AnyEvent::Log::Root->parents ($AnyEvent::Log::Default);	507	$FILTER->slaves ($LOG);
478	$AnyEvent::Log::Root->title ("AnyEvent::Log::Root");	508	$FILTER->title ('$AnyEvent::Log::FILTER');
479	$AnyEvent::Log::Root->level ($AnyEvent::VERBOSE);	509	$FILTER->level ($AnyEvent::VERBOSE);
480	$CTX{"AnyEvent::Log::Root"} = $CTX{"AE::Log::Root"} = $AnyEvent::Log::Root;
481		510
482	$AnyEvent::Log::Top->parents ($AnyEvent::Log::Root);	511	$COLLECT->slaves ($FILTER);
483	$AnyEvent::Log::Top->title ("AnyEvent::Log::Top");	512	$COLLECT->title ('$AnyEvent::Log::FILTER');
484	$CTX{"AnyEvent::Log::Top"} = $CTX{"AE::Log::Top"} = $AnyEvent::Log::Top;
485		513
486	_reassess;	514	_reassess;
487	}	515	}
488		516
489	# create the default logger contexts	517	# create the default logger contexts
490	$AnyEvent::Log::Default = ctx undef;	518	$LOG = ctx undef;
491	$AnyEvent::Log::Root = ctx undef;	519	$FILTER = ctx undef;
492	$AnyEvent::Log::Top = ctx undef;	520	$COLLECT = ctx undef;
493		521
494	AnyEvent::Log::reset;	522	AnyEvent::Log::reset;
495		523
496	# hello, CPAN, please catch me	524	# hello, CPAN, please catch me
497	package AnyEvent::Log::Default;
498	package AE::Log::Default;
499	package AnyEvent::Log::Root;
500	package AE::Log::Root;
501	package AnyEvent::Log::Top;	525	package AnyEvent::Log::LOG;
502	package AE::Log::Top;	526	package AE::Log::LOG;
		527	package AnyEvent::Log::FILTER;
		528	package AE::Log::FILTER;
		529	package AnyEvent::Log::COLLECT;
		530	package AE::Log::COLLECT;
503		531
504	package AnyEvent::Log::Ctx;	532	package AnyEvent::Log::Ctx;
505		533
506	# 0 1 2 3 4	534	# 0 1 2 3 4
507	# [$title, $level, %$parents, &$logcb, &$fmtcb]	535	# [$title, $level, %$slaves, &$logcb, &$fmtcb]
508		536
509	=item $ctx = new AnyEvent::Log::Ctx methodname => param...	537	=item $ctx = new AnyEvent::Log::Ctx methodname => param...
510		538
511	This is a convenience constructor that makes it simpler to construct	539	This is a convenience constructor that makes it simpler to construct
512	anonymous logging contexts.	540	anonymous logging contexts.
…		…
515	name as the key with the value as parameter, unless the value is an	543	name as the key with the value as parameter, unless the value is an
516	arrayref, in which case it calls the method with the contents of the	544	arrayref, in which case it calls the method with the contents of the
517	array. The methods are called in the same order as specified.	545	array. The methods are called in the same order as specified.
518		546
519	Example: create a new logging context and set both the default logging	547	Example: create a new logging context and set both the default logging
520	level, some parent contexts and a logging callback.	548	level, some slave contexts and a logging callback.
521		549
522	$ctx = new AnyEvent::Log::Ctx	550	$ctx = new AnyEvent::Log::Ctx
523	title => "dubious messages",	551	title => "dubious messages",
524	level => "error",	552	level => "error",
525	log_cb => sub { print STDOUT shift; 0 },	553	log_cb => sub { print STDOUT shift; 0 },
526	parents => [$ctx1, $ctx, $ctx2],	554	slaves => [$ctx1, $ctx, $ctx2],
527	;	555	;
528		556
529	=back	557	=back
530		558
531	=cut	559	=cut
…		…
644	AnyEvent::Log::_reassess;	672	AnyEvent::Log::_reassess;
645	}	673	}
646		674
647	=back	675	=back
648		676
649	=head3 PARENT CONTEXTS	677	=head3 SLAVE CONTEXTS
650		678
651	The following methods attach and detach another logging context to a	679	The following methods attach and detach another logging context to a
652	logging context.	680	logging context.
653		681
654	Log messages are propagated to all parent contexts, unless the logging	682	Log messages are propagated to all slave contexts, unless the logging
655	callback consumes the message.	683	callback consumes the message.
656		684
657	=over 4	685	=over 4
658		686
659	=item $ctx->attach ($ctx2[, $ctx3...])	687	=item $ctx->attach ($ctx2[, $ctx3...])
660		688
661	Attaches the given contexts as parents to this context. It is not an error	689	Attaches the given contexts as slaves to this context. It is not an error
662	to add a context twice (the second add will be ignored).	690	to add a context twice (the second add will be ignored).
663		691
664	A context can be specified either as package name or as a context object.	692	A context can be specified either as package name or as a context object.
665		693
666	=item $ctx->detach ($ctx2[, $ctx3...])	694	=item $ctx->detach ($ctx2[, $ctx3...])
667		695
668	Removes the given parents from this context - it's not an error to attempt	696	Removes the given slaves from this context - it's not an error to attempt
669	to remove a context that hasn't been added.	697	to remove a context that hasn't been added.
670		698
671	A context can be specified either as package name or as a context object.	699	A context can be specified either as package name or as a context object.
672		700
673	=item $ctx->parents ($ctx2[, $ctx3...])	701	=item $ctx->slaves ($ctx2[, $ctx3...])
674		702
675	Replaces all parents attached to this context by the ones given.	703	Replaces all slaves attached to this context by the ones given.
676		704
677	=cut	705	=cut
678		706
679	sub attach {	707	sub attach {
680	my $ctx = shift;	708	my $ctx = shift;
…		…
688		716
689	delete $ctx->[2]{$_+0}	717	delete $ctx->[2]{$_+0}
690	for map { AnyEvent::Log::ctx $_ } @_;	718	for map { AnyEvent::Log::ctx $_ } @_;
691	}	719	}
692		720
693	sub parents {	721	sub slaves {
694	undef $_[0][2];	722	undef $_[0][2];
695	&attach;	723	&attach;
696	}	724	}
697		725
698	=back	726	=back
699		727
700	=head3 MESSAGE LOGGING	728	=head3 LOG TARGETS
701		729
702	The following methods configure how the logging context actually does	730	The following methods configure how the logging context actually does
703	the logging (which consists of formatting the message and printing it or	731	the logging (which consists of formatting the message and printing it or
704	whatever it wants to do with it) and also allows you to log messages	732	whatever it wants to do with it).
705	directly to a context, without going via your package context.
706		733
707	=over 4	734	=over 4
708		735
709	=item $ctx->log_cb ($cb->($str))	736	=item $ctx->log_cb ($cb->($str))
710		737
…		…
715	(see C<fmt_cb> below) - normally simple text strings that end with a	742	(see C<fmt_cb> below) - normally simple text strings that end with a
716	newline (and are possibly multiline themselves).	743	newline (and are possibly multiline themselves).
717		744
718	It also has to return true iff it has consumed the log message, and false	745	It also has to return true iff it has consumed the log message, and false
719	if it hasn't. Consuming a message means that it will not be sent to any	746	if it hasn't. Consuming a message means that it will not be sent to any
720	parent context. When in doubt, return C<0> from your logging callback.	747	slave context. When in doubt, return C<0> from your logging callback.
721		748
722	Example: a very simple logging callback, simply dump the message to STDOUT	749	Example: a very simple logging callback, simply dump the message to STDOUT
723	and do not consume it.	750	and do not consume it.
724		751
725	$ctx->log_cb (sub { print STDERR shift; 0 });	752	$ctx->log_cb (sub { print STDERR shift; 0 });
…		…
733	your program.	760	your program.
734		761
735	$ctx->levels ("debug", "trace");	762	$ctx->levels ("debug", "trace");
736	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages	763	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages
737		764
		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
738	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))	775	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))
739		776
740	Replaces the formatting callback on the context (C<undef> restores the	777	Replaces the formatting callback on the context (C<undef> restores the
741	default formatter).	778	default formatter).
742		779
743	The callback is passed the (possibly fractional) timestamp, the original	780	The callback is passed the (possibly fractional) timestamp, the original
744	logging context, the (numeric) logging level and the raw message string and needs to	781	logging context, the (numeric) logging level and the raw message string
745	return a formatted log message. In most cases this will be a string, but	782	and needs to return a formatted log message. In most cases this will be a
746	it could just as well be an array reference that just stores the values.	783	string, but it could just as well be an array reference that just stores
		784	the values.
		785
		786	If, for some reaosn, 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
		788	inside the C<AnyEvent::Log> package.
747		789
748	Example: format just the raw message, with numeric log level in angle	790	Example: format just the raw message, with numeric log level in angle
749	brackets.	791	brackets.
750		792
751	$ctx->fmt_cb (sub {	793	$ctx->fmt_cb (sub {
…		…
782	my ($ctx, $cb) = @_;	824	my ($ctx, $cb) = @_;
783		825
784	$ctx->[4] = $cb;	826	$ctx->[4] = $cb;
785	}	827	}
786		828
787	=item $ctx->log ($level, $msg[, @params])	829	sub log_to_file {
788		830	my ($ctx, $path) = @_;
789	Same as C<AnyEvent::Log::log>, but uses the given context as log context.
790
791	=item $logger = $ctx->logger ($level[, \$enabled])
792
793	Same as C<AnyEvent::Log::logger>, but uses the given context as log
794	context.
795
796	=cut
797
798	*log = \&AnyEvent::Log::_log;
799	*logger = \&AnyEvent::Log::_logger;
800
801	1;
802
803	=back
804
805	=head1 EXAMPLES
806
807	This section shows some common configurations.
808
809	=over 4
810
811	=item Setting the global logging level.
812
813	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before
814	running your program, or modify the log level of the root context:
815
816	PERL_ANYEVENT_VERBOSE=5 ./myprog
817
818	$AnyEvent::Log::Root->level ("warn");
819
820	=item Append all messages to a file instead of sending them to STDERR.
821
822	This is affected by the global logging level.
823		831
824	open my $fh, ">>", $path	832	open my $fh, ">>", $path
825	or die "$path: $!";	833	or die "$path: $!";
826		834
827	$AnyEvent::Log::Default->log_cb (sub {	835	$ctx->log_cb (sub {
828	syswrite $fh, shift;	836	syswrite $fh, shift;
829	0	837	0
830	});	838	});
		839	}
		840
		841	sub log_to_file {
		842	my ($ctx, $path) = @_;
		843
		844	$ctx->log_cb (sub {
		845	open my $fh, ">>", $path
		846	or die "$path: $!";
		847
		848	syswrite $fh, shift;
		849	0
		850	});
		851	}
		852
		853	=back
		854
		855	=head3 MESSAGE LOGGING
		856
		857	These methods allow you to log messages directly to a context, without
		858	going via your package context.
		859
		860	=over 4
		861
		862	=item $ctx->log ($level, $msg[, @params])
		863
		864	Same as C<AnyEvent::Log::log>, but uses the given context as log context.
		865
		866	=item $logger = $ctx->logger ($level[, \$enabled])
		867
		868	Same as C<AnyEvent::Log::logger>, but uses the given context as log
		869	context.
		870
		871	=cut
		872
		873	*log = \&AnyEvent::Log::_log;
		874	*logger = \&AnyEvent::Log::_logger;
		875
		876	1;
		877
		878	=back
		879
		880	=head1 EXAMPLES
		881
		882	This section shows some common configurations.
		883
		884	=over 4
		885
		886	=item Setting the global logging level.
		887
		888	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before
		889	running your program, or modify the log level of the root context:
		890
		891	PERL_ANYEVENT_VERBOSE=5 ./myprog
		892
		893	$AnyEvent::Log::FILTER->level ("warn");
		894
		895	=item Append all messages to a file instead of sending them to STDERR.
		896
		897	This is affected by the global logging level.
		898
		899	$AnyEvent::Log::LOG->log_to_file ($path); (sub {
831		900
832	=item Write all messages with priority C<error> and higher to a file.	901	=item Write all messages with priority C<error> and higher to a file.
833		902
834	This writes them only when the global logging level allows it, because	903	This writes them only when the global logging level allows it, because
835	it is attached to the default context which is invoked I<after> global	904	it is attached to the default context which is invoked I<after> global
836	filtering.	905	filtering.
837		906
838	open my $fh, ">>", $path	907	$AnyEvent::Log::FILTER->attach
839	or die "$path: $!";	908	new AnyEvent::Log::Ctx log_to_file => $path);
840
841	$AnyEvent::Log::Default->attach (new AnyEvent::Log::Ctx
842	log_cb => sub { syswrite $fh, shift; 0 });
843		909
844	This writes them regardless of the global logging level, because it is	910	This writes them regardless of the global logging level, because it is
845	attached to the toplevel context, which receives all messages I<before>	911	attached to the toplevel context, which receives all messages I<before>
846	the global filtering.	912	the global filtering.
847		913
848	$AnyEvent::Log::Top->attach (new AnyEvent::Log::Ctx	914	$AnyEvent::Log::COLLECT->attach (
849	log_cb => sub { syswrite $fh, shift; 0 });	915	new AnyEvent::Log::Ctx log_to_file => $path);
850		916
851	In both cases, messages are still written to STDOUT.	917	In both cases, messages are still written to STDERR.
852		918
853	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).	919	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).
854		920
855	Attach the CyAnyEvent::Log::Default> context to the C<AnyEvent::Debug>	921	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>
856	context and increase the C<AnyEvent::Debug> logging level - this simply
857	circumvents the global filtering for trace messages.	922	context - this simply circumvents the global filtering for trace messages.
858		923
859	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;	924	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
860	$debug->attach ($AnyEvent::Log::Default);	925	$debug->attach ($AnyEvent::Log::LOG);
861	$debug->levels ("trace"); # not "level"!
862		926
863	This of course works for any package.	927	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
		929	default.
864		930
865	=back	931	=back
866		932
867	=head1 AUTHOR	933	=head1 AUTHOR
868		934

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC vs. Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC vs.
Revision 1.18 by root, Sat Aug 20 15:57:35 2011 UTC