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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.15 by root, Sat Aug 20 02:16:59 2011 UTC vs.
Revision 1.46 by root, Sun Oct 2 01:22:01 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 trace => "going to call function abc";
11	AE::log warn => "it's a bit too hot";	12	AE::log debug => "the function returned 3";
12	AE::log error => "the flag was false!";	13	AE::log info => "file soandso successfully deleted";
13	AE::log fatal => "the bit toggled! run!";	14	AE::log note => "wanted to create config, but config was alraedy created";
		15	AE::log warn => "couldn't delete the file";
		16	AE::log error => "failed to retrieve data";
		17	AE::log crit => "the battery temperature is too hot";
		18	AE::log alert => "the battery died";
		19	AE::log fatal => "no config found, cannot continue"; # never returns
14		20
15	# "complex" use	21	Log level overview:
		22
		23	LVL NAME SYSLOG PERL NOTE
		24	1 fatal emerg exit system unusable, aborts program!
		25	2 alert failure in primary system
		26	3 critical crit failure in backup system
		27	4 error err die non-urgent program errors, a bug
		28	5 warn warning possible problem, not necessarily error
		29	6 note notice unusual conditions
		30	7 info normal messages, no action required
		31	8 debug debugging messages for development
		32	9 trace copious tracing output
		33
		34	"Complex" uses (for speed sensitive code, e.g. trace/debug messages):
		35
16	use AnyEvent::Log;	36	use AnyEvent::Log;
17		37
18	my $tracer = AnyEvent::Log::logger trace => \$my $trace;	38	my $tracer = AnyEvent::Log::logger trace => \$my $trace;
19		39
20	$tracer->("i am here") if $trace;	40	$tracer->("i am here") if $trace;
21	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;	41	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;
22		42
23	# configuration	43	Configuration (also look at the EXAMPLES section):
24		44
25	# set logging for this package to maximum	45	# set logging for the current package to errors and higher only
26	AnyEvent::Log::ctx->level ("all");	46	AnyEvent::Log::ctx->level ("error");
27		47
28	# set logging globally to anything below debug	48	# set logging level to suppress anything below "notice"
29	(AnyEvent::Log::ctx "")->level ("notice");	49	$AnyEvent::Log::FILTER->level ("notice");
30		50
31	# see also EXAMPLES, below	51	# send all critical and higher priority messages to syslog,
32		52	# regardless of (most) other settings
33	# disable logging for package "AnyEvent" and all packages below it	53	$AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx
34	AnyEvent->AnyEvent::Log::ctx->level (0);	54	level => "critical",
35		55	log_to_syslog => "user",
36	# log everything below debug to a file, for the whole program	56	);
37	my $ctx = AnyEvent::Log::ctx;
38	$ctx->log_cb (sub { print FILE shift; 0 });
39	(AnyEvent::Log::ctx "")->add ($ctx);
40		57
41	=head1 DESCRIPTION	58	=head1 DESCRIPTION
42		59
43	This module implements a relatively simple "logging framework". It doesn't	60	This module implements a relatively simple "logging framework". It doesn't
44	attempt to be "the" logging solution or even "a" logging solution for	61	attempt to be "the" logging solution or even "a" logging solution for
45	AnyEvent - AnyEvent simply creates logging messages internally, and this	62	AnyEvent - AnyEvent simply creates logging messages internally, and this
46	module more or less exposes the mechanism, with some extra spiff to allow	63	module more or less exposes the mechanism, with some extra spiff to allow
47	using it from other modules as well.	64	using it from other modules as well.
48		65
49	Remember that the default verbosity level is C<0>, so nothing will be	66	Remember that the default verbosity level is C<0> (C<off>), so nothing
50	logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number before	67	will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number
51	starting your program, or change the logging level at runtime with	68	before starting your program, or change the logging level at runtime with
52	something like:	69	something like:
53		70
54	use AnyEvent;	71	use AnyEvent::Log;
55	(AnyEvent::Log::ctx "")->level ("info");	72	$AnyEvent::Log::FILTER->level ("info");
56		73
57	The design goal behind this module was to keep it simple (and small),	74	The design goal behind this module was to keep it simple (and small),
58	but make it powerful enough to be potentially useful for any module, and	75	but make it powerful enough to be potentially useful for any module, and
59	extensive enough for the most common tasks, such as logging to multiple	76	extensive enough for the most common tasks, such as logging to multiple
60	targets, or being able to log into a database.	77	targets, or being able to log into a database.
61		78
		79	The module is also usable before AnyEvent itself is initialised, in which
		80	case some of the functionality might be reduced.
		81
62	The amount of documentation might indicate otherwise, but the module is	82	The amount of documentation might indicate otherwise, but the runtime part
63	still just 240 lines or so.	83	of the module is still just below 300 lines of code.
		84
		85	=head1 LOGGING LEVELS
		86
		87	Logging levels in this module range from C<1> (highest priority) to C<9>
		88	(lowest priority). Note that the lowest numerical value is the highest
		89	priority, so when this document says "higher priority" it means "lower
		90	numerical value".
		91
		92	Instead of specifying levels by name you can also specify them by aliases:
		93
		94	LVL NAME SYSLOG PERL NOTE
		95	1 fatal emerg exit system unusable, aborts program!
		96	2 alert failure in primary system
		97	3 critical crit failure in backup system
		98	4 error err die non-urgent program errors, a bug
		99	5 warn warning possible problem, not necessarily error
		100	6 note notice unusual conditions
		101	7 info normal messages, no action required
		102	8 debug debugging messages for development
		103	9 trace copious tracing output
		104
		105	As you can see, some logging levels have multiple aliases - the first one
		106	is the "official" name, the second one the "syslog" name (if it differs)
		107	and the third one the "perl" name, suggesting (only!) that you log C<die>
		108	messages at C<error> priority. The NOTE column tries to provide some
		109	rationale on how to chose a logging level.
		110
		111	As a rough guideline, levels 1..3 are primarily meant for users of
		112	the program (admins, staff), and are the only logged to STDERR by
		113	default. Levels 4..6 are meant for users and developers alike, while
		114	levels 7..9 are usually meant for developers.
		115
		116	You can normally only log a single message at highest priority level
		117	(C<1>, C<fatal>), because logging a fatal message will also quit the
		118	program - so use it sparingly :)
		119
		120	Some methods also offer some extra levels, such as C<0>, C<off>, C<none>
		121	or C<all> - these are only valid in the methods they are documented for.
64		122
65	=head1 LOGGING FUNCTIONS	123	=head1 LOGGING FUNCTIONS
66		124
67	These functions allow you to log messages. They always use the caller's	125	These functions allow you to log messages. They always use the caller's
68	package as a "logging module/source". Also, the main logging function is	126	package as a "logging context". Also, the main logging function C<log> is
69	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is	127	callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is
70	loaded.	128	loaded.
71		129
72	=over 4	130	=over 4
73		131
…		…
76	package AnyEvent::Log;	134	package AnyEvent::Log;
77		135
78	use Carp ();	136	use Carp ();
79	use POSIX ();	137	use POSIX ();
80		138
		139	# layout of a context
		140	# 0 1 2 3 4, 5
		141	# [$title, $level, %$slaves, &$logcb, &$fmtcb, $cap]
		142
81	use AnyEvent (); BEGIN { AnyEvent::common_sense }	143	use AnyEvent (); BEGIN { AnyEvent::common_sense }
82	use AnyEvent::Util ();	144	#use AnyEvent::Util (); need to load this in a delayed fashion, as it uses AE::log
83		145
84	our $VERSION = $AnyEvent::VERSION;	146	our $VERSION = $AnyEvent::VERSION;
		147
		148	our ($COLLECT, $FILTER, $LOG);
