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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.8 by root, Fri Aug 19 19:20:36 2011 UTC vs.
Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC

…		…
10	AE::log debug => "hit my knee";	10	AE::log debug => "hit my knee";
11	AE::log warn => "it's a bit too hot";	11	AE::log warn => "it's a bit too hot";
12	AE::log error => "the flag was false!";	12	AE::log error => "the flag was false!";
13	AE::log fatal => "the bit toggled! run!";	13	AE::log fatal => "the bit toggled! run!";
14		14
15	# complex use	15	# "complex" use
16	use AnyEvent::Log;	16	use AnyEvent::Log;
17		17
18	my $tracer = AnyEvent::Log::logger trace => \$my $trace;	18	my $tracer = AnyEvent::Log::logger trace => \$my $trace;
19		19
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	#TODO: config	23	# configuration
24	#TODO: ctx () becomes caller[0]...	24
		25	# set logging for this package to errors and higher only
		26	AnyEvent::Log::ctx->level ("error");
		27
		28	# set logging globally to anything below debug
		29	$AnyEvent::Log::Root->level ("notice");
		30
		31	# see also EXAMPLES, below
25		32
26	=head1 DESCRIPTION	33	=head1 DESCRIPTION
27		34
28	This module implements a relatively simple "logging framework". It doesn't	35	This module implements a relatively simple "logging framework". It doesn't
29	attempt to be "the" logging solution or even "a" logging solution for	36	attempt to be "the" logging solution or even "a" logging solution for
30	AnyEvent - AnyEvent simply creates logging messages internally, and this	37	AnyEvent - AnyEvent simply creates logging messages internally, and this
31	module more or less exposes the mechanism, with some extra spiff to allow	38	module more or less exposes the mechanism, with some extra spiff to allow
32	using it from other modules as well.	39	using it from other modules as well.
33		40
34	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
35	logged, ever, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number	42	logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before
36	before starting your program.#TODO	43	starting your program, or change the logging level at runtime with
		44	something like:
37		45
38	Possible future extensions are to allow custom log targets (where the	46	use AnyEvent;
39	level is an object), log filtering based on package, formatting, aliasing	47	(AnyEvent::Log::ctx "")->level ("info");
40	or package groups.
41		48
		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
		51	extensive enough for the most common tasks, such as logging to multiple
		52	targets, or being able to log into a database.
		53
		54	The amount of documentation might indicate otherwise, but the module is
		55	still just 240 lines or so.
		56
42	=head1 LOG FUNCTIONS	57	=head1 LOGGING FUNCTIONS
43		58
44	These functions allow you to log messages. They always use the caller's	59	These functions allow you to log messages. They always use the caller's
45	package as a "logging module/source". Also, the main logging function is	60	package as a "logging module/source". Also, the main logging function is
46	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is	61	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is
47	loaded.	62	loaded.
…		…
56	use POSIX ();	71	use POSIX ();
57		72
58	use AnyEvent (); BEGIN { AnyEvent::common_sense }	73	use AnyEvent (); BEGIN { AnyEvent::common_sense }
59	use AnyEvent::Util ();	74	use AnyEvent::Util ();
60		75
		76	our $VERSION = $AnyEvent::VERSION;
		77
