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

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

…		…
49	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
50	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
51	something like:	51	something like:
52		52
53	use AnyEvent::Log;	53	use AnyEvent::Log;
54	AnyEvent::Log::FILTER->level ("info");	54	$AnyEvent::Log::FILTER->level ("info");
55		55
56	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),
57	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
58	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
59	targets, or being able to log into a database.	59	targets, or being able to log into a database.
60		60
		61	The module is also usable before AnyEvent itself is initialised, in which
		62	case some of the functionality might be reduced.
		63
61	The amount of documentation might indicate otherwise, but the module is	64	The amount of documentation might indicate otherwise, but the runtime part
62	still just below 300 lines of code.	65	of the module is still just below 300 lines of code.
63		66
64	=head1 LOGGING LEVELS	67	=head1 LOGGING LEVELS
65		68
66	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>
67	(lowest priority). Note that the lowest numerical value is the highest	70	(lowest priority). Note that the lowest numerical value is the highest
…		…
249	# now get raw message, unless we have it already	252	# now get raw message, unless we have it already
250	unless ($now) {	253	unless ($now) {
251	$format = $format->() if ref $format;	254	$format = $format->() if ref $format;
252	$format = sprintf $format, @args if @args;	255	$format = sprintf $format, @args if @args;
253	$format =~ s/\n$//;	256	$format =~ s/\n$//;
254	$now = AE::now;	257	$now = now;
255	};	258	};
256		259
257	# format msg	260	# format msg
258	my $str = $ctx->[4]	261	my $str = $ctx->[4]
259	? $ctx->[4]($now, $_[0], $level, $format)	262	? $ctx->[4]($now, $_[0], $level, $format)
…		…
513	}	516	}
514		517
515	@$_ = ($_->[0], (1 << 10) - 1 - 1)	518	@$_ = ($_->[0], (1 << 10) - 1 - 1)
516	for $LOG, $FILTER, $COLLECT;	519	for $LOG, $FILTER, $COLLECT;
517		520
518	$LOG->slaves;	521	#$LOG->slaves;
519	$LOG->title ('$AnyEvent::Log::LOG');	522	$LOG->title ('$AnyEvent::Log::LOG');
520	$LOG->log_cb (sub {	523	$LOG->log_to_warn;
521	warn shift;
522	0
523	});
524		524
525	$FILTER->slaves ($LOG);	525	$FILTER->slaves ($LOG);
526	$FILTER->title ('$AnyEvent::Log::FILTER');	526	$FILTER->title ('$AnyEvent::Log::FILTER');
527	$FILTER->level ($AnyEvent::VERBOSE);	527	$FILTER->level ($AnyEvent::VERBOSE);
528		528
…		…
818	"$msg->[3]";	818	"$msg->[3]";
819		819
820	0	820	0
821	});	821	});
822		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
823	=item $ctx->log_to_file ($path)	828	=item $ctx->log_to_file ($path)
824		829
825	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.
826		831
827	=item $ctx->log_to_path ($path)	832	=item $ctx->log_to_path ($path)
828		833
829	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
830	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
831	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...
832		841
833	=item $ctx->log_to_syslog ([$log_flags])	842	=item $ctx->log_to_syslog ([$log_flags])
834		843
835	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
836	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
…		…
852	my ($ctx, $cb) = @_;	861	my ($ctx, $cb) = @_;
853		862
854	$ctx->[4] = $cb;	863	$ctx->[4] = $cb;
855	}	864	}
856		865
		866	sub log_to_warn {
		867	my ($ctx, $path) = @_;
		868
		869	$ctx->log_cb (sub {
		870	warn shift;
		871	0
		872	});
		873	}
		874