85		149
86	our ($now_int, $now_str1, $now_str2);	150	our ($now_int, $now_str1, $now_str2);
87		151
88	# Format Time, not public - yet?	152	# Format Time, not public - yet?
89	sub ft($) {	153	sub ft($) {
…		…
94	if $now_int != $i;	158	if $now_int != $i;
95		159
96	"$now_str1$f$now_str2"	160	"$now_str1$f$now_str2"
97	}	161	}
98		162
99	our %CTX; # all logging contexts	163	our %CTX; # all package contexts
100		164
101	# creates a default package context object for the given package	165	# creates a default package context object for the given package
102	sub _pkg_ctx($) {	166	sub _pkg_ctx($) {
103	my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx";	167	my $ctx = bless [$_[0], (1 << 10) - 1 - 1, {}], "AnyEvent::Log::Ctx";
104		168
105	# link "parent" package	169	# link "parent" package
106	my $pkg = $_[0] =~ /^(.+)::/ ? $1 : "AE::Log::Top";	170	my $parent = $_[0] =~ /^(.+)::/
		171	? $CTX{$1} \|\|= &_pkg_ctx ("$1")
		172	: $COLLECT;
107		173
108	$pkg = $CTX{$pkg} \|\|= &_pkg_ctx ($pkg);
109	$ctx->[2]{$pkg+0} = $pkg;	174	$ctx->[2]{$parent+0} = $parent;
110		175
111	$ctx	176	$ctx
112	}	177	}
113		178
114	=item AnyEvent::Log::log $level, $msg[, @args]	179	=item AnyEvent::Log::log $level, $msg[, @args]
115		180
116	Requests logging of the given C<$msg> with the given log level (1..9).	181	Requests logging of the given C<$msg> with the given log level, and
117	You can also use the following strings as log level: C<fatal> (1),	182	returns true if the message was logged I<somewhere>.
118	C<alert> (2), C<critical> (3), C<error> (4), C<warn> (5), C<note> (6),
119	C<info> (7), C<debug> (8), C<trace> (9).
120		183
121	For C<fatal> log levels, the program will abort.	184	For loglevel C<fatal>, the program will abort.
122		185
123	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the	186	If only a C<$msg> is given, it is logged as-is. With extra C<@args>, the
124	C<$msg> is interpreted as an sprintf format string.	187	C<$msg> is interpreted as an sprintf format string.
125		188
126	The C<$msg> should not end with C<\n>, but may if that is convenient for	189	The C<$msg> should not end with C<\n>, but may if that is convenient for
…		…
129	Last not least, C<$msg> might be a code reference, in which case it is	192	Last not least, C<$msg> might be a code reference, in which case it is
130	supposed to return the message. It will be called only then the message	193	supposed to return the message. It will be called only then the message
131	actually gets logged, which is useful if it is costly to create the	194	actually gets logged, which is useful if it is costly to create the
132	message in the first place.	195	message in the first place.
133		196
		197	This function takes care of saving and restoring C<$!> and C<$@>, so you
		198	don't have to.
		199
134	Whether the given message will be logged depends on the maximum log level	200	Whether the given message will be logged depends on the maximum log level
135	and the caller's package.	201	and the caller's package. The return value can be used to ensure that
		202	messages or not "lost" - for example, when L<AnyEvent::Debug> detects a
		203	runtime error it tries to log it at C<die> level, but if that message is
		204	lost it simply uses warn.
136		205
137	Note that you can (and should) call this function as C<AnyEvent::log> or	206	Note that you can (and should) call this function as C<AnyEvent::log> or
138	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't	207	C<AE::log>, without C<use>-ing this module if possible (i.e. you don't
139	need any additional functionality), as those functions will load the	208	need any additional functionality), as those functions will load the
140	logging module on demand only. They are also much shorter to write.	209	logging module on demand only. They are also much shorter to write.
…		…
157		226
158	=cut	227	=cut
159		228
160	# also allow syslog equivalent names	229	# also allow syslog equivalent names
161	our %STR2LEVEL = (	230	our %STR2LEVEL = (
162	fatal => 1, emerg => 1,	231	fatal => 1, emerg => 1, exit => 1,
163	alert => 2,	232	alert => 2,
164	critical => 3, crit => 3,	233	critical => 3, crit => 3,
165	error => 4, err => 4,	234	error => 4, err => 4, die => 4,
166	warn => 5, warning => 5,	235	warn => 5, warning => 5,
167	note => 6, notice => 6,	236	note => 6, notice => 6,
168	info => 7,	237	info => 7,
169	debug => 8,	238	debug => 8,
170	trace => 9,	239	trace => 9,
171	);	240	);
172		241
173	sub now () { time }	242	our $TIME_EXACT;
		243
		244	sub exact_time($) {
		245	$TIME_EXACT = shift;
		246	*_ts = $AnyEvent::MODEL
		247	? $TIME_EXACT ? \&AE::now : \&AE::time
		248	: sub () { $TIME_EXACT ? do { require Time::HiRes; Time::HiRes::time () } : time };
		249	}
		250
		251	BEGIN {
		252	exact_time 0;
		253	}
174		254
175	AnyEvent::post_detect {	255	AnyEvent::post_detect {
176	*now = \&AE::now;	256	exact_time $TIME_EXACT;
177	};	257	};
178		258
179	our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace);	259	our @LEVEL2STR = qw(0 fatal alert crit error warn note info debug trace);
180		260
181	# time, ctx, level, msg	261	# time, ctx, level, msg
…		…
191	}	271	}
192		272
193	join "", @res	273	join "", @res
194	}	274	}
195		275
		276	sub fatal_exit() {
		277	exit 1;
		278	}
		279
