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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.24 by root, Sun Aug 21 03:24:59 2011 UTC vs.
Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.24 by root, Sun Aug 21 03:24:59 2011 UTC vs. Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents):
Revision 1.24 by root, Sun Aug 21 03:24:59 2011 UTC vs.
Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC