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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.22 by root, Sun Aug 21 02:19:30 2011 UTC vs.
Revision 1.35 by root, Thu Aug 25 04:59:08 2011 UTC

…		…
2		2
3	AnyEvent::Log - simple logging "framework"	3	AnyEvent::Log - simple logging "framework"
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	# simple use	7	Simple uses:
		8
8	use AnyEvent;	9	use AnyEvent;
9		10
10	AE::log debug => "hit my knee";	11	AE::log debug => "hit my knee";
11	AE::log warn => "it's a bit too hot";	12	AE::log warn => "it's a bit too hot";
12	AE::log error => "the flag was false!";	13	AE::log error => "the flag was false!";
13	AE::log fatal => "the bit toggled! run!";	14	AE::log fatal => "the bit toggled! run!"; # never returns
14		15
15	# "complex" use	16	"Complex" uses (for speed sensitive code):
		17
16	use AnyEvent::Log;	18	use AnyEvent::Log;
17		19
18	my $tracer = AnyEvent::Log::logger trace => \$my $trace;	20	my $tracer = AnyEvent::Log::logger trace => \$my $trace;
19		21
20	$tracer->("i am here") if $trace;	22	$tracer->("i am here") if $trace;
21	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;	23	$tracer->(sub { "lots of data: " . Dumper $self }) if $trace;
22		24
23	# configuration	25	Configuration (also look at the EXAMPLES section):
24		26
25	# set logging for the current package to errors and higher only	27	# set logging for the current package to errors and higher only
26	AnyEvent::Log::ctx->level ("error");	28	AnyEvent::Log::ctx->level ("error");
27		29
28	# set logging globally to anything below debug	30	# set logging level to suppress anything below "notice"
29	$AnyEvent::Log::FILTER->level ("notice");	31	$AnyEvent::Log::FILTER->level ("notice");
30		32
31	# see also EXAMPLES, below	33	# send all critical and higher priority messages to syslog,
		34	# regardless of (most) other settings
		35	$AnyEvent::Log::COLLECT->attach (new AnyEvent::Log::Ctx
		36	level => "critical",
		37	log_to_syslog => 0,
		38	);
32		39
33	=head1 DESCRIPTION	40	=head1 DESCRIPTION
34		41
35	This module implements a relatively simple "logging framework". It doesn't	42	This module implements a relatively simple "logging framework". It doesn't
36	attempt to be "the" logging solution or even "a" logging solution for	43	attempt to be "the" logging solution or even "a" logging solution for
…		…
42	will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number	49	will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number
43	before starting your program, or change the logging level at runtime with	50	before starting your program, or change the logging level at runtime with
44	something like:	51	something like:
45		52
46	use AnyEvent::Log;	53	use AnyEvent::Log;
47	AnyEvent::Log::FILTER->level ("info");	54	$AnyEvent::Log::FILTER->level ("info");
48		55
49	The design goal behind this module was to keep it simple (and small),	56	The design goal behind this module was to keep it simple (and small),
50	but make it powerful enough to be potentially useful for any module, and	57	but make it powerful enough to be potentially useful for any module, and
51	extensive enough for the most common tasks, such as logging to multiple	58	extensive enough for the most common tasks, such as logging to multiple
52	targets, or being able to log into a database.	59	targets, or being able to log into a database.
53		60
54	The amount of documentation might indicate otherwise, but the module is	61	The amount of documentation might indicate otherwise, but the runtime part
55	still just below 300 lines of code.	62	of the module is still just below 300 lines of code.
56		63
57	=head1 LOGGING LEVELS	64	=head1 LOGGING LEVELS
58		65
59	Logging levels in this module range from C<1> (highest priority) to C<9>	66	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	67	(lowest priority). Note that the lowest numerical value is the highest
…		…
242	# now get raw message, unless we have it already	249	# now get raw message, unless we have it already
243	unless ($now) {	250	unless ($now) {
244	$format = $format->() if ref $format;	251	$format = $format->() if ref $format;
245	$format = sprintf $format, @args if @args;	252	$format = sprintf $format, @args if @args;
246	$format =~ s/\n$//;	253	$format =~ s/\n$//;
247	$now = AE::now;	254	$now = now;
248	};	255	};
249		256
250	# format msg	257	# format msg
251	my $str = $ctx->[4]	258	my $str = $ctx->[4]
252	? $ctx->[4]($now, $_[0], $level, $format)	259	? $ctx->[4]($now, $_[0], $level, $format)
…		…
506	}	513	}
507		514
508	@$_ = ($_->[0], (1 << 10) - 1 - 1)	515	@$_ = ($_->[0], (1 << 10) - 1 - 1)
509	for $LOG, $FILTER, $COLLECT;	516	for $LOG, $FILTER, $COLLECT;
510		517
511	$LOG->slaves;	518	#$LOG->slaves;
512	$LOG->title ('$AnyEvent::Log::LOG');	519	$LOG->title ('$AnyEvent::Log::LOG');
513	$LOG->log_cb (sub {	520	$LOG->log_to_warn;
514	warn shift;
515	0
516	});
517		521
518	$FILTER->slaves ($LOG);	522	$FILTER->slaves ($LOG);
519	$FILTER->title ('$AnyEvent::Log::FILTER');	523	$FILTER->title ('$AnyEvent::Log::FILTER');
520	$FILTER->level ($AnyEvent::VERBOSE);	524	$FILTER->level ($AnyEvent::VERBOSE);
521		525
…		…
782	logging context, the (numeric) logging level and the raw message string	786	logging context, the (numeric) logging level and the raw message string
783	and needs to return a formatted log message. In most cases this will be a	787	and needs to return a formatted log message. In most cases this will be a
784	string, but it could just as well be an array reference that just stores	788	string, but it could just as well be an array reference that just stores
785	the values.	789	the values.
786		790
787	If, for some reaosn, you want to use C<caller> to find out more baout the	791	If, for some reason, you want to use C<caller> to find out more baout the
788	logger then you should walk up the call stack until you are no longer	792	logger then you should walk up the call stack until you are no longer
789	inside the C<AnyEvent::Log> package.	793	inside the C<AnyEvent::Log> package.
790		794
791	Example: format just the raw message, with numeric log level in angle	795	Example: format just the raw message, with numeric log level in angle
792	brackets.	796	brackets.
…		…
811	"$msg->[3]";	815	"$msg->[3]";
812		816
813	0	817	0
814	});	818	});
815		819
		820	=item $ctx->log_to_warn
		821
		822	Sets the C<log_cb> to simply use C<CORE::warn> to report any messages
		823	(usually this logs to STDERR).
		824