196	sub _log {	280	sub _log {
197	my ($ctx, $level, $format, @args) = @_;	281	my ($ctx, $level, $format, @args) = @_;
198		282
199	$level = $level > 0 && $level <= 9	283	$level = $level > 0 && $level <= 9
200	? $level+0	284	? $level+0
201	: $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";	285	: $STR2LEVEL{$level} \|\| Carp::croak "$level: not a valid logging level, caught";
202		286
203	my $mask = 1 << $level;	287	my $mask = 1 << $level;
204		288
205	my (%seen, @ctx, $now, $fmt);	289	my ($success, %seen, @ctx, $now, @fmt);
206		290
207	do	291	do
208	{	292	{
209	# skip if masked	293	# if !ref, then it's a level number
		294	if (!ref $ctx) {
		295	$level = $ctx;
210	if ($ctx->[1] & $mask && !$seen{$ctx+0}++) {	296	} elsif ($ctx->[1] & $mask and !$seen{$ctx+0}++) {
		297	# logging/recursing into this context
		298
		299	# level cap
		300	if ($ctx->[5] > $level) {
		301	push @ctx, $level; # restore level when going up in tree
		302	$level = $ctx->[5];
		303	}
		304
		305	# log if log cb
211	if ($ctx->[3]) {	306	if ($ctx->[3]) {
212	# logging target found	307	# logging target found
		308
		309	local ($!, $@);
213		310
214	# now get raw message, unless we have it already	311	# now get raw message, unless we have it already
215	unless ($now) {	312	unless ($now) {
216	$format = $format->() if ref $format;	313	$format = $format->() if ref $format;
217	$format = sprintf $format, @args if @args;	314	$format = sprintf $format, @args if @args;
218	$format =~ s/\n$//;	315	$format =~ s/\n$//;
219	$now = AE::now;	316	$now = _ts;
220	};	317	};
221		318
222	# format msg	319	# format msg
223	my $str = $ctx->[4]	320	my $str = $ctx->[4]
224	? $ctx->[4]($now, $_[0], $level, $format)	321	? $ctx->[4]($now, $_[0], $level, $format)
225	: $fmt \|\|= _format $now, $_[0], $level, $format;	322	: ($fmt[$level] \|\|= _format $now, $_[0], $level, $format);
226		323
		324	$success = 1;
		325
227	$ctx->[3]($str);	326	$ctx->[3]($str)
		327	or push @ctx, values %{ $ctx->[2] }; # not consumed - propagate
		328	} else {
		329	push @ctx, values %{ $ctx->[2] }; # not masked - propagate
228	}	330	}
229
230	# not masked, not consumed - propagate to parent contexts
231	push @ctx, values %{ $ctx->[2] };
232	}	331	}
233	}	332	}
234	while $ctx = pop @ctx;	333	while $ctx = pop @ctx;
235		334
236	exit 1 if $level <= 1;	335	fatal_exit if $level <= 1;
		336
		337	$success
237	}	338	}
238		339
239	sub log($$;@) {	340	sub log($$;@) {
240	_log	341	_log
241	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],	342	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],
242	@_;	343	@_;
243	}	344	}
244		345
245	AnyEvent::log = AE::log = \&log;
246
247	=item $logger = AnyEvent::Log::logger $level[, \$enabled]	346	=item $logger = AnyEvent::Log::logger $level[, \$enabled]
248		347
249	Creates a code reference that, when called, acts as if the	348	Creates a code reference that, when called, acts as if the
250	C<AnyEvent::Log::log> function was called at this point with the givne	349	C<AnyEvent::Log::log> function was called at this point with the given
251	level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with	350	level. C<$logger> is passed a C<$msg> and optional C<@args>, just as with
252	the C<AnyEvent::Log::log> function:	351	the C<AnyEvent::Log::log> function:
253		352
254	my $debug_log = AnyEvent::Log::logger "debug";	353	my $debug_log = AnyEvent::Log::logger "debug";
255		354
…		…
280	# and later in your program	379	# and later in your program
281	$debug_log->("yo, stuff here") if $debug;	380	$debug_log->("yo, stuff here") if $debug;
282		381
283	$debug and $debug_log->("123");	382	$debug and $debug_log->("123");
284		383
285	Note: currently the enabled var is always true - that will be fixed in a
286	future version :)
287
288	=cut	384	=cut
289		385
290	our %LOGGER;	386	our %LOGGER;
291		387
292	# re-assess logging status for all loggers	388	# re-assess logging status for all loggers
293	sub _reassess {	389	sub _reassess {
		390	local $SIG{__DIE__};
		391	my $die = sub { die };
		392
294	for (@_ ? $LOGGER{$_[0]} : values %LOGGER) {	393	for (@_ ? $LOGGER{$_[0]} : values %LOGGER) {
295	my ($ctx, $level, $renabled) = @$_;	394	my ($ctx, $level, $renabled) = @$_;
296		395
297	# to detect whether a message would be logged, we # actually	396	# to detect whether a message would be logged, we actually
298	# try to log one and die. this isn't fast, but we can be	397	# try to log one and die. this isn't fast, but we can be
299	# sure that the logging decision is correct :)	398	# sure that the logging decision is correct :)
300		399
301	$$renabled = !eval {	400	$$renabled = !eval {
302	local $SIG{__DIE__};
303
304	_log $ctx, $level, sub { die };	401	_log $ctx, $level, $die;
305		402
306	1	403	1
307	};	404	};
308
309	$$renabled = 1; # TODO
310	}	405	}
311	}	406	}
312		407
313	sub _logger {	408	sub _logger {
314	my ($ctx, $level, $renabled) = @_;	409	my ($ctx, $level, $renabled) = @_;
…		…
319		414
320	$LOGGER{$logger+0} = $logger;	415	$LOGGER{$logger+0} = $logger;
321		416
322	_reassess $logger+0;	417	_reassess $logger+0;
323		418
		419	require AnyEvent::Util unless $AnyEvent::Util::VERSION;
324	my $guard = AnyEvent::Util::guard {	420	my $guard = AnyEvent::Util::guard (sub {
325	# "clean up"	421	# "clean up"
326	delete $LOGGER{$logger+0};	422	delete $LOGGER{$logger+0};
327	};	423	});
328		424
329	sub {	425	sub {
330	$guard if 0; # keep guard alive, but don't cause runtime overhead	426	$guard if 0; # keep guard alive, but don't cause runtime overhead
331		427
332	_log $ctx, $level, @_	428	_log $ctx, $level, @_
…		…
337	sub logger($;$) {	433	sub logger($;$) {
338	_logger	434	_logger
339	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],	435	$CTX{ (caller)[0] } \|\|= _pkg_ctx +(caller)[0],
340	@_	436	@_
341	}	437	}
		438
		439	=item AnyEvent::Log::exact_time $on
		440
		441	By default, C<AnyEvent::Log> will use C<AE::now>, i.e. the cached
		442	eventloop time, for the log timestamps. After calling this function with a
		443	true value it will instead resort to C<AE::time>, i.e. fetch the current
		444	time on each log message. This only makes a difference for event loops
		445	that actually cache the time (such as L<EV> or L<AnyEvent::Loop>).
		446
		447	This setting can be changed at any time by calling this function.
		448
		449	Since C<AnyEvent::Log> has to work even before the L<AnyEvent> has been
		450	initialised, this switch will also decide whether to use C<CORE::time> or
		451	C<Time::HiRes::time> when logging a message before L<AnyEvent> becomes
		452	available.
342		453
343	=back	454	=back
344		455
345	=head1 LOGGING CONTEXTS	456	=head1 LOGGING CONTEXTS
346		457
…		…
359	timestamp, context, level and string message and formats it in the way	470	timestamp, context, level and string message and formats it in the way
360	it should be logged) and a logging callback (which is responsible for	471	it should be logged) and a logging callback (which is responsible for
361	actually logging the formatted message and telling C<AnyEvent::Log>	472	actually logging the formatted message and telling C<AnyEvent::Log>
362	whether it has consumed the message, or whether it should be propagated).	473	whether it has consumed the message, or whether it should be propagated).
363		474
364	For propagation, a context can have any number of attached I<parent	475	For propagation, a context can have any number of attached I<slave
365	contexts>. Any message that is neither masked by the logging mask nor	476	contexts>. Any message that is neither masked by the logging mask nor
366	masked by the logging callback returning true will be passed to all parent	477	masked by the logging callback returning true will be passed to all slave
367	contexts.	478	contexts.
368		479
369	Each call to a logging function will log the message at most once per	480	Each call to a logging function will log the message at most once per
370	context, so it does not matter (much) if there are cycles or if the	481	context, so it does not matter (much) if there are cycles or if the
371	message can arrive at the same context via multiple paths.	482	message can arrive at the same context via multiple paths.
…		…
375	By default, all logging contexts have an full set of log levels ("all"), a	486	By default, all logging contexts have an full set of log levels ("all"), a
376	disabled logging callback and the default formatting callback.	487	disabled logging callback and the default formatting callback.
377		488
378	Package contexts have the package name as logging title by default.	489	Package contexts have the package name as logging title by default.
379		490
380	They have exactly one parent - the context of the "parent" package. The	491	They have exactly one slave - the context of the "parent" package. The
381	parent package is simply defined to be the package name without the last	492	parent package is simply defined to be the package name without the last
382	component, i.e. C<AnyEvent::Debug::Wrapped> becomes C<AnyEvent::Debug>,	493	component, i.e. C<AnyEvent::Debug::Wrapped> becomes C<AnyEvent::Debug>,
383	and C<AnyEvent> becomes ... C<AnyEvent::Log::Top> which is the	494	and C<AnyEvent> becomes ... C<$AnyEvent::Log::COLLECT> which is the
384	exception of the rule - just like the parent of any package name in	495	exception of the rule - just like the "parent" of any single-component
385	Perl is C<main>, the default parent of any top-level package context is	496	package name in Perl is C<main>, the default slave of any top-level
386	C<AnyEvent::Log::Top>.	497	package context is C<$AnyEvent::Log::COLLECT>.
387		498
388	Since perl packages form only an approximate hierarchy, this parent	499	Since perl packages form only an approximate hierarchy, this slave
389	context can of course be removed.	500	context can of course be removed.
390		501
391	All other (anonymous) contexts have no parents and an empty title by	502	All other (anonymous) contexts have no slaves and an empty title by
392	default.	503	default.
393		504
394	When the module is loaded it creates the default context called	505	When the module is loaded it creates the C<$AnyEvent::Log::LOG> logging
395	C<AnyEvent::Log::Default> (also stored in C<$AnyEvent::Log::Default>),	506	context that simply logs everything via C<warn>, without propagating
396	which simply logs everything via C<warn> and doesn't propagate anything
397	anywhere by default. The purpose of the default context is to provide	507	anything anywhere by default. The purpose of this context is to provide
398	a convenient place to override the global logging target or to attach	508	a convenient place to override the global logging target or to attach
399	additional log targets. It's not meant for filtering.	509	additional log targets. It's not meant for filtering.
400		510
401	It then creates the root context called C<AnyEvent::Log::Root> (also	511	It then creates the C<$AnyEvent::Log::FILTER> context whose
402	stored in C<$AnyEvent::Log::Root>) and sets its log level set to all	512	purpose is to suppress all messages with priority higher
403	levels up to the one specified by C<$ENV{PERL_ANYEVENT_VERBOSE}>. It	513	than C<$ENV{PERL_ANYEVENT_VERBOSE}>. It then attached the
404	then attached the default logging context to it. The purpose of the root	514	C<$AnyEvent::Log::LOG> context to it. The purpose of the filter context
405	context is to simply provide filtering according to some global log level.	515	is to simply provide filtering according to some global log level.
406		516
407	Finally it creates the top-level package context called	517	Finally it creates the top-level package context C<$AnyEvent::Log::COLLECT>
408	C<AnyEvent::Log::Top> (also stored in, you might have guessed,	518	and attaches the C<$AnyEvent::Log::FILTER> context to it, but otherwise
409	C<$AnyEvent::Log::Top>) and attached the root context but otherwise leaves
410	it at default config. It's purpose is simply to collect all log messages	519	leaves it at default config. Its purpose is simply to collect all log
411	system-wide.	520	messages system-wide.
412		521
413	These three special contexts can also be referred to by the	522	The hierarchy is then:
414	package/context names C<AE::Log::Default>, C<AE::Log::Root> and
415	C<AE::Log::Top>.
416		523
		524	any package, eventually -> $COLLECT -> $FILTER -> $LOG
		525
417	The effect of all this is that log messages, by default, wander up	526	The effect of all this is that log messages, by default, wander up to the
418	to the root context where log messages with lower priority then	527	C<$AnyEvent::Log::COLLECT> context where all messages normally end up,
		528	from there to C<$AnyEvent::Log::FILTER> where log messages with lower
419	C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered away and then to the	529	priority then C<$ENV{PERL_ANYEVENT_VERBOSE}> will be filtered out and then
420	AnyEvent::Log::Default context to be passed to C<warn>.	530	to the C<$AnyEvent::Log::LOG> context to be passed to C<warn>.
421		531
422	Splitting the top level context into three contexts makes it easy to set	532	This makes it easy to set a global logging level (by modifying $FILTER),
423	a global logging level (by modifying the root context), but still allow	533	but still allow other contexts to send, for example, their debug and trace
424	other contexts to log, for example, their debug and trace messages to the
425	default target despite the global logging level, or to attach additional	534	messages to the $LOG target despite the global logging level, or to attach
426	log targets that log messages, regardless of the global logging level.	535	additional log targets that log messages, regardless of the global logging
		536	level.
427		537
428	It also makes it easy to replace the default warn-logger by something that	538	It also makes it easy to modify the default warn-logger ($LOG) to
429	logs to a file, or to attach additional logging targets.	539	something that logs to a file, or to attach additional logging targets
		540	(such as loggign to a file) by attaching it to $FILTER.
430		541
431	=head2 CREATING/FINDING/DESTROYING CONTEXTS	542	=head2 CREATING/FINDING/DESTROYING CONTEXTS
432		543
433	=over 4	544	=over 4
434		545
…		…
456	: bless [undef, (1 << 10) - 1 - 1], "AnyEvent::Log::Ctx"	567	: bless [undef, (1 << 10) - 1 - 1], "AnyEvent::Log::Ctx"
457	}	568	}
458		569
459	=item AnyEvent::Log::reset	570	=item AnyEvent::Log::reset
460		571
461	Resets all package contexts contexts and recreates the default hierarchy	572	Resets all package contexts and recreates the default hierarchy if
462	if necessary, i.e. resets the logging subsystem to defaults.	573	necessary, i.e. resets the logging subsystem to defaults, as much as
		574	possible. This process keeps references to contexts held by other parts of
		575	the program intact.
