… | |
… | |
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 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 |
|
|
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<0> (C<off>), so nothing |
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), |
… | |
… | |
106 | is the "official" name, the second one the "syslog" name (if it differs) |
107 | 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 | 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 | messages at C<error> priority. The NOTE column tries to provide some |
109 | rationale on how to chose a logging level. |
110 | rationale on how to chose a logging level. |
110 | |
111 | |
111 | As a rough guideline, levels 1..3 are primarily meant for users of |
112 | As a rough guideline, levels 1..3 are primarily meant for users of the |
112 | the program (admins, staff), and are the only logged to STDERR by |
113 | program (admins, staff), and are the only ones logged to STDERR by |
113 | default. Levels 4..6 are meant for users and developers alike, while |
114 | default. Levels 4..6 are meant for users and developers alike, while |
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 single message at highest priority level |
117 | You can normally only log a message once at highest priority level (C<1>, |
117 | (C<1>, C<fatal>), because logging a fatal message will also quit the |
118 | C<fatal>), because logging a fatal message will also quit the program - so |
118 | program - so 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 in the methods they are documented for. |
126 | or C<all> - these are only valid for the methods that documented them. |
122 | |
127 | |
123 | =head1 LOGGING FUNCTIONS |
128 | =head1 LOGGING FUNCTIONS |
124 | |
129 | |
125 | These functions allow you to log messages. They always use the caller's |
130 | The following functions allow you to log messages. They always use the |
126 | package as a "logging context". Also, the main logging function C<log> is |
131 | caller's package as a "logging context". Also, the main logging function, |
127 | callable as C<AnyEvent::log> or C<AE::log> when the C<AnyEvent> module is |
132 | C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent> |
128 | loaded. |
133 | module is loaded. |
129 | |
134 | |
130 | =over 4 |
135 | =over 4 |
131 | |
136 | |
132 | =cut |
137 | =cut |
133 | |
138 | |
… | |
… | |
191 | |
196 | |
192 | Last not least, C<$msg> might be a code reference, in which case it is |
197 | Last not least, C<$msg> might be a code reference, in which case it is |
193 | supposed to return the message. It will be called only then the message |
198 | supposed to return the message. It will be called only then the message |
194 | actually gets logged, which is useful if it is costly to create the |
199 | actually gets logged, which is useful if it is costly to create the |
195 | message in the first place. |
200 | message in the first place. |
|
|
201 | |
|
|
202 | This function takes care of saving and restoring C<$!> and C<$@>, so you |
|
|
203 | don't have to. |
196 | |
204 | |
197 | Whether the given message will be logged depends on the maximum log level |
205 | Whether the given message will be logged depends on the maximum log level |
198 | and the caller's package. The return value can be used to ensure that |
206 | and the caller's package. The return value can be used to ensure that |
199 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
207 | messages or not "lost" - for example, when L<AnyEvent::Debug> detects a |
200 | runtime error it tries to log it at C<die> level, but if that message is |
208 | runtime error it tries to log it at C<die> level, but if that message is |
… | |
… | |
301 | |
309 | |
302 | # log if log cb |
310 | # log if log cb |
303 | if ($ctx->[3]) { |
311 | if ($ctx->[3]) { |
304 | # logging target found |
312 | # logging target found |
305 | |
313 | |
|
|
314 | local ($!, $@); |
|
|
315 | |
306 | # now get raw message, unless we have it already |
316 | # now get raw message, unless we have it already |
307 | unless ($now) { |
317 | unless ($now) { |
308 | $format = $format->() if ref $format; |
318 | $format = $format->() if ref $format; |
309 | $format = sprintf $format, @args if @args; |
319 | $format = sprintf $format, @args if @args; |
310 | $format =~ s/\n$//; |
320 | $format =~ s/\n$//; |
… | |
… | |
889 | |
899 | |
890 | Replaces the formatting callback on the context (C<undef> restores the |
900 | Replaces the formatting callback on the context (C<undef> restores the |
891 | default formatter). |
901 | default formatter). |
892 | |
902 | |
893 | The callback is passed the (possibly fractional) timestamp, the original |
903 | The callback is passed the (possibly fractional) timestamp, the original |
894 | logging context, the (numeric) logging level and the raw message string |
904 | logging context (object, not title), the (numeric) logging level and |
895 | and needs to return a formatted log message. In most cases this will be a |
905 | the raw message string and needs to return a formatted log message. In |
896 | string, but it could just as well be an array reference that just stores |
906 | most cases this will be a string, but it could just as well be an array |
897 | the values. |
907 | reference that just stores the values. |
898 | |
908 | |
899 | If, for some reason, you want to use C<caller> to find out more baout the |
909 | If, for some reason, you want to use C<caller> to find out more about the |
900 | logger then you should walk up the call stack until you are no longer |
910 | logger then you should walk up the call stack until you are no longer |
901 | inside the C<AnyEvent::Log> package. |
911 | inside the C<AnyEvent::Log> package. |
902 | |
912 | |
903 | Example: format just the raw message, with numeric log level in angle |
913 | Example: format just the raw message, with numeric log level in angle |
904 | brackets. |
914 | brackets. |
… | |
… | |
908 | |
918 | |
909 | "<$lvl>$msg\n" |
919 | "<$lvl>$msg\n" |
910 | }); |
920 | }); |
911 | |
921 | |
912 | Example: return an array reference with just the log values, and use |
922 | Example: return an array reference with just the log values, and use |
913 | C<PApp::SQL::sql_exec> to store the emssage in a database. |
923 | C<PApp::SQL::sql_exec> to store the message in a database. |
914 | |
924 | |
915 | $ctx->fmt_cb (sub { \@_ }); |
925 | $ctx->fmt_cb (sub { \@_ }); |
916 | $ctx->log_cb (sub { |
926 | $ctx->log_cb (sub { |
917 | my ($msg) = @_; |
927 | my ($msg) = @_; |
918 | |
928 | |
… | |
… | |
1036 | |
1046 | |
1037 | =item $ctx->log ($level, $msg[, @params]) |
1047 | =item $ctx->log ($level, $msg[, @params]) |
1038 | |
1048 | |
1039 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
1049 | Same as C<AnyEvent::Log::log>, but uses the given context as log context. |
1040 | |
1050 | |
|
|
1051 | Example: log a message in the context of another package. |
|
|
1052 | |
|
|
1053 | (AnyEvent::Log::ctx "Other::Package")->log (warn => "heely bo"); |
|
|
1054 | |
1041 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1055 | =item $logger = $ctx->logger ($level[, \$enabled]) |
1042 | |
1056 | |
1043 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1057 | Same as C<AnyEvent::Log::logger>, but uses the given context as log |
1044 | context. |
1058 | context. |
1045 | |
1059 | |
… | |
… | |
1192 | |
1206 | |
1193 | Attaches the named context as slave to the context. |
1207 | Attaches the named context as slave to the context. |
1194 | |
1208 | |
1195 | =item C<+> |
1209 | =item C<+> |
1196 | |
1210 | |
1197 | A line C<+> detaches all contexts, i.e. clears the slave list from the |
1211 | A lone C<+> detaches all contexts, i.e. clears the slave list from the |
1198 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1212 | context. Anonymous (C<%name>) contexts have no attached slaves by default, |
1199 | but package contexts have the parent context as slave by default. |
1213 | but package contexts have the parent context as slave by default. |
1200 | |
1214 | |
1201 | Example: log messages from My::Module to a file, do not send them to the |
1215 | Example: log messages from My::Module to a file, do not send them to the |
1202 | default log collector. |
1216 | default log collector. |
… | |
… | |
1278 | if (/\G(.+)/g) { |
1292 | if (/\G(.+)/g) { |
1279 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1293 | die "PERL_ANYEVENT_LOG ($spec): parse error at '$1'\n"; |
1280 | } |
1294 | } |
1281 | } |
1295 | } |
1282 | |
1296 | |
1283 | 1; |
|
|
1284 | |
|
|
1285 | =head1 EXAMPLES |
1297 | =head1 EXAMPLES |
1286 | |
1298 | |
1287 | This section shows some common configurations, both as code, and as |
1299 | This section shows some common configurations, both as code, and as |
1288 | C<PERL_ANYEVENT_LOG> string. |
1300 | C<PERL_ANYEVENT_LOG> string. |
1289 | |
1301 | |
… | |
… | |
1369 | Marc Lehmann <schmorp@schmorp.de> |
1381 | Marc Lehmann <schmorp@schmorp.de> |
1370 | http://home.schmorp.de/ |
1382 | http://home.schmorp.de/ |
1371 | |
1383 | |
1372 | =cut |
1384 | =cut |
1373 | |
1385 | |
|
|
1386 | 1 |
|
|
1387 | |