857	sub log_to_file {	875	sub log_to_file {
858	my ($ctx, $path) = @_;	876	my ($ctx, $path) = @_;
859		877
860	open my $fh, ">>", $path	878	open my $fh, ">>", $path
861	or die "$path: $!";	879	or die "$path: $!";
…		…
864	syswrite $fh, shift;	882	syswrite $fh, shift;
865	0	883	0
866	});	884	});
867	}	885	}
868		886
869	sub log_to_file {	887	sub log_to_path {
870	my ($ctx, $path) = @_;	888	my ($ctx, $path) = @_;
871		889
872	$ctx->log_cb (sub {	890	$ctx->log_cb (sub {
873	open my $fh, ">>", $path	891	open my $fh, ">>", $path
874	or die "$path: $!";	892	or die "$path: $!";
…		…
921	=cut	939	=cut
922		940
923	*log = \&AnyEvent::Log::_log;	941	*log = \&AnyEvent::Log::_log;
924	*logger = \&AnyEvent::Log::_logger;	942	*logger = \&AnyEvent::Log::_logger;
925		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
926	1;	1169	1;
927		1170
928	=back
929
930	=head1 EXAMPLES	1171	=head1 EXAMPLES
931		1172
932	This section shows some common configurations.	1173	This section shows some common configurations, both as code, and as
		1174	C<PERL_ANYEVENT_LOG> string.
933		1175
934	=over 4	1176	=over 4
935		1177
936	=item Setting the global logging level.	1178	=item Setting the global logging level.
937		1179
938	Either put PERL_ANYEVENT_VERBOSE=<number> into your environment before	1180	Either put C<PERL_ANYEVENT_VERBOSE=><number> into your environment before
939	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:
940		1183
941	PERL_ANYEVENT_VERBOSE=5 ./myprog	1184	PERL_ANYEVENT_VERBOSE=5 ./myprog
942		1185
		1186	PERL_ANYEVENT_LOG=log=warn
		1187
943	$AnyEvent::Log::FILTER->level ("warn");	1188	$AnyEvent::Log::FILTER->level ("warn");
944		1189
945	=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.
946		1191
947	This is affected by the global logging level.	1192	This is affected by the global logging level.
948		1193
949	$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
950		1197
951	=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.
952		1199
953	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
954	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
955	filtering.	1202	filtering.
956		1203
957	$AnyEvent::Log::FILTER->attach	1204	$AnyEvent::Log::FILTER->attach
958	new AnyEvent::Log::Ctx log_to_file => $path);	1205	new AnyEvent::Log::Ctx log_to_file => $path);
959		1206
		1207	PERL_ANYEVENT_LOG=filter=+%filelogger:%filelogger=file=/some/path
		1208
960	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
961	attached to the toplevel context, which receives all messages I<before>	1210	attached to the toplevel context, which receives all messages I<before>
962	the global filtering.	1211	the global filtering.
963		1212
964	$AnyEvent::Log::COLLECT->attach (	1213	$AnyEvent::Log::COLLECT->attach (
965	new AnyEvent::Log::Ctx log_to_file => $path);	1214	new AnyEvent::Log::Ctx log_to_file => $path);
966		1215
		1216	PERL_ANYEVENT_LOG=%filelogger=file=/some/path:collect=+%filelogger
		1217
967	In both cases, messages are still written to STDERR.	1218	In both cases, messages are still written to STDERR.
968		1219
969	=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).
970		1221
971	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>
972	context - this simply circumvents the global filtering for trace messages.	1223	context - this simply circumvents the global filtering for trace messages.
973		1224
974	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;	1225	my $debug = AnyEvent::Debug->AnyEvent::Log::ctx;
975	$debug->attach ($AnyEvent::Log::LOG);	1226	$debug->attach ($AnyEvent::Log::LOG);
		1227
		1228	PERL_ANYEVENT_LOG=AnyEvent::Debug=+log
976		1229
977	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
978	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
979	default.	1232	default.
980		1233
…		…
984		1237
985	Marc Lehmann <schmorp@schmorp.de>	1238	Marc Lehmann <schmorp@schmorp.de>
986	http://home.schmorp.de/	1239	http://home.schmorp.de/
987		1240
988	=cut	1241	=cut
		1242

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Log.pm (file contents): Revision 1.26 by root, Sun Aug 21 03:29:19 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.26 by root, Sun Aug 21 03:29:19 2011 UTC vs.
Revision 1.36 by root, Thu Aug 25 05:39:47 2011 UTC