463		576
464	This can be used to implement config-file (re-)loading: before loading a	577	This can be used to implement config-file (re-)loading: before loading a
465	configuration, reset all contexts.	578	configuration, reset all contexts.
466		579
467	Note that this currently destroys all logger callbacks - bug me if you
468	need this fixed :)
469
470	=cut	580	=cut
		581
		582	our $ORIG_VERBOSE = $AnyEvent::VERBOSE;
		583	$AnyEvent::VERBOSE = 9;
471		584
472	sub reset {	585	sub reset {
473	# hard to kill complex data structures	586	# hard to kill complex data structures
474	# we recreate all package loggers and reset the hierarchy	587	# we "recreate" all package loggers and reset the hierarchy
475	while (my ($k, $v) = each %CTX) {	588	while (my ($k, $v) = each %CTX) {
476	@$v = ($k, (1 << 10) - 1 - 1, { });	589	@$v = ($k, (1 << 10) - 1 - 1, { });
477		590
478	my $pkg = $k =~ /^(.+)::/ ? $1 : "AE::Log::Top";	591	$v->attach ($k =~ /^(.+)::/ ? $CTX{$1} : $AnyEvent::Log::COLLECT);
479	$v->attach ($CTX{$pkg});
480	}	592	}
481		593
482	$AnyEvent::Log::Default->parents;	594	@$_ = ($_->[0], (1 << 10) - 1 - 1)
483	$AnyEvent::Log::Default->title ("AnyEvent::Log::Default");	595	for $LOG, $FILTER, $COLLECT;
484	$AnyEvent::Log::Default->log_cb (sub {
485	warn shift;
486	0
487	});
488	$CTX{"AnyEvent::Log::Default"} = $CTX{"AE::Log::Default"} = $AnyEvent::Log::Default;
489		596
490	$AnyEvent::Log::Root->parents ($AnyEvent::Log::Default);	597	#$LOG->slaves;
491	$AnyEvent::Log::Root->title ("AnyEvent::Log::Root");	598	$LOG->title ('$AnyEvent::Log::LOG');
492	$AnyEvent::Log::Root->level ($AnyEvent::VERBOSE);	599	$LOG->log_to_warn;
493	$CTX{"AnyEvent::Log::Root"} = $CTX{"AE::Log::Root"} = $AnyEvent::Log::Root;
494		600
495	$AnyEvent::Log::Top->parents ($AnyEvent::Log::Root);	601	$FILTER->slaves ($LOG);
496	$AnyEvent::Log::Top->title ("AnyEvent::Log::Top");	602	$FILTER->title ('$AnyEvent::Log::FILTER');
497	$CTX{"AnyEvent::Log::Top"} = $CTX{"AE::Log::Top"} = $AnyEvent::Log::Top;	603	$FILTER->level ($ORIG_VERBOSE);
		604
		605	$COLLECT->slaves ($FILTER);
		606	$COLLECT->title ('$AnyEvent::Log::COLLECT');
498		607
499	_reassess;	608	_reassess;
500	}	609	}
501		610
		611	# override AE::log/logger
		612	AnyEvent::log = AE::log = \&log;
		613	AnyEvent::logger = AE::logger = \&logger;
		614
		615	# convert AnyEvent loggers to AnyEvent::Log loggers
		616	$_->[0] = ctx $_->[0] # convert "pkg" to "ctx"
		617	for values %LOGGER;
		618