61	our ($now_int, $now_str1, $now_str2);	78	our ($now_int, $now_str1, $now_str2);
62		79
63	# Format Time, not public - yet?	80	# Format Time, not public - yet?
64	sub ft($) {	81	sub ft($) {
65	my $i = int $_[0];	82	my $i = int $_[0];
…		…
71	"$now_str1$f$now_str2"	88	"$now_str1$f$now_str2"
72	}	89	}
73		90
74	our %CTX; # all logging contexts	91	our %CTX; # all logging contexts
75		92
76	my $default_log_cb = sub { 0 };
77
78	# creates a default package context object for the given package	93	# creates a default package context object for the given package
79	sub _pkg_ctx($) {	94	sub _pkg_ctx($) {
80	my $ctx = bless [$_[0], 0, {}, $default_log_cb], "AnyEvent::Log::Ctx";	95	my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx";
81		96
82	# link "parent" package	97	# link "parent" package
83	my $pkg = $_[0] =~ /^(.+)::/ ? $1 : "";	98	my $pkg = $_[0] =~ /^(.+)::/ ? $1 : "AE::Log::Top";
84		99
85	$pkg = $CTX{$pkg} \|\|= &_pkg_ctx ($pkg);	100	$pkg = $CTX{$pkg} \|\|= &_pkg_ctx ($pkg);
86	$ctx->[2]{$pkg+0} = $pkg;	101	$ctx->[2]{$pkg+0} = $pkg;
87		102
88	$ctx	103	$ctx
…		…
114	Note that you can (and should) call this function as C<AnyEvent::log> or	129	Note that you can (and should) call this function as C<AnyEvent::log> or
115	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't	130	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't
116	need any additional functionality), as those functions will load the	131	need any additional functionality), as those functions will load the
117	logging module on demand only. They are also much shorter to write.	132	logging module on demand only. They are also much shorter to write.
118		133
119	Also, if you otpionally generate a lot of debug messages (such as when	134	Also, if you optionally generate a lot of debug messages (such as when
120	tracing some code), you should look into using a logger callback and a	135	tracing some code), you should look into using a logger callback and a
121	boolean enabler (see C<logger>, below).	136	boolean enabler (see C<logger>, below).
122		137
123	Example: log something at error level.	138	Example: log something at error level.
124		139
…		…
146	debug => 8,	161	debug => 8,
147	trace => 9,	162	trace => 9,
148	);	163	);
149		164
150	sub now () { time }	165	sub now () { time }
		166