816	=item $ctx->log_to_file ($path)	825	=item $ctx->log_to_file ($path)
817		826
818	Sets the C<log_cb> to log to a file (by appending), unbuffered.	827	Sets the C<log_cb> to log to a file (by appending), unbuffered.
819		828
820	=item $ctx->log_to_path ($path)	829	=item $ctx->log_to_path ($path)
821		830
822	Same as C<< ->log_to_file >>, but opens the file for each message. This	831	Same as C<< ->log_to_file >>, but opens the file for each message. This
823	is much slower, but allows you to change/move/rename/delete the file at	832	is much slower, but allows you to change/move/rename/delete the file at
824	basically any time.	833	basically any time.
		834
		835	Needless(?) to say, if you do not want to be bitten by some evil person
		836	calling C<chdir>, the path should be absolute. Doesn't help with
		837	C<chroot>, but hey...
825		838
826	=item $ctx->log_to_syslog ([$log_flags])	839	=item $ctx->log_to_syslog ([$log_flags])
827		840
828	Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all	841	Logs all messages via L<Sys::Syslog>, mapping C<trace> to C<debug> and all
829	the others in the obvious way. If specified, then the C<$log_flags> are	842	the others in the obvious way. If specified, then the C<$log_flags> are
…		…
845	my ($ctx, $cb) = @_;	858	my ($ctx, $cb) = @_;
846		859
847	$ctx->[4] = $cb;	860	$ctx->[4] = $cb;
848	}	861	}
849		862
		863	sub log_to_warn {
		864	my ($ctx, $path) = @_;
		865
		866	$ctx->log_cb (sub {
		867	warn shift;
		868	0
		869	});
		870	}
		871