502	# create the default logger contexts	619	# create the default logger contexts
503	$AnyEvent::Log::Default = ctx undef;	620	$LOG = ctx undef;
504	$AnyEvent::Log::Root = ctx undef;	621	$FILTER = ctx undef;
505	$AnyEvent::Log::Top = ctx undef;	622	$COLLECT = ctx undef;
506		623
507	AnyEvent::Log::reset;	624	AnyEvent::Log::reset;
508		625
509	# hello, CPAN, please catch me	626	# hello, CPAN, please catch me
510	package AnyEvent::Log::Default;
511	package AE::Log::Default;
512	package AnyEvent::Log::Root;
513	package AE::Log::Root;
514	package AnyEvent::Log::Top;	627	package AnyEvent::Log::LOG;
515	package AE::Log::Top;	628	package AE::Log::LOG;
		629	package AnyEvent::Log::FILTER;
		630	package AE::Log::FILTER;
		631	package AnyEvent::Log::COLLECT;
		632	package AE::Log::COLLECT;
516		633
517	package AnyEvent::Log::Ctx;	634	package AnyEvent::Log::Ctx;
518
519	# 0 1 2 3 4
520	# [$title, $level, %$parents, &$logcb, &$fmtcb]
521		635
522	=item $ctx = new AnyEvent::Log::Ctx methodname => param...	636	=item $ctx = new AnyEvent::Log::Ctx methodname => param...
523		637
524	This is a convenience constructor that makes it simpler to construct	638	This is a convenience constructor that makes it simpler to construct
525	anonymous logging contexts.	639	anonymous logging contexts.
…		…
528	name as the key with the value as parameter, unless the value is an	642	name as the key with the value as parameter, unless the value is an
529	arrayref, in which case it calls the method with the contents of the	643	arrayref, in which case it calls the method with the contents of the
530	array. The methods are called in the same order as specified.	644	array. The methods are called in the same order as specified.
531		645
532	Example: create a new logging context and set both the default logging	646	Example: create a new logging context and set both the default logging
533	level, some parent contexts and a logging callback.	647	level, some slave contexts and a logging callback.
534		648
535	$ctx = new AnyEvent::Log::Ctx	649	$ctx = new AnyEvent::Log::Ctx
536	title => "dubious messages",	650	title => "dubious messages",
537	level => "error",	651	level => "error",
538	log_cb => sub { print STDOUT shift; 0 },	652	log_cb => sub { print STDOUT shift; 0 },
539	parents => [$ctx1, $ctx, $ctx2],	653	slaves => [$ctx1, $ctx, $ctx2],
540	;	654	;
541		655
542	=back	656	=back
543		657
544	=cut	658	=cut
…		…
612	Enables logging for the given levels, leaving all others unchanged.	726	Enables logging for the given levels, leaving all others unchanged.
613		727
614	=item $ctx->disable ($level[, $level...])	728	=item $ctx->disable ($level[, $level...])
615		729
616	Disables logging for the given levels, leaving all others unchanged.	730	Disables logging for the given levels, leaving all others unchanged.
		731
		732	=item $ctx->cap ($level)
		733
		734	Caps the maximum priority to the given level, for all messages logged
		735	to, or passing through, this context. That is, while this doesn't affect
		736	whether a message is logged or passed on, the maximum priority of messages
		737	will be limited to the specified level - messages with a higher priority
		738	will be set to the specified priority.
		739
		740	Another way to view this is that C<< ->level >> filters out messages with
		741	a too low priority, while C<< ->cap >> modifies messages with a too high
		742	priority.
		743
		744	This is useful when different log targets have different interpretations
		745	of priority. For example, for a specific command line program, a wrong
		746	command line switch might well result in a C<fatal> log message, while the
		747	same message, logged to syslog, is likely I<not> fatal to the system or
		748	syslog facility as a whole, but more likely a mere C<error>.
		749
		750	This can be modeled by having a stderr logger that logs messages "as-is"
		751	and a syslog logger that logs messages with a level cap of, say, C<error>,
		752	or, for truly system-critical components, actually C<critical>.
617		753
618	=cut	754	=cut
619		755
620	sub _lvl_lst {	756	sub _lvl_lst {
621	map {	757	map {
…		…
623	: $_ eq "all" ? (1 .. 9)	759	: $_ eq "all" ? (1 .. 9)
624	: $STR2LEVEL{$_} \|\| Carp::croak "$_: not a valid logging level, caught"	760	: $STR2LEVEL{$_} \|\| Carp::croak "$_: not a valid logging level, caught"
625	} @_	761	} @_
626	}	762	}
627		763
		764	sub _lvl {
		765	$_[0] =~ /^(?:0\|off\|none)$/ ? 0 : (_lvl_lst $_[0])[-1]
		766	}
		767
628	our $NOP_CB = sub { 0 };	768	our $NOP_CB = sub { 0 };
629		769
630	sub levels {	770	sub levels {
631	my $ctx = shift;	771	my $ctx = shift;
632	$ctx->[1] = 0;	772	$ctx->[1] = 0;
…		…
635	AnyEvent::Log::_reassess;	775	AnyEvent::Log::_reassess;
636	}	776	}
637		777
638	sub level {	778	sub level {
639	my $ctx = shift;	779	my $ctx = shift;
640	my $lvl = $_[0] =~ /^(?:0\|off\|none)$/ ? 0 : (_lvl_lst $_[0])[-1];
641
642	$ctx->[1] = ((1 << $lvl) - 1) << 1;	780	$ctx->[1] = ((1 << &_lvl) - 1) << 1;
643	AnyEvent::Log::_reassess;	781	AnyEvent::Log::_reassess;
644	}	782	}
645		783
646	sub enable {	784	sub enable {
647	my $ctx = shift;	785	my $ctx = shift;
…		…
655	$ctx->[1] &= ~(1 << $_)	793	$ctx->[1] &= ~(1 << $_)
656	for &_lvl_lst;	794	for &_lvl_lst;
657	AnyEvent::Log::_reassess;	795	AnyEvent::Log::_reassess;
658	}	796	}
659		797
		798	sub cap {
		799	my $ctx = shift;
		800	$ctx->[5] = &_lvl;
		801	}
		802
