… | |
… | |
6 | |
6 | |
7 | Simple uses: |
7 | Simple uses: |
8 | |
8 | |
9 | use AnyEvent; |
9 | use AnyEvent; |
10 | |
10 | |
|
|
11 | AE::log fatal => "No config found, cannot continue!"; # never returns |
|
|
12 | AE::log alert => "The battery died!"; |
|
|
13 | AE::log crit => "The battery temperature is too hot!"; |
|
|
14 | AE::log error => "Division by zero attempted."; |
|
|
15 | AE::log warn => "Couldn't delete the file."; |
|
|
16 | AE::log note => "Wanted to create config, but config already exists."; |
|
|
17 | AE::log info => "File soandso successfully deleted."; |
|
|
18 | AE::log debug => "the function returned 3"; |
11 | AE::log trace => "going to call function abc"; |
19 | AE::log trace => "going to call function abc"; |
12 | AE::log debug => "the function returned 3"; |
|
|
13 | AE::log info => "file soandso successfully deleted"; |
|
|
14 | AE::log note => "wanted to create config, but config was already 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 |
|
|
20 | |
20 | |
21 | Log level overview: |
21 | Log level overview: |
22 | |
22 | |
23 | LVL NAME SYSLOG PERL NOTE |
23 | LVL NAME SYSLOG PERL NOTE |
24 | 1 fatal emerg exit system unusable, aborts program! |
24 | 1 fatal emerg exit system unusable, aborts program! |
… | |
… | |
61 | 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 |
62 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
62 | AnyEvent - AnyEvent simply creates logging messages internally, and this |
63 | 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 |
64 | using it from other modules as well. |
64 | using it from other modules as well. |
65 | |
65 | |
66 | Remember that the default verbosity level is C<3> (C<critical>), so little |
66 | Remember that the default verbosity level is C<4> (C<error>), so only |
67 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
67 | errors and more important messages will be logged, unless you set |
68 | before starting your program, or change the logging level at runtime with |
68 | C<PERL_ANYEVENT_VERBOSE> to a higher number before starting your program |
69 | something like: |
69 | (C<AE_VERBOSE=5> is recommended during development), or change the logging |
|
|
70 | level at runtime with something like: |
70 | |
71 | |
71 | use AnyEvent::Log; |
72 | use AnyEvent::Log; |
72 | $AnyEvent::Log::FILTER->level ("info"); |
73 | $AnyEvent::Log::FILTER->level ("info"); |
73 | |
74 | |
74 | The design goal behind this module was to keep it simple (and small), |
75 | The design goal behind this module was to keep it simple (and small), |
… | |
… | |
114 | levels 7..9 are usually meant for developers. |
115 | levels 7..9 are usually meant for developers. |
115 | |
116 | |
116 | You can normally only log a message once at highest priority level (C<1>, |
117 | You can normally only log a message once at highest priority level (C<1>, |
117 | C<fatal>), because logging a fatal message will also quit the program - so |
118 | C<fatal>), because logging a fatal message will also quit the program - so |
118 | use it sparingly :) |
119 | use it sparingly :) |
|
|
120 | |
|
|
121 | For example, a program that finds an unknown switch on the commandline |
|
|
122 | might well use a fatal logging level to tell users about it - the "system" |
|
|
123 | in this case would be the program, or module. |
119 | |
124 | |
120 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
125 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
121 | or C<all> - these are only valid for the methods that documented them. |
126 | or C<all> - these are only valid for the methods that documented them. |
122 | |
127 | |
123 | =head1 LOGGING FUNCTIONS |
128 | =head1 LOGGING FUNCTIONS |
… | |
… | |
859 | the logging (which consists of formatting the message and printing it or |
864 | the logging (which consists of formatting the message and printing it or |
860 | whatever it wants to do with it). |
865 | whatever it wants to do with it). |
861 | |
866 | |
862 | =over 4 |
867 | =over 4 |
863 | |
868 | |
864 | =item $ctx->log_cb ($cb->($str) |
869 | =item $ctx->log_cb ($cb->($str)) |
865 | |
870 | |
866 | Replaces the logging callback on the context (C<undef> disables the |
871 | Replaces the logging callback on the context (C<undef> disables the |
867 | logging callback). |
872 | logging callback). |
868 | |
873 | |
869 | The logging callback is responsible for handling formatted log messages |
874 | The logging callback is responsible for handling formatted log messages |
… | |
… | |
935 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
940 | Sets the C<log_cb> to simply use C<CORE::warn> to report any messages |
936 | (usually this logs to STDERR). |
941 | (usually this logs to STDERR). |
937 | |
942 | |
938 | =item $ctx->log_to_file ($path) |
943 | =item $ctx->log_to_file ($path) |
939 | |
944 | |
940 | Sets the C<log_cb> to log to a file (by appending), unbuffered. |
945 | Sets the C<log_cb> to log to a file (by appending), unbuffered. The |
|
|
946 | function might return before the log file has been opened or created. |
941 | |
947 | |
942 | =item $ctx->log_to_path ($path) |
948 | =item $ctx->log_to_path ($path) |
943 | |
949 | |
944 | Same as C<< ->log_to_file >>, but opens the file for each message. This |
950 | 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 |
951 | is much slower, but allows you to change/move/rename/delete the file at |
… | |
… | |
980 | warn shift; |
986 | warn shift; |
981 | 0 |
987 | 0 |
982 | }); |
988 | }); |
983 | } |
989 | } |
984 | |
990 | |
|
|
991 | # this function is a good example of why threads are a must, |
|
|
992 | # simply for priority inversion. |
|
|
993 | sub _log_to_disk { |
|
|
994 | # eval'uating this at runtime saves 220kb rss - perl has become |
|
|
995 | # an insane memory waster. |
|
|
996 | eval q{ # poor man's autoloading {} |
|
|
997 | sub _log_to_disk { |
|
|
998 | my ($ctx, $path, $keepopen) = @_; |
|
|
999 | |
|
|
1000 | my $fh; |
|
|
1001 | my @queue; |
|
|
1002 | my $delay; |
|
|
1003 | my $disable; |
|
|
1004 | |
|
|
1005 | use AnyEvent::IO (); |
|
|
1006 | |
|
|
1007 | my $kick = sub { |
|
|
1008 | undef $delay; |
|
|
1009 | return unless @queue; |
|
|
1010 | $delay = 1; |
|
|
1011 | |
|
|
1012 | # we pass $kick to $kick, so $kick itself doesn't keep a reference to $kick. |
|
|
1013 | my $kick = shift; |
|
|
1014 | |
|
|
1015 | # write one or more messages |
|
|
1016 | my $write = sub { |
|
|
1017 | # we write as many messages as have been queued |
|
|
1018 | my $data = join "", @queue; |
|
|
1019 | @queue = (); |
|
|
1020 | |
|
|
1021 | AnyEvent::IO::aio_write $fh, $data, sub { |
|
|
1022 | $disable = 1; |
|
|
1023 | @_ |
|
|
1024 | ? ($_[0] == length $data or AE::log 4 => "unable to write to logfile '$path': short write") |
|
|
1025 | : AE::log 4 => "unable to write to logfile '$path': $!"; |
|
|
1026 | undef $disable; |
|
|
1027 | |
|
|
1028 | if ($keepopen) { |
|
|
1029 | $kick->($kick); |
|
|
1030 | } else { |
|
|
1031 | AnyEvent::IO::aio_close ($fh, sub { |
|
|
1032 | undef $fh; |
|
|
1033 | $kick->($kick); |
|
|
1034 | }); |
|
|
1035 | } |
|
|
1036 | }; |
|
|
1037 | }; |
|
|
1038 | |
|
|
1039 | if ($fh) { |
|
|
1040 | $write->(); |
|
|
1041 | } else { |
|
|
1042 | AnyEvent::IO::aio_open |
|
|
1043 | $path, |
|
|
1044 | AnyEvent::IO::O_CREAT | AnyEvent::IO::O_WRONLY | AnyEvent::IO::O_APPEND, |
|
|
1045 | 0666, |
|
|
1046 | sub { |
|
|
1047 | $fh = shift |
|
|
1048 | or do { |
|
|
1049 | $disable = 1; |
|
|
1050 | AE::log 4 => "unable to open logfile '$path': $!"; |
|
|
1051 | undef $disable; |
|
|
1052 | return; |
|
|
1053 | }; |
|
|
1054 | |
|
|
1055 | $write->(); |
|
|
1056 | } |
|
|
1057 | ; |
|
|
1058 | } |
|
|
1059 | }; |
|
|
1060 | |
|
|
1061 | $ctx->log_cb (sub { |
|
|
1062 | return if $disable; |
|
|
1063 | push @queue, shift; |
|
|
1064 | $kick->($kick) unless $delay; |
|
|
1065 | 0 |
|
|
1066 | }); |
|
|
1067 | |
|
|
1068 | $kick->($kick) if $keepopen; # initial open |
|
|
1069 | }; |
|
|
1070 | }; |
|
|
1071 | die if $@; |
|
|
1072 | &_log_to_disk |
|
|
1073 | } |
|
|
1074 | |
985 | sub log_to_file { |
1075 | sub log_to_file { |
986 | my ($ctx, $path) = @_; |
1076 | my ($ctx, $path) = @_; |
987 | |
1077 | |
988 | open my $fh, ">>", $path |
1078 | _log_to_disk $ctx, $path, 1; |
989 | or die "$path: $!"; |
|
|
990 | |
|
|
991 | $ctx->log_cb (sub { |
|
|
992 | syswrite $fh, shift; |
|
|
993 | 0 |
|
|
994 | }); |
|
|
995 | } |
1079 | } |
996 | |
1080 | |
997 | sub log_to_path { |
1081 | sub log_to_path { |
998 | my ($ctx, $path) = @_; |
1082 | my ($ctx, $path) = @_; |
999 | |
1083 | |
1000 | $ctx->log_cb (sub { |
1084 | _log_to_disk $ctx, $path, 0; |
1001 | open my $fh, ">>", $path |
|
|
1002 | or die "$path: $!"; |
|
|
1003 | |
|
|
1004 | syswrite $fh, shift; |
|
|
1005 | 0 |
|
|
1006 | }); |
|
|
1007 | } |
1085 | } |
1008 | |
1086 | |
1009 | sub log_to_syslog { |
1087 | sub log_to_syslog { |
1010 | my ($ctx, $facility) = @_; |
1088 | my ($ctx, $facility) = @_; |
1011 | |
1089 | |
… | |
… | |
1040 | =over 4 |
1118 | =over 4 |
1041 | |
1119 | |
1042 | =item $ctx->log ($level, $msg[, @params]) |
1120 | =item $ctx->log ($level, $msg[, @params]) |
1043 | |
1121 | |
1044 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
1122 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
|
|
1123 | |
|
|
1124 | Example: log a message in the context of another package. |
|
|
1125 | |
|
|
1126 | (AnyEvent::Log::ctx "Other::Package")->log (warn => "heely bo"); |
1045 | |
1127 | |
1046 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1128 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1047 | |
1129 | |
1048 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1130 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1049 | context. |
1131 | context. |
… | |
… | |
1283 | if (/\G(.+)/g) { |
1365 | if (/\G(.+)/g) { |
1284 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1366 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1285 | } |
1367 | } |
1286 | } |
1368 | } |
1287 | |
1369 | |
1288 | 1; |
|
|
1289 | |
|
|
1290 | =head1 EXAMPLES |
1370 | =head1 EXAMPLES |
1291 | |
1371 | |
1292 | This section shows some common configurations, both as code, and as |
1372 | This section shows some common configurations, both as code, and as |
1293 | C<PERL_ANYEVENT_LOG> string. |
1373 | C<PERL_ANYEVENT_LOG> string. |
1294 | |
1374 | |
… | |
… | |
1370 | =back |
1450 | =back |
1371 | |
1451 | |
1372 | =head1 AUTHOR |
1452 | =head1 AUTHOR |
1373 | |
1453 | |
1374 | Marc Lehmann <schmorp@schmorp.de> |
1454 | Marc Lehmann <schmorp@schmorp.de> |
1375 | http://home.schmorp.de/ |
1455 | http://anyevent.schmorp.de |
1376 | |
1456 | |
1377 | =cut |
1457 | =cut |
1378 | |
1458 | |
|
|
1459 | 1 |
|
|
1460 | |