151	AnyEvent::post_detect {	167	AnyEvent::post_detect {
152	*now = \&AE::now;	168	*now = \&AE::now;
153	};	169	};
154		170
155	our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace);	171	our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace);
156		172
157	# time, ctx, level, msg	173	# time, ctx, level, msg
158	sub _format($$$$) {	174	sub _format($$$$) {
159	my $pfx = ft $_[0];	175	my $ts = ft $_[0];
		176	my $ct = " ";
160		177
161	join "",	178	my @res;
162	map "$pfx $_\n",	179
163	split /\n/,
164	sprintf "%-5s %s: %s", $LEVEL2STR[$_[2]], $_[1][0], $_[3]	180	for (split /\n/, sprintf "%-5s %s: %s", $LEVEL2STR[$_[2]], $_[1][0], $_[3]) {
		181	push @res, "$ts$ct$_\n";
		182	$ct = " + ";
		183	}
		184
		185	join "", @res
165	}	186	}
166		187
167	sub _log {	188	sub _log {
168	my ($ctx, $level, $format, @args) = @_;	189	my ($ctx, $level, $format, @args) = @_;
169		190
		191	$level = $level > 0 && $level <= 9
		192	? $level+0
170	$level = $level > 0 && $level <= 9 ? $level+0 : $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";	193	: $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";
171		194
172	my $mask = 1 << $level;	195	my $mask = 1 << $level;
173	my $now = AE::now;
174		196
175	my (@ctx, $did_format, $fmt);	197	my (%seen, @ctx, $now, $fmt);
176		198
177	do {	199	do
178	if ($ctx->[1] & $mask) {	200	{
		201	# skip if masked
		202	if ($ctx->[1] & $mask && !$seen{$ctx+0}++) {
		203	if ($ctx->[3]) {
179	# logging target found	204	# logging target found
180		205
181	# get raw message	206	# now get raw message, unless we have it already
182	unless ($did_format) {	207	unless ($now) {
183	$format = $format->() if ref $format;	208	$format = $format->() if ref $format;
184	$format = sprintf $format, @args if @args;	209	$format = sprintf $format, @args if @args;
185	$format =~ s/\n$//;	210	$format =~ s/\n$//;
186	$did_format = 1;	211	$now = AE::now;
187	};	212	};
188		213
189	# format msg	214	# format msg
190	my $str = $ctx->[4]	215	my $str = $ctx->[4]
191	? $ctx->[4]($now, $_[0], $level, $format)	216	? $ctx->[4]($now, $_[0], $level, $format)
192	: $fmt \|\|= _format $now, $_[0], $level, $format;	217	: $fmt \|\|= _format $now, $_[0], $level, $format;
193		218
194	$ctx->[3]($str)	219	$ctx->[3]($str);
195	and next;	220	}
		221
		222	# not masked, not consumed - propagate to parent contexts
		223	push @ctx, values %{ $ctx->[2] };
		224	}
196	}	225	}
197
198	# not consume - push parent contexts
199	push @ctx, values %{ $ctx->[2] };
200	} while $ctx = pop @ctx;	226	while $ctx = pop @ctx;
201		227
202	exit 1 if $level <= 1;	228	exit 1 if $level <= 1;
203	}	229	}
204		230
205	sub log($$;@) {	231	sub log($$;@) {
…		…
246	# and later in your program	272	# and later in your program
247	$debug_log->("yo, stuff here") if $debug;	273	$debug_log->("yo, stuff here") if $debug;
248		274
249	$debug and $debug_log->("123");	275	$debug and $debug_log->("123");
250		276
251	Note: currently the enabled var is always true - that will be fixed in a
252	future version :)
253
254	=cut	277	=cut
255		278
256	our %LOGGER;	279	our %LOGGER;
257		280
258	# re-assess logging status for all loggers	281	# re-assess logging status for all loggers
259	sub _reassess {	282	sub _reassess {
		283	local $SIG{__DIE__};
		284	my $die = sub { die };
		285
260	for (@_ ? $LOGGER{$_[0]} : values %LOGGER) {	286	for (@_ ? $LOGGER{$_[0]} : values %LOGGER) {
261	my ($ctx, $level, $renabled) = @$_;	287	my ($ctx, $level, $renabled) = @$_;
262		288
263	# to detetc whether a message would be logged, we # actually	289	# to detect whether a message would be logged, we actually
264	# try to log one and die. this isn't # fast, but we can be	290	# try to log one and die. this isn't fast, but we can be
265	# sure that the logging decision is correct :)	291	# sure that the logging decision is correct :)
266		292
267	$$renabled = !eval {	293	$$renabled = !eval {
268	local $SIG{__DIE__};
269
270	_log $ctx, $level, sub { die };	294	_log $ctx, $level, $die;
271		295
272	1	296	1
273	};	297	};
274
275	$$renabled = 1; # TODO
276	}	298	}
277	}	299	}
278		300
279	sub _logger($;$) {	301	sub _logger {
280	my ($ctx, $level, $renabled) = @_;	302	my ($ctx, $level, $renabled) = @_;
281
282	$renabled \|\|= \my $enabled;
283		303
284	$$renabled = 1;	304	$$renabled = 1;
285		305
286	my $logger = [$ctx, $level, $renabled];	306	my $logger = [$ctx, $level, $renabled];
287		307
…		…
306	_logger	326	_logger
307	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],	327	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],
308	@_	328	@_
309	}	329	}
310		330
311	#TODO
312
313	=back	331	=back
314		332
315	=head1 CONFIGURATION FUNCTIONALITY	333	=head1 LOGGING CONTEXTS
316		334
317	None, yet, except for C<PERL_ANYEVENT_VERBOSE>, described in the L<AnyEvent> manpage.	335	This module associates every log message with a so-called I<logging
		336	context>, based on the package of the caller. Every perl package has its
		337	own logging context.