660	=back	803	=back
661		804
662	=head3 PARENT CONTEXTS	805	=head3 SLAVE CONTEXTS
663		806
664	The following methods attach and detach another logging context to a	807	The following methods attach and detach another logging context to a
665	logging context.	808	logging context.
666		809
667	Log messages are propagated to all parent contexts, unless the logging	810	Log messages are propagated to all slave contexts, unless the logging
668	callback consumes the message.	811	callback consumes the message.
669		812
670	=over 4	813	=over 4
671		814
672	=item $ctx->attach ($ctx2[, $ctx3...])	815	=item $ctx->attach ($ctx2[, $ctx3...])
673		816
674	Attaches the given contexts as parents to this context. It is not an error	817	Attaches the given contexts as slaves to this context. It is not an error
675	to add a context twice (the second add will be ignored).	818	to add a context twice (the second add will be ignored).
676		819
677	A context can be specified either as package name or as a context object.	820	A context can be specified either as package name or as a context object.
678		821
679	=item $ctx->detach ($ctx2[, $ctx3...])	822	=item $ctx->detach ($ctx2[, $ctx3...])
680		823
681	Removes the given parents from this context - it's not an error to attempt	824	Removes the given slaves from this context - it's not an error to attempt
682	to remove a context that hasn't been added.	825	to remove a context that hasn't been added.
683		826
684	A context can be specified either as package name or as a context object.	827	A context can be specified either as package name or as a context object.
685		828
686	=item $ctx->parents ($ctx2[, $ctx3...])	829	=item $ctx->slaves ($ctx2[, $ctx3...])
687		830
688	Replaces all parents attached to this context by the ones given.	831	Replaces all slaves attached to this context by the ones given.
689		832
690	=cut	833	=cut
691		834
692	sub attach {	835	sub attach {
693	my $ctx = shift;	836	my $ctx = shift;
…		…
701		844
702	delete $ctx->[2]{$_+0}	845	delete $ctx->[2]{$_+0}
703	for map { AnyEvent::Log::ctx $_ } @_;	846	for map { AnyEvent::Log::ctx $_ } @_;
704	}	847	}
705		848
706	sub parents {	849	sub slaves {
707	undef $_[0][2];	850	undef $_[0][2];
708	&attach;	851	&attach;
709	}	852	}
710		853
711	=back	854	=back
712		855
713	=head3 MESSAGE LOGGING	856	=head3 LOG TARGETS
714		857
715	The following methods configure how the logging context actually does	858	The following methods configure how the logging context actually does
716	the logging (which consists of formatting the message and printing it or	859	the logging (which consists of formatting the message and printing it or
717	whatever it wants to do with it) and also allows you to log messages	860	whatever it wants to do with it).
718	directly to a context, without going via your package context.
719		861
720	=over 4	862	=over 4
721		863
722	=item $ctx->log_cb ($cb->($str))	864	=item $ctx->log_cb ($cb->($str)
723		865
724	Replaces the logging callback on the context (C<undef> disables the	866	Replaces the logging callback on the context (C<undef> disables the
725	logging callback).	867	logging callback).
726		868
727	The logging callback is responsible for handling formatted log messages	869	The logging callback is responsible for handling formatted log messages
728	(see C<fmt_cb> below) - normally simple text strings that end with a	870	(see C<fmt_cb> below) - normally simple text strings that end with a
729	newline (and are possibly multiline themselves).	871	newline (and are possibly multiline themselves).
730		872
731	It also has to return true iff it has consumed the log message, and false	873	It also has to return true iff it has consumed the log message, and false
732	if it hasn't. Consuming a message means that it will not be sent to any	874	if it hasn't. Consuming a message means that it will not be sent to any
733	parent context. When in doubt, return C<0> from your logging callback.	875	slave context. When in doubt, return C<0> from your logging callback.
734		876
735	Example: a very simple logging callback, simply dump the message to STDOUT	877	Example: a very simple logging callback, simply dump the message to STDOUT
736	and do not consume it.	878	and do not consume it.
737		879
738	$ctx->log_cb (sub { print STDERR shift; 0 });	880	$ctx->log_cb (sub { print STDERR shift; 0 });
…		…
746	your program.	888	your program.
747		889
748	$ctx->levels ("debug", "trace");	890	$ctx->levels ("debug", "trace");
749	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages	891	$ctx->log_cb (sub { 1 }); # do not log, but eat debug and trace messages
750		892
751	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $ctx, $level, $message))	893	=item $ctx->fmt_cb ($fmt_cb->($timestamp, $orig_ctx, $level, $message))
752		894
753	Replaces the formatting callback on the context (C<undef> restores the	895	Replaces the formatting callback on the context (C<undef> restores the
754	default formatter).	896	default formatter).
755		897
756	The callback is passed the (possibly fractional) timestamp, the original	898	The callback is passed the (possibly fractional) timestamp, the original
757	logging context, the (numeric) logging level and the raw message string and needs to	899	logging context, the (numeric) logging level and the raw message string
758	return a formatted log message. In most cases this will be a string, but	900	and needs to return a formatted log message. In most cases this will be a
759	it could just as well be an array reference that just stores the values.	901	string, but it could just as well be an array reference that just stores
		902	the values.
		903
		904	If, for some reason, you want to use C<caller> to find out more baout the
		905	logger then you should walk up the call stack until you are no longer
		906	inside the C<AnyEvent::Log> package.
760		907
761	Example: format just the raw message, with numeric log level in angle	908	Example: format just the raw message, with numeric log level in angle
762	brackets.	909	brackets.
763		910
764	$ctx->fmt_cb (sub {	911	$ctx->fmt_cb (sub {
…		…
781	"$msg->[3]";	928	"$msg->[3]";
782		929
783	0	930	0
784	});	931	});
785		932
		933	=item $ctx->log_to_warn
		934
		935	Sets the C<log_cb> to simply use C<CORE::warn> to report any messages
		936	(usually this logs to STDERR).
		937
		938	=item $ctx->log_to_file ($path)
		939
		940	Sets the C<log_cb> to log to a file (by appending), unbuffered.
		941
		942	=item $ctx->log_to_path ($path)
		943
		944	Same as C<< ->log_to_file >>, but opens the file for each message. This
		945	is much slower, but allows you to change/move/rename/delete the file at
		946	basically any time.
		947
		948	Needless(?) to say, if you do not want to be bitten by some evil person
		949	calling C<chdir>, the path should be absolute. Doesn't help with
		950	C<chroot>, but hey...
		951
		952	=item $ctx->log_to_syslog ([$facility])
		953
		954	Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and
		955	all the others in the obvious way. If specified, then the C<$facility> is
		956	used as the facility (C<user>, C<auth>, C<local0> and so on). The default
		957	facility is C<user>.
		958
		959	Note that this function also sets a C<fmt_cb> - the logging part requires
		960	an array reference with [$level, $str] as input.
		961
786	=cut	962	=cut
787		963
788	sub log_cb {	964	sub log_cb {
789	my ($ctx, $cb) = @_;	965	my ($ctx, $cb) = @_;
790		966
…		…
795	my ($ctx, $cb) = @_;	971	my ($ctx, $cb) = @_;
796		972
797	$ctx->[4] = $cb;	973	$ctx->[4] = $cb;
798	}	974	}
799		975
800	=item $ctx->log ($level, $msg[, @params])	976	sub log_to_warn {
		977	my ($ctx, $path) = @_;
801		978
802	Same as C<AnyEvent::Log::log>, but uses the given context as log context.	979	$ctx->log_cb (sub {
		980	warn shift;
		981	0
		982	});
		983	}