850	sub log_to_file {	872	sub log_to_file {
851	my ($ctx, $path) = @_;	873	my ($ctx, $path) = @_;
852		874
853	open my $fh, ">>", $path	875	open my $fh, ">>", $path
854	or die "$path: $!";	876	or die "$path: $!";
…		…
857	syswrite $fh, shift;	879	syswrite $fh, shift;
858	0	880	0
859	});	881	});
860	}	882	}
861		883
862	sub log_to_file {	884	sub log_to_path {
863	my ($ctx, $path) = @_;	885	my ($ctx, $path) = @_;
864		886
865	$ctx->log_cb (sub {	887	$ctx->log_cb (sub {
866	open my $fh, ">>", $path	888	open my $fh, ">>", $path
867	or die "$path: $!";	889	or die "$path: $!";
…		…
914	=cut	936	=cut
915		937
916	*log = \&AnyEvent::Log::_log;	938	*log = \&AnyEvent::Log::_log;
917	*logger = \&AnyEvent::Log::_logger;	939	*logger = \&AnyEvent::Log::_logger;
918		940
		941	=back
		942
		943	=cut
		944
		945	package AnyEvent::Log;
		946
		947	=head1 CONFIGURATION VIA $ENV{PERL_ANYEVENT_LOG}
		948
		949	Logging can also be configured by setting the environment variable
		950	C<PERL_ANYEVENT_LOG> (or C<AE_LOG>).
		951
		952	The value consists of one or more logging context specifications separated
		953	by C<:> or whitespace. Each logging specification in turn starts with a
		954	context name, followed by C<=>, followed by zero or more comma-separated
		955	configuration directives, here are some examples:
		956
		957	# set default logging level
		958	filter=warn
		959
		960	# log to file instead of to stderr
		961	log=file=/tmp/mylog
		962
		963	# log to file in addition to stderr
		964	log=+%file:%file=file=/tmp/mylog
		965
		966	# enable debug log messages, log warnings and above to syslog
		967	filter=debug:log=+%warnings:%warnings=warn,syslog=LOG_LOCAL0
		968
		969	# log trace messages (only) from AnyEvent::Debug to file
		970	AnyEvent::Debug=+%trace:%trace=only,trace,file=/tmp/tracelog
		971
		972	A context name in the log specification can be any of the following:
		973
		974	=over 4
		975
		976	=item C<collect>, C<filter>, C<log>
		977
		978	Correspond to the three predefined C<$AnyEvent::Log::COLLECT>,
		979	C<AnyEvent::Log::FILTER> and C<$AnyEvent::Log::LOG> contexts.
		980
		981	=item C<%name>
		982
		983	Context names starting with a C<%> are anonymous contexts created when the
		984	name is first mentioned. The difference to package contexts is that by
		985	default they have no attached slaves.
		986
		987	=item a perl package name
		988
		989	Any other string references the logging context associated with the given
		990	Perl C<package>. In the unlikely case where you want to specify a package
		991	context that matches on of the other context name forms, you can add a
		992	C<::> to the package name to force interpretation as a package.
		993
		994	=back
		995
		996	The configuration specifications can be any number of the following:
		997
		998	=over 4
		999
		1000	=item C<stderr>
		1001
		1002	Configures the context to use Perl's C<warn> function (which typically
		1003	logs to C<STDERR>). Works like C<log_to_warn>.
		1004
		1005	=item C<file=>I<path>
		1006
		1007	Configures the context to log to a file with the given path. Works like
		1008	C<log_to_file>.
		1009
		1010	=item C<path=>I<path>
		1011
		1012	Configures the context to log to a file with the given path. Works like
		1013	C<log_to_path>.
		1014
		1015	=item C<syslog> or C<syslog=>I<expr>
		1016
		1017	Configures the context to log to syslog. If I<expr> is given, then it is
		1018	evaluated in the L<Sys::Syslog> package, so you could use:
		1019
		1020	log=syslog=LOG_LOCAL0
		1021
		1022	=item C<nolog>
		1023
		1024	Configures the context to not log anything by itself, which is the
		1025	default. Same as C<< $ctx->log_cb (undef) >>.
		1026
		1027	=item C<0> or C<off>
		1028
		1029	Sets the logging level of the context ot C<0>, i.e. all messages will be
		1030	filtered out.
		1031
		1032	=item C<all>
		1033
		1034	Enables all logging levels, i.e. filtering will effectively be switched
		1035	off (the default).
		1036
		1037	=item C<only>
		1038
		1039	Disables all logging levels, and changes the interpretation of following
		1040	level specifications to enable the specified level only.
		1041
		1042	Example: only enable debug messages for a context.
		1043
		1044	context=only,debug
		1045
		1046	=item C<except>
		1047
		1048	Enables all logging levels, and changes the interpretation of following
		1049	level specifications to disable that level. Rarely used.
		1050
		1051	Example: enable all logging levels except fatal and trace (this is rather
		1052	nonsensical).
		1053
		1054	filter=exept,fatal,trace
		1055
		1056	=item C<level>
		1057
		1058	Enables all logging levels, and changes the interpretation of following
		1059	level specifications to be "that level or any higher priority
		1060	message". This is the default.
		1061
		1062	Example: log anything at or above warn level.
		1063
		1064	filter=warn
		1065
		1066	# or, more verbose
		1067	filter=only,level,warn
		1068
		1069	=item C<1>..C<9> or a logging level name (C<error>, C<debug> etc.)
		1070
		1071	A numeric loglevel or the name of a loglevel will be interpreted according
		1072	to the most recent C<only>, C<except> or C<level> directive. By default,
		1073	specifying a logging level enables that and any higher priority messages.
		1074
		1075	=item C<+>I<context>
		1076
		1077	Attaches the named context as slave to the context.
		1078
		1079	=item C<+>
		1080
		1081	A line C<+> detaches all contexts, i.e. clears the slave list from the
		1082	context. Anonymous (C<%name>) contexts have no attached slaves by default,
		1083	but package contexts have the parent context as slave by default.
		1084
		1085	Example: log messages from My::Module to a file, do not send them to the
		1086	default log collector.
		1087
		1088	My::Module=+,file=/tmp/mymodulelog
		1089
		1090	=back
		1091
		1092	Any character can be escaped by prefixing it with a C<\> (backslash), as
		1093	usual, so to log to a file containing a comma, colon, backslash and some
		1094	spaces in the filename, you would do this:
		1095
		1096	PERL_ANYEVENT_LOG='log=file=/some\ \:file\ with\,\ \\-escapes'
		1097
		1098	Since whitespace (which includes newlines) is allowed, it is fine to
		1099	specify multiple lines in C<PERL_ANYEVENT_LOG>, e.g.:
		1100
		1101	PERL_ANYEVENT_LOG="
		1102	filter=warn
		1103	AnyEvent::Debug=+%trace
		1104	%trace=only,trace,+log
		1105	" myprog
		1106
		1107	Also, in the unlikely case when you want to concatenate specifications,
		1108	use whitespace as separator, as C<::> will be interpreted as part of a
		1109	module name, an empty spec with two separators:
		1110
		1111	PERL_ANYEVENT_LOG="$PERL_ANYEVENT_LOG MyMod=debug"
		1112
		1113	=cut
		1114
		1115	for (my $spec = $ENV{PERL_ANYEVENT_LOG}) {
		1116	my %anon;
		1117
		1118	my $pkg = sub {
		1119	$_[0] eq "log" ? $LOG
		1120	: $_[0] eq "filter" ? $FILTER
		1121	: $_[0] eq "collect" ? $COLLECT
		1122	: $_[0] =~ /^%(.+)$/ ? ($anon{$1} \|\|= ctx undef)
		1123	: $_[0] =~ /^(.*?)(?:::)?$/ ? ctx "$1" # egad :/
		1124	: die # never reached?
		1125	};
		1126
		1127	/\G[[:space:]]+/gc; # skip initial whitespace
		1128
		1129	while (/\G((?:[^:=[:space:]]+\|::\|\\.)+)=/gc) {
		1130	my $ctx = $pkg->($1);
		1131	my $level = "level";
		1132
		1133	while (/\G((?:[^,:[:space:]]+\|::\|\\.)+)/gc) {
		1134	for ("$1") {
		1135	if ($_ eq "stderr" ) { $ctx->log_to_warn;
		1136	} elsif (/^file=(.+)/ ) { $ctx->log_to_file ("$1");
		1137	} elsif (/^path=(.+)/ ) { $ctx->log_to_path ("$1");
		1138	} elsif (/syslog(?:=(.*))?/ ) { require Sys::Syslog; $ctx->log_to_syslog (eval "package Sys::Syslog; $1");
		1139	} elsif ($_ eq "nolog" ) { $ctx->log_cb (undef);
		1140	} elsif (/^\+(.+)$/ ) { $ctx->attach ($pkg->("$1"));
		1141	} elsif ($_ eq "+" ) { $ctx->slaves;
		1142	} elsif ($_ eq "off" or $_ eq "0") { $ctx->level (0);
		1143	} elsif ($_ eq "all" ) { $ctx->level ("all");
		1144	} elsif ($_ eq "level" ) { $ctx->level ("all"); $level = "level";
		1145	} elsif ($_ eq "only" ) { $ctx->level ("off"); $level = "enable";
		1146	} elsif ($_ eq "except" ) { $ctx->level ("all"); $level = "disable";
		1147	} elsif (/^\d$/ ) { $ctx->$level ($_);
		1148	} elsif (exists $STR2LEVEL{$_} ) { $ctx->$level ($_);
		1149	} else { die "PERL_ANYEVENT_LOG ($spec): parse error at '$_'\n";
		1150	}
		1151	}
		1152
		1153	/\G,/gc or last;
		1154	}
		1155
		1156	/\G[:[:space:]]+/gc or last;
		1157	}
		1158
		1159	/\G[[:space:]]+/gc; # skip trailing whitespace
		1160
		1161	if (/\G(.+)/g) {
		1162	die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n";
		1163	}
		1164	}
		1165
919	1;	1166	1;
920		1167
921	=back
922
923	=head1 EXAMPLES	1168	=head1 EXAMPLES
924		1169
925	This section shows some common configurations.	1170	This section shows some common configurations, both as code, and as
		1171	C<PERL_ANYEVENT_LOG> string.
926		1172
927	=over 4	1173	=over 4
928		1174
929	=item Setting the global logging level.	1175	=item Setting the global logging level.
930		1176
931	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before	1177	Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before
932	running your program, or modify the log level of the root context:	1178	running your program, use C<PERL_ANYEVENT_LOG> or modify the log level of
		1179	the root context at runtime:
933		1180
934	PERL_ANYEVENT_VERBOSE=5 ./myprog	1181	PERL_ANYEVENT_VERBOSE=5 ./myprog
935		1182
		1183	PERL_ANYEVENT_LOG=log=warn
		1184
936	$AnyEvent::Log::FILTER->level ("warn");	1185	$AnyEvent::Log::FILTER->level ("warn");
937		1186
938	=item Append all messages to a file instead of sending them to STDERR.	1187	=item Append all messages to a file instead of sending them to STDERR.
939		1188
940	This is affected by the global logging level.	1189	This is affected by the global logging level.
941		1190
942	$AnyEvent::Log::LOG->log_to_file ($path); (sub {	1191	$AnyEvent::Log::LOG->log_to_file ($path);
		1192
		1193	PERL_ANYEVENT_LOG=log=file=/some/path
943		1194
944	=item Write all messages with priority C<error> and higher to a file.	1195	=item Write all messages with priority C<error> and higher to a file.
945		1196
946	This writes them only when the global logging level allows it, because	1197	This writes them only when the global logging level allows it, because
947	it is attached to the default context which is invoked I<after> global	1198	it is attached to the default context which is invoked I<after> global
948	filtering.	1199	filtering.
949		1200
950	$AnyEvent::Log::FILTER->attach	1201	$AnyEvent::Log::FILTER->attach
951	new AnyEvent::Log::Ctx log_to_file => $path);	1202	new AnyEvent::Log::Ctx log_to_file => $path);
952		1203
		1204	PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path
		1205
953	This writes them regardless of the global logging level, because it is	1206	This writes them regardless of the global logging level, because it is
954	attached to the toplevel context, which receives all messages I<before>	1207	attached to the toplevel context, which receives all messages I<before>
955	the global filtering.	1208	the global filtering.
956		1209
957	$AnyEvent::Log::COLLECT->attach (	1210	$AnyEvent::Log::COLLECT->attach (
958	new AnyEvent::Log::Ctx log_to_file => $path);	1211	new AnyEvent::Log::Ctx log_to_file => $path);
959		1212
		1213	PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger
		1214
960	In both cases, messages are still written to STDERR.	1215	In both cases, messages are still written to STDERR.
961		1216
962	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).	1217	=item Write trace messages (only) from L<AnyEvent::Debug> to the default logging target(s).
963		1218
964	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>	1219	Attach the C<$AnyEvent::Log::LOG> context to the C<AnyEvent::Debug>
965	context - this simply circumvents the global filtering for trace messages.	1220	context - this simply circumvents the global filtering for trace messages.
966		1221
967	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;	1222	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
968	$debug->attach ($AnyEvent::Log::LOG);	1223	$debug->attach ($AnyEvent::Log::LOG);
		1224
		1225	PERL_ANYEVENT_LOG=AnyEvent::Debug=+log
969		1226
970	This of course works for any package, not just L<AnyEvent::Debug>, but	1227	This of course works for any package, not just L<AnyEvent::Debug>, but
971	assumes the log level for AnyEvent::Debug hasn't been changed from the	1228	assumes the log level for AnyEvent::Debug hasn't been changed from the
972	default.	1229	default.
973		1230
…		…
977		1234
978	Marc Lehmann <schmorp@schmorp.de>	1235	Marc Lehmann <schmorp@schmorp.de>
979	http://home.schmorp.de/	1236	http://home.schmorp.de/
980		1237
981	=cut	1238	=cut
		1239

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.22 by root, Sun Aug 21 02:19:30 2011 UTC vs. Revision 1.35 by root, Thu Aug 25 04:59:08 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.22 by root, Sun Aug 21 02:19:30 2011 UTC vs.
Revision 1.35 by root, Thu Aug 25 04:59:08 2011 UTC