318		338
319	#TODO: wahst a context	339	A logging context has three major responsibilities: filtering, logging and
320	#TODO	340	propagating the message.
		341
		342	For the first purpose, filtering, each context has a set of logging
		343	levels, called the log level mask. Messages not in the set will be ignored
		344	by this context (masked).
		345
		346	For logging, the context stores a formatting callback (which takes the
		347	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
		349	actually logging the formatted message and telling C<AnyEvent::Log>
		350	whether it has consumed the message, or whether it should be propagated).
		351
		352	For propagation, a context can have any number of attached I<parent
		353	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
		355	contexts.
		356
		357	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
		359	message can arrive at the same context via multiple paths.
		360
		361	=head2 DEFAULTS
		362
		363	By default, all logging contexts have an full set of log levels ("all"), a
		364	disabled logging callback and the default formatting callback.
		365
		366	Package contexts have the package name as logging title by default.
		367
		368	They have exactly one parent - the context of the "parent" package. The
		369	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>,
		371	and C<AnyEvent> becomes ... C<AnyEvent::Log::Top> which is the
		372	exception of the rule - just like the parent of any package name in
		373	Perl is C<main>, the default parent of any top-level package context is
		374	C<AnyEvent::Log::Top>.
		375
		376	Since perl packages form only an approximate hierarchy, this parent
		377	context can of course be removed.
		378
		379	All other (anonymous) contexts have no parents and an empty title by
		380	default.
		381
		382	When the module is loaded it creates the default context called
		383	C<AnyEvent::Log::Default> (also stored in C<$AnyEvent::Log::Default>),
		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
		386	a convenient place to override the global logging target or to attach
		387	additional log targets. It's not meant for filtering.
		388
		389	It then creates the root context called C<AnyEvent::Log::Root> (also
		390	stored in C<$AnyEvent::Log::Root>) and sets its log level set to all
		391	levels up to the one specified by C<$ENV{PERL_ANYEVENT_VERBOSE}>. It
		392	then attached the default logging context to it. The purpose of the root
		393	context is to simply provide filtering according to some global log level.
		394
		395	Finally it creates the top-level package context called
		396	C<AnyEvent::Log::Top> (also stored in, you might have guessed,
		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
		399	system-wide.
		400
		401	These three special contexts can also be referred to by the
		402	package/context names C<AE::Log::Default>, C<AE::Log::Root> and
		403	C<AE::Log::Top>.
		404
		405	The effect of all this is that log messages, by default, wander up
		406	to the root context where log messages with lower priority then
		407	C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered away and then to the
		408	AnyEvent::Log::Default context to be passed to C<warn>.
		409
		410	Splitting the top level context into three contexts makes it easy to set
		411	a global logging level (by modifying the root context), but still allow
		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
		414	log targets that log messages, regardless of the global logging level.
		415
		416	It also makes it easy to replace the default warn-logger by something that
		417	logs to a file, or to attach additional logging targets.
		418
		419	=head2 CREATING/FINDING/DESTROYING CONTEXTS
321		420
322	=over 4	421	=over 4
323		422
324	=item $ctx = AnyEvent::Log::ctx [$pkg]	423	=item $ctx = AnyEvent::Log::ctx [$pkg]
325		424
326	Returns a I<config> object for the given package name.	425	This function creates or returns a logging context (which is an object).
327		426
328	If no package name is given, returns the context for the current perl	427	If a package name is given, then the context for that packlage is
		428	returned. If it is called without any arguments, then the context for the
329	package (i.e. the same context as a C<AE::log> call would use).	429	callers package is returned (i.e. the same context as a C<AE::log> call
		430	would use).
330		431
331	If C<undef> is given, then it creates a new anonymous context that is not	432	If C<undef> is given, then it creates a new anonymous context that is not
332	tied to any package and is destroyed when no longer referenced.	433	tied to any package and is destroyed when no longer referenced.
333		434
334	=cut	435	=cut
…		…
338		439
339	ref $pkg	440	ref $pkg
340	? $pkg	441	? $pkg
341	: defined $pkg	442	: defined $pkg
342	? $CTX{$pkg} \|\|= AnyEvent::Log::_pkg_ctx $pkg	443	? $CTX{$pkg} \|\|= AnyEvent::Log::_pkg_ctx $pkg
343	: bless [undef, 0, undef, $default_log_cb], "AnyEvent::Log::Ctx"	444	: bless [undef, (1 << 10) - 1 - 1], "AnyEvent::Log::Ctx"
344	}	445	}
345		446
346	# create default root context	447	=item AnyEvent::Log::reset
347	{	448
348	my $root = ctx undef;	449	Resets all package contexts and recreates the default hierarchy if
349	$root->[0] = "";	450	necessary, i.e. resets the logging subsystem to defaults, as much as
350	$root->title ("default");	451	possible. This process keeps references to contexts held by other parts of
351	$root->level ($AnyEvent::VERBOSE);	452	the program intact.
352	$root->log_cb (sub {	453
353	print STDERR shift;	454	This can be used to implement config-file (re-)loading: before loading a
		455	configuration, reset all contexts.
		456
		457	=cut
		458
		459	sub reset {
		460	# hard to kill complex data structures
		461	# we recreate all package loggers and reset the hierarchy
		462	while (my ($k, $v) = each %CTX) {
		463	@$v = ($k, (1 << 10) - 1 - 1, { });
		464
		465	my $pkg = $k =~ /^(.+)::/ ? $1 : "AE::Log::Top";
		466	$v->attach ($CTX{$pkg});
		467	}
		468
		469	$AnyEvent::Log::Default->parents;
		470	$AnyEvent::Log::Default->title ("AnyEvent::Log::Default");
		471	$AnyEvent::Log::Default->log_cb (sub {
		472	warn shift;
354	0	473	0
355	});	474	});
356	$CTX{""} = $root;	475	$CTX{"AnyEvent::Log::Default"} = $CTX{"AE::Log::Default"} = $AnyEvent::Log::Default;
		476
		477	$AnyEvent::Log::Root->parents ($AnyEvent::Log::Default);
		478	$AnyEvent::Log::Root->title ("AnyEvent::Log::Root");
		479	$AnyEvent::Log::Root->level ($AnyEvent::VERBOSE);
		480	$CTX{"AnyEvent::Log::Root"} = $CTX{"AE::Log::Root"} = $AnyEvent::Log::Root;
		481
		482	$AnyEvent::Log::Top->parents ($AnyEvent::Log::Root);
		483	$AnyEvent::Log::Top->title ("AnyEvent::Log::Top");
		484	$CTX{"AnyEvent::Log::Top"} = $CTX{"AE::Log::Top"} = $AnyEvent::Log::Top;
		485
		486	_reassess;
357	}	487	}
		488
		489	# create the default logger contexts
		490	$AnyEvent::Log::Default = ctx undef;
		491	$AnyEvent::Log::Root = ctx undef;
		492	$AnyEvent::Log::Top = ctx undef;
		493
		494	AnyEvent::Log::reset;
		495
		496	# 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;
		502	package AE::Log::Top;