803		984
804	=item $logger = $ctx->logger ($level[, \$enabled])	985	sub log_to_file {
805		986	my ($ctx, $path) = @_;
806	Same as C<AnyEvent::Log::logger>, but uses the given context as log
807	context.
808
809	=cut
810
811	*log = \&AnyEvent::Log::_log;
812	*logger = \&AnyEvent::Log::_logger;
813
814	1;
815
816	=back
817
818	=head1 EXAMPLES
819
820	This section shows some common configurations.
821
822	=over 4
823
824	=item Setting the global logging level.
825
826	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before
827	running your program, or modify the log level of the root context:
828
829	PERL_ANYEVENT_VERBOSE=5 ./myprog
830
831	$AnyEvent::Log::Root->level ("warn");
832
833	=item Append all messages to a file instead of sending them to STDERR.
834
835	This is affected by the global logging level.
836		987
837	open my $fh, ">>", $path	988	open my $fh, ">>", $path
838	or die "$path: $!";	989	or die "$path: $!";
839		990
840	$AnyEvent::Log::Default->log_cb (sub {	991	$ctx->log_cb (sub {
841	syswrite $fh, shift;	992	syswrite $fh, shift;
842	0	993	0
843	});	994	});
		995	}
		996
		997	sub log_to_path {
		998	my ($ctx, $path) = @_;
		999
		1000	$ctx->log_cb (sub {
		1001	open my $fh, ">>", $path
		1002	or die "$path: $!";
		1003
		1004	syswrite $fh, shift;
		1005	0
		1006	});
		1007	}
		1008
		1009	sub log_to_syslog {
		1010	my ($ctx, $facility) = @_;
		1011
		1012	require Sys::Syslog;
		1013
		1014	$ctx->fmt_cb (sub {
		1015	my $str = $_[3];
		1016	$str =~ s/\n(?=.)/\n+ /g;
		1017
		1018	[$_[2], "($_[1][0]) $str"]
		1019	});
		1020
		1021	$facility \|\|= "user";
		1022
		1023	$ctx->log_cb (sub {
		1024	my $lvl = $_[0][0] < 9 ? $_[0][0] : 8;
		1025
		1026	Sys::Syslog::syslog ("$facility\|" . ($lvl - 1), $_)
		1027	for split /\n/, $_[0][1];
		1028
		1029	0
		1030	});
		1031	}
		1032
		1033	=back
		1034
		1035	=head3 MESSAGE LOGGING
		1036
		1037	These methods allow you to log messages directly to a context, without
		1038	going via your package context.
		1039
		1040	=over 4
		1041
		1042	=item $ctx->log ($level, $msg[, @params])
		1043
		1044	Same as C<AnyEvent::Log::log>, but uses the given context as log context.
		1045
		1046	=item $logger = $ctx->logger ($level[, \$enabled])
		1047
		1048	Same as C<AnyEvent::Log::logger>, but uses the given context as log
		1049	context.
		1050
		1051	=cut
		1052
		1053	*log = \&AnyEvent::Log::_log;
		1054	*logger = \&AnyEvent::Log::_logger;
		1055
		1056	=back
		1057
		1058	=cut
		1059
		1060	package AnyEvent::Log;
		1061
		1062	=head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG}
		1063
		1064	Logging can also be configured by setting the environment variable
		1065	C<PERL_ANYEVENT_LOG> (or C<AE_LOG>).
		1066
		1067	The value consists of one or more logging context specifications separated
		1068	by C<:> or whitespace. Each logging specification in turn starts with a
		1069	context name, followed by C<=>, followed by zero or more comma-separated
		1070	configuration directives, here are some examples:
		1071
		1072	# set default logging level
		1073	filter=warn
		1074
		1075	# log to file instead of to stderr
		1076	log=file=/tmp/mylog
		1077
		1078	# log to file in addition to stderr
		1079	log=+%file:%file=file=/tmp/mylog
		1080
		1081	# enable debug log messages, log warnings and above to syslog
		1082	filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0
		1083
		1084	# log trace messages (only) from AnyEvent::Debug to file
		1085	AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog
		1086
		1087	A context name in the log specification can be any of the following:
		1088
		1089	=over 4
		1090
		1091	=item C<collect>, C<filter>, C<log>
		1092
		1093	Correspond to the three predefined C<$AnyEvent::Log::COLLECT>,
		1094	C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts.
		1095
		1096	=item C<%name>
		1097
		1098	Context names starting with a C<%> are anonymous contexts created when the
		1099	name is first mentioned. The difference to package contexts is that by
		1100	default they have no attached slaves.
		1101
		1102	=item a perl package name
		1103
		1104	Any other string references the logging context associated with the given
		1105	Perl C<package>. In the unlikely case where you want to specify a package
		1106	context that matches on of the other context name forms, you can add a
		1107	C<::> to the package name to force interpretation as a package.
		1108
		1109	=back
		1110
		1111	The configuration specifications can be any number of the following:
		1112
		1113	=over 4
		1114
		1115	=item C<stderr>
		1116
		1117	Configures the context to use Perl's C<warn> function (which typically
		1118	logs to C<STDERR>). Works like C<log_to_warn>.
		1119
		1120	=item C<file=>I<path>
		1121
		1122	Configures the context to log to a file with the given path. Works like
		1123	C<log_to_file>.
		1124
		1125	=item C<path=>I<path>
		1126
		1127	Configures the context to log to a file with the given path. Works like
		1128	C<log_to_path>.
		1129
		1130	=item C<syslog> or C<syslog=>I<expr>
		1131
		1132	Configures the context to log to syslog. If I<expr> is given, then it is
		1133	evaluated in the L<Sys::Syslog> package, so you could use:
		1134
		1135	log=syslog=LOG_LOCAL0
		1136
		1137	=item C<nolog>
		1138
		1139	Configures the context to not log anything by itself, which is the
		1140	default. Same as C<< $ctx->log_cb (undef) >>.
		1141
		1142	=item C<cap=>I<level>
		1143
		1144	Caps logging messages entering this context at the given level, i.e.
		1145	reduces the priority of messages with higher priority than this level. The
		1146	default is C<0> (or C<off>), meaning the priority will not be touched.
		1147
		1148	=item C<0> or C<off>
		1149
		1150	Sets the logging level of the context to C<0>, i.e. all messages will be
		1151	filtered out.
		1152
		1153	=item C<all>
		1154
		1155	Enables all logging levels, i.e. filtering will effectively be switched
		1156	off (the default).
		1157
		1158	=item C<only>
		1159
		1160	Disables all logging levels, and changes the interpretation of following
		1161	level specifications to enable the specified level only.
		1162
		1163	Example: only enable debug messages for a context.
		1164
		1165	context=only,debug
		1166
		1167	=item C<except>
		1168
		1169	Enables all logging levels, and changes the interpretation of following
		1170	level specifications to disable that level. Rarely used.
		1171
		1172	Example: enable all logging levels except fatal and trace (this is rather
		1173	nonsensical).
		1174
		1175	filter=exept,fatal,trace
		1176
		1177	=item C<level>
		1178
		1179	Enables all logging levels, and changes the interpretation of following
		1180	level specifications to be "that level or any higher priority
		1181	message". This is the default.
		1182
		1183	Example: log anything at or above warn level.
		1184
		1185	filter=warn
		1186
		1187	# or, more verbose
		1188	filter=only,level,warn
		1189
		1190	=item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.)
		1191
		1192	A numeric loglevel or the name of a loglevel will be interpreted according
		1193	to the most recent C<only>, C<except> or C<level> directive. By default,
		1194	specifying a logging level enables that and any higher priority messages.
		1195
		1196	=item C<+>I<context>
		1197
		1198	Attaches the named context as slave to the context.
		1199
		1200	=item C<+>
		1201
		1202	A line C<+> detaches all contexts, i.e. clears the slave list from the
		1203	context. Anonymous (C<%name>) contexts have no attached slaves by default,
		1204	but package contexts have the parent context as slave by default.
		1205
		1206	Example: log messages from My::Module to a file, do not send them to the
		1207	default log collector.
		1208
		1209	My::Module=+,file=/tmp/mymodulelog
		1210
		1211	=back
		1212
		1213	Any character can be escaped by prefixing it with a C<\> (backslash), as
		1214	usual, so to log to a file containing a comma, colon, backslash and some
		1215	spaces in the filename, you would do this:
		1216
		1217	PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes'
		1218
		1219	Since whitespace (which includes newlines) is allowed, it is fine to
		1220	specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.:
		1221
		1222	PERL_ANYEVENT_LOG="
		1223	filter=warn
		1224	AnyEvent::Debug=+%trace
		1225	%trace=only,trace,+log
		1226	" myprog
		1227
		1228	Also, in the unlikely case when you want to concatenate specifications,
		1229	use whitespace as separator, as C<::> will be interpreted as part of a
		1230	module name, an empty spec with two separators:
		1231
		1232	PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug"
		1233
		1234	=cut
		1235
		1236	for (my $spec = $ENV{PERL_ANYEVENT_LOG}) {
		1237	my %anon;
		1238
		1239	my $pkg = sub {
		1240	$_[0] eq "log" ? $LOG
		1241	: $_[0] eq "filter" ? $FILTER
		1242	: $_[0] eq "collect" ? $COLLECT
		1243	: $_[0] =~ /^%(.+)$/ ? ($anon{$1} \|\|= do { my $ctx = ctx undef; $ctx->[0] = $_[0]; $ctx })
		1244	: $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/
		1245	: die # never reached?
		1246	};
		1247
		1248	/\G[[:space:]]+/gc; # skip initial whitespace
		1249
		1250	while (/\G((?:[^:=[:space:]]+\|::\|\\.)+)=/gc) {
		1251	my $ctx = $pkg->($1);
		1252	my $level = "level";
		1253
		1254	while (/\G((?:[^,:[:space:]]+\|::\|\\.)+)/gc) {
		1255	for ("$1") {
		1256	if ($_ eq "stderr" ) { $ctx->log_to_warn;
		1257	} elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1");
		1258	} elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1");
		1259	} elsif (/^syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog ("$1");
		1260	} elsif ($_ eq "nolog" ) { $ctx->log_cb (undef);
		1261	} elsif (/^cap=(.+)/ ) { $ctx->cap ("$1");
		1262	} elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1"));
		1263	} elsif ($_ eq "+" ) { $ctx->slaves;
		1264	} elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0);
		1265	} elsif ($_ eq "all" ) { $ctx->level ("all");
		1266	} elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level";
		1267	} elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable";
		1268	} elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable";
		1269	} elsif (/^\d$/ ) { $ctx->$level ($_);
		1270	} elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_);
		1271	} else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n";
		1272	}
		1273	}
		1274
		1275	/\G,/gc or last;
		1276	}
		1277
		1278	/\G[:[:space:]]+/gc or last;
		1279	}
		1280
		1281	/\G[[:space:]]+/gc; # skip trailing whitespace
		1282
		1283	if (/\G(.+)/g) {
		1284	die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n";
		1285	}
		1286	}
		1287
		1288	1;
		1289
		1290	=head1 EXAMPLES
		1291
		1292	This section shows some common configurations, both as code, and as
		1293	C<PERL_ANYEVENT_LOG> string.
		1294
		1295	=over 4
		1296
		1297	=item Setting the global logging level.
		1298
		1299	Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before
		1300	running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of
		1301	the root context at runtime:
		1302
		1303	PERL_ANYEVENT_VERBOSE=5 ./myprog
		1304
		1305	PERL_ANYEVENT_LOG=log=warn
		1306
		1307	$AnyEvent::Log::FILTER->level ("warn");
		1308
		1309	=item Append all messages to a file instead of sending them to STDERR.
		1310
		1311	This is affected by the global logging level.
		1312
		1313	$AnyEvent::Log::LOG->log_to_file ($path);
		1314
		1315	PERL_ANYEVENT_LOG=log=file=/some/path
