| … | |
… | |
| 9 | use AnyEvent; |
9 | use AnyEvent; |
| 10 | |
10 | |
| 11 | AE::log trace => "going to call function abc"; |
11 | AE::log trace => "going to call function abc"; |
| 12 | AE::log debug => "the function returned 3"; |
12 | AE::log debug => "the function returned 3"; |
| 13 | AE::log info => "file soandso successfully deleted"; |
13 | AE::log info => "file soandso successfully deleted"; |
| 14 | AE::log note => "wanted to create config, but config was alraedy created"; |
14 | AE::log note => "wanted to create config, but config was already created"; |
| 15 | AE::log warn => "couldn't delete the file"; |
15 | AE::log warn => "couldn't delete the file"; |
| 16 | AE::log error => "failed to retrieve data"; |
16 | AE::log error => "failed to retrieve data"; |
| 17 | AE::log crit => "the battery temperature is too hot"; |
17 | AE::log crit => "the battery temperature is too hot"; |
| 18 | AE::log alert => "the battery died"; |
18 | AE::log alert => "the battery died"; |
| 19 | AE::log fatal => "no config found, cannot continue"; # never returns |
19 | AE::log fatal => "no config found, cannot continue"; # never returns |
| … | |
… | |
| 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<3> (C<critical>), so little |
| 67 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
67 | will be logged, unless you set C<PERL_ANYEVENT_VERBOSE> to a higher number |
| 68 | before starting your program, or change the logging level at runtime with |
68 | before starting your program, or change the logging level at runtime with |
| 69 | something like: |
69 | something like: |
| 70 | |
70 | |
| 71 | use AnyEvent::Log; |
71 | use AnyEvent::Log; |
| … | |
… | |
| 106 | is the "official" name, the second one the "syslog" name (if it differs) |
106 | 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> |
107 | 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 |
108 | messages at C<error> priority. The NOTE column tries to provide some |
| 109 | rationale on how to chose a logging level. |
109 | rationale on how to chose a logging level. |
| 110 | |
110 | |
| 111 | As a rough guideline, levels 1..3 are primarily meant for users of |
111 | 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 |
112 | 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 |
113 | default. Levels 4..6 are meant for users and developers alike, while |
| 114 | levels 7..9 are usually meant for developers. |
114 | levels 7..9 are usually meant for developers. |
| 115 | |
115 | |
| 116 | You can normally only log a single message at highest priority level |
116 | 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 |
117 | C<fatal>), because logging a fatal message will also quit the program - so |
| 118 | program - so use it sparingly :) |
118 | use it sparingly :) |
| 119 | |
119 | |
| 120 | Some methods also offer some extra levels, such as C<0>, C<off>, C<none> |
120 | 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. |
121 | or C<all> - these are only valid for the methods that documented them. |
| 122 | |
122 | |
| 123 | =head1 LOGGING FUNCTIONS |
123 | =head1 LOGGING FUNCTIONS |
| 124 | |
124 | |
| 125 | These functions allow you to log messages. They always use the caller's |
125 | 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 |
126 | 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 |
127 | C<log>, is aliased to C<AnyEvent::log> and C<AE::log> when the C<AnyEvent> |
| 128 | loaded. |
128 | module is loaded. |
| 129 | |
129 | |
| 130 | =over 4 |
130 | =over 4 |
| 131 | |
131 | |
| 132 | =cut |
132 | =cut |
| 133 | |
133 | |