358		503
359	package AnyEvent::Log::Ctx;	504	package AnyEvent::Log::Ctx;
360		505
361	# 0 1 2 3 4	506	# 0 1 2 3 4
362	# [$title, $level, %$parents, &$logcb, &$fmtcb]	507	# [$title, $level, %$parents, &$logcb, &$fmtcb]
		508
		509	=item $ctx = new AnyEvent::Log::Ctx methodname => param...
		510
		511	This is a convenience constructor that makes it simpler to construct
		512	anonymous logging contexts.
		513
		514	Each key-value pair results in an invocation of the method of the same
		515	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
		517	array. The methods are called in the same order as specified.
		518
		519	Example: create a new logging context and set both the default logging
		520	level, some parent contexts and a logging callback.
		521
		522	$ctx = new AnyEvent::Log::Ctx
		523	title => "dubious messages",
		524	level => "error",
		525	log_cb => sub { print STDOUT shift; 0 },
		526	parents => [$ctx1, $ctx, $ctx2],
		527	;
		528
		529	=back
		530
		531	=cut
		532
		533	sub new {
		534	my $class = shift;
		535
		536	my $ctx = AnyEvent::Log::ctx undef;
		537
		538	while (@_) {
		539	my ($k, $v) = splice @_, 0, 2;
		540	$ctx->$k (ref $v eq "ARRAY" ? @$v : $v);
		541	}
		542
		543	bless $ctx, $class # do we really support subclassing, hmm?
		544	}
		545
		546
		547	=head2 CONFIGURING A LOG CONTEXT
		548
		549	The following methods can be used to configure the logging context.
		550
		551	=over 4
363		552
364	=item $ctx->title ([$new_title])	553	=item $ctx->title ([$new_title])
365		554
366	Returns the title of the logging context - this is the package name, for	555	Returns the title of the logging context - this is the package name, for
367	package contexts, and a user defined string for all others.	556	package contexts, and a user defined string for all others.
…		…
373	sub title {	562	sub title {
374	$_[0][0] = $_[1] if @_ > 1;	563	$_[0][0] = $_[1] if @_ > 1;
375	$_[0][0]	564	$_[0][0]
376	}	565	}
377		566
		567	=back
		568
		569	=head3 LOGGING LEVELS
		570
		571	The following methods deal with the logging level set associated with the
		572	log context.
		573
		574	The most common method to use is probably C<< $ctx->level ($level) >>,
		575	which configures the specified and any higher priority levels.
		576
		577	All functions which accept a list of levels also accept the special string
		578	C<all> which expands to all logging levels.
		579
		580	=over 4
		581