844		1316
845	=item Write all messages with priority C<error> and higher to a file.	1317	=item Write all messages with priority C<error> and higher to a file.
846		1318
847	This writes them only when the global logging level allows it, because	1319	This writes them only when the global logging level allows it, because
848	it is attached to the default context which is invoked I<after> global	1320	it is attached to the default context which is invoked I<after> global
849	filtering.	1321	filtering.
850		1322
851	open my $fh, ">>", $path	1323	$AnyEvent::Log::FILTER->attach (
852	or die "$path: $!";	1324	new AnyEvent::Log::Ctx log_to_file => $path);
853		1325
854	$AnyEvent::Log::Default->attach (new AnyEvent::Log::Ctx	1326	PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path
855	log_cb => sub { syswrite $fh, shift; 0 });
856		1327
857	This writes them regardless of the global logging level, because it is	1328	This writes them regardless of the global logging level, because it is
858	attached to the toplevel context, which receives all messages I<before>	1329	attached to the toplevel context, which receives all messages I<before>
859	the global filtering.	1330	the global filtering.
860		1331
861	$AnyEvent::Log::Top->attach (new AnyEvent::Log::Ctx	1332	$AnyEvent::Log::COLLECT->attach (
862	log_cb => sub { syswrite $fh, shift; 0 });	1333	new AnyEvent::Log::Ctx log_to_file => $path);
863		1334
		1335	PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger
		1336
864	In both cases, messages are still written to STDOUT.	1337	In both cases, messages are still written to STDERR.
		1338
		1339	=item Additionally log all messages with C<warn> and higher priority to
		1340	C<syslog>, but cap at C<error>.
		1341
		1342	This logs all messages to the default log target, but also logs messages
		1343	with priority C<warn> or higher (and not filtered otherwise) to syslog
		1344	facility C<user>. Messages with priority higher than C<error> will be
		1345	logged with level C<error>.
		1346
		1347	$AnyEvent::Log::LOG->attach (
		1348	new AnyEvent::Log::Ctx
		1349	level => "warn",
		1350	cap => "error",
		1351	syslog => "user",
		1352	);
		1353
		1354	PERL_ANYEVENT_LOG=log=+%syslog:%syslog=warn,cap=error,syslog
865		1355
866	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).	1356	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).
867		1357
868	Attach the CyAnyEvent::Log::Default> context to the C<AnyEvent::Debug>	1358	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>
869	context and increase the C<AnyEvent::Debug> logging level - this simply
870	circumvents the global filtering for trace messages.	1359	context - this simply circumvents the global filtering for trace messages.
871		1360
872	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;	1361	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
873	$debug->attach ($AnyEvent::Log::Default);	1362	$debug->attach ($AnyEvent::Log::LOG);
874	$debug->levels ("trace"); # not "level"!
875		1363
876	This of course works for any package.	1364	PERL_ANYEVENT_LOG=AnyEvent::Debug=+log
		1365
		1366	This of course works for any package, not just L<AnyEvent::Debug>, but
		1367	assumes the log level for AnyEvent::Debug hasn't been changed from the
		1368	default.
877		1369
878	=back	1370	=back
879		1371
880	=head1 AUTHOR	1372	=head1 AUTHOR
881		1373
882	Marc Lehmann <schmorp@schmorp.de>	1374	Marc Lehmann <schmorp@schmorp.de>
883	http://home.schmorp.de/	1375	http://home.schmorp.de/
884		1376
885	=cut	1377	=cut
		1378

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.15 by root, Sat Aug 20 02:16:59 2011 UTC vs. Revision 1.46 by root, Sun Oct 2 01:22:01 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.15 by root, Sat Aug 20 02:16:59 2011 UTC vs.
Revision 1.46 by root, Sun Oct 2 01:22:01 2011 UTC