378	=item $ctx->levels ($level[, $level...)	582	=item $ctx->levels ($level[, $level...)
379		583
380	Enables logging fot the given levels and disables it for all others.	584	Enables logging for the given levels and disables it for all others.
381		585
382	=item $ctx->level ($level)	586	=item $ctx->level ($level)
383		587
384	Enables logging for the given level and all lower level (higher priority)	588	Enables logging for the given level and all lower level (higher priority)
385	ones. Specifying a level of C<0> or C<off> disables all logging for this	589	ones. In addition to normal logging levels, specifying a level of C<0> or
386	level.	590	C<off> disables all logging for this level.
387		591
388	Example: log warnings, errors and higher priority messages.	592	Example: log warnings, errors and higher priority messages.
389		593
390	$ctx->level ("warn");	594	$ctx->level ("warn");
391	$ctx->level (5); # same thing, just numeric	595	$ctx->level (5); # same thing, just numeric
…		…
399	Disables logging for the given levels, leaving all others unchanged.	603	Disables logging for the given levels, leaving all others unchanged.
400		604
401	=cut	605	=cut
402		606
403	sub _lvl_lst {	607	sub _lvl_lst {
		608	map {
		609	$_ > 0 && $_ <= 9 ? $_+0
		610	: $_ eq "all" ? (1 .. 9)
404	map { $_ > 0 && $_ <= 9 ? $_+0 : $STR2LEVEL{$_} \|\| Carp::croak "$_: not a valid logging level, caught" }	611	: $STR2LEVEL{$_} \|\| Carp::croak "$_: not a valid logging level, caught"
405	@_	612	} @_
406	}	613	}
407		614
408	our $NOP_CB = sub { 0 };	615	our $NOP_CB = sub { 0 };
409		616
410	sub levels {	617	sub levels {
…		…
415	AnyEvent::Log::_reassess;	622	AnyEvent::Log::_reassess;
416	}	623	}
417		624
418	sub level {	625	sub level {
419	my $ctx = shift;	626	my $ctx = shift;
420	my $lvl = $_[0] =~ /^(?:0\|off\|none)$/ ? 0 : (_lvl_lst $_[0])[0];	627	my $lvl = $_[0] =~ /^(?:0\|off\|none)$/ ? 0 : (_lvl_lst $_[0])[-1];
		628
421	$ctx->[1] = ((1 << $lvl) - 1) << 1;	629	$ctx->[1] = ((1 << $lvl) - 1) << 1;
422	AnyEvent::Log::_reassess;	630	AnyEvent::Log::_reassess;
423	}	631	}
424		632
425	sub enable {	633	sub enable {
…		…
434	$ctx->[1] &= ~(1 << $_)	642	$ctx->[1] &= ~(1 << $_)
435	for &_lvl_lst;	643	for &_lvl_lst;
436	AnyEvent::Log::_reassess;	644	AnyEvent::Log::_reassess;
437	}	645	}
438		646
		647	=back
		648
		649	=head3 PARENT CONTEXTS
		650
		651	The following methods attach and detach another logging context to a
		652	logging context.
		653
		654	Log messages are propagated to all parent contexts, unless the logging
		655	callback consumes the message.
		656
		657	=over 4
		658
439	=item $ctx->attach ($ctx2[, $ctx3...])	659	=item $ctx->attach ($ctx2[, $ctx3...])
440		660
441	Attaches the given contexts as parents to this context. It is not an error	661	Attaches the given contexts as parents to this context. It is not an error
442	to add a context twice (the second add will be ignored).	662	to add a context twice (the second add will be ignored).
443		663
…		…
448	Removes the given parents from this context - it's not an error to attempt	668	Removes the given parents from this context - it's not an error to attempt
449	to remove a context that hasn't been added.	669	to remove a context that hasn't been added.
450		670
451	A context can be specified either as package name or as a context object.	671	A context can be specified either as package name or as a context object.
452		672
		673	=item $ctx->parents ($ctx2[, $ctx3...])
		674
		675	Replaces all parents attached to this context by the ones given.
		676
453	=cut	677	=cut
454		678
455	sub attach {	679	sub attach {
456	my $ctx = shift;	680	my $ctx = shift;
457		681
…		…
463	my $ctx = shift;	687	my $ctx = shift;
464		688
465	delete $ctx->[2]{$_+0}	689	delete $ctx->[2]{$_+0}
466	for map { AnyEvent::Log::ctx $_ } @_;	690	for map { AnyEvent::Log::ctx $_ } @_;
467	}	691	}
		692
		693	sub parents {
		694	undef $_[0][2];
		695	&attach;
		696	}
		697
		698	=back
		699
		700	=head3 MESSAGE LOGGING
		701
		702	The following methods configure how the logging context actually does
		703	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
		705	directly to a context, without going via your package context.
		706
		707	=over 4
468		708
469	=item $ctx->log_cb ($cb->($str))	709	=item $ctx->log_cb ($cb->($str))
470		710
471	Replaces the logging callback on the context (C<undef> disables the	711	Replaces the logging callback on the context (C<undef> disables the
472	logging callback).	712	logging callback).
…		…
482	Example: a very simple logging callback, simply dump the message to STDOUT	722	Example: a very simple logging callback, simply dump the message to STDOUT
483	and do not consume it.	723	and do not consume it.
484		724
485	$ctx->log_cb (sub { print STDERR shift; 0 });	725	$ctx->log_cb (sub { print STDERR shift; 0 });
486		726
		727	You can filter messages by having a log callback that simply returns C<1>
		728	and does not do anything with the message, but this counts as "message
		729	being logged" and might not be very efficient.
		730
		731	Example: propagate all messages except for log levels "debug" and
		732	"trace". The messages will still be generated, though, which can slow down
		733	your program.
		734
		735	$ctx->levels ("debug", "trace");
		736	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages
		737
487	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))	738	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))
488		739
489	Replaces the fornatting callback on the cobntext (C<undef> restores the	740	Replaces the formatting callback on the context (C<undef> restores the
490	default formatter).	741	default formatter).
491		742
492	The callback is passed the (possibly fractional) timestamp, the original	743	The callback is passed the (possibly fractional) timestamp, the original
493	logging context, the (numeric) logging level and the raw message string and needs to	744	logging context, the (numeric) logging level and the raw message string and needs to
494	return a formatted log message. In most cases this will be a string, but	745	return a formatted log message. In most cases this will be a string, but
…		…
522	=cut	773	=cut
523		774
524	sub log_cb {	775	sub log_cb {
525	my ($ctx, $cb) = @_;	776	my ($ctx, $cb) = @_;
526		777
527	$ctx->[3] = $cb \|\| $default_log_cb;	778	$ctx->[3] = $cb;
528	}	779	}
529		780
530	sub fmt_cb {	781	sub fmt_cb {
531	my ($ctx, $cb) = @_;	782	my ($ctx, $cb) = @_;
532		783
…		…
549		800
550	1;	801	1;
551		802
552	=back	803	=back
553		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
		824	open my $fh, ">>", $path
		825	or die "$path: $!";
		826
		827	$AnyEvent::Log::Default->log_cb (sub {
		828	syswrite $fh, shift;
		829	0
		830	});
		831
		832	=item Write all messages with priority C<error> and higher to a file.
		833
		834	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
		836	filtering.
		837
		838	open my $fh, ">>", $path
		839	or die "$path: $!";
		840
		841	$AnyEvent::Log::Default->attach (new AnyEvent::Log::Ctx
		842	log_cb => sub { syswrite $fh, shift; 0 });
		843
		844	This writes them regardless of the global logging level, because it is
		845	attached to the toplevel context, which receives all messages I<before>
		846	the global filtering.
		847
		848	$AnyEvent::Log::Top->attach (new AnyEvent::Log::Ctx
		849	log_cb => sub { syswrite $fh, shift; 0 });
		850
		851	In both cases, messages are still written to STDOUT.
		852
		853	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).
		854
		855	Attach the CyAnyEvent::Log::Default> 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.
		858
		859	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
		860	$debug->attach ($AnyEvent::Log::Default);
		861	$debug->levels ("trace"); # not "level"!
		862
		863	This of course works for any package.
		864
		865	=back
		866
554	=head1 AUTHOR	867	=head1 AUTHOR
555		868
556	Marc Lehmann <schmorp@schmorp.de>	869	Marc Lehmann <schmorp@schmorp.de>
557	http://home.schmorp.de/	870	http://home.schmorp.de/
558		871

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.8 by root, Fri Aug 19 19:20:36 2011 UTC vs. Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.8 by root, Fri Aug 19 19:20:36 2011 UTC vs.
Revision 1.17 by root, Sat Aug 20 02:21:53 2011 UTC