File: README

package info (click to toggle)
liblog-dispatch-config-perl 1.04-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 224 kB
  • sloc: perl: 233; makefile: 2
file content (306 lines) | stat: -rw-r--r-- 10,816 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
NAME
    Log::Dispatch::Config - Log4j for Perl

SYNOPSIS
      use Log::Dispatch::Config;
      Log::Dispatch::Config->configure('/path/to/log.conf');

      my $dispatcher = Log::Dispatch::Config->instance;
      $dispatcher->debug('this is debug message');
      $dispatcher->emergency('something *bad* happened!');

      # or if you write your own config parser:
      use Log::Dispatch::Configurator::XMLSimple;

      my $config = Log::Dispatch::Configurator::XMLSimple->new('log.xml');
      Log::Dispatch::Config->configure($config);

      # automatic reloading conf file, when modified
      Log::Dispatch::Config->configure_and_watch('/path/to/log.conf');

DESCRIPTION
    Log::Dispatch::Config is a subclass of Log::Dispatch and provides a way
    to configure Log::Dispatch object with configulation file (default, in
    AppConfig format). I mean, this is log4j for Perl, not with all API
    compatibility though.

METHOD
    This module has a class method "configure" which parses config file for
    later creation of the Log::Dispatch::Config singleton instance. (Actual
    construction of the object is done in the first "instance" call).

    So, what you should do is call "configure" method once in somewhere
    (like "startup.pl" in mod_perl), then you can get configured dispatcher
    instance via "Log::Dispatch::Config->instance".

    Formerly, "configure" method declares "instance" method in Log::Dispatch
    namespace. Now it inherits from Log::Dispatch, so the namespace
    pollution is not necessary. Currrent version still defines one-liner
    shortcut:

      sub Log::Dispatch::instance { Log::Dispatch::Config->instance }

    so still you can call "Log::Dispatch->instance", if you prefer, or for
    backward compatibility.

CONFIGURATION
    Here is an example of the config file:

      dispatchers = file screen

      file.class = Log::Dispatch::File
      file.min_level = debug
      file.filename = /path/to/log
      file.mode = append
      file.format = [%d] [%p] %m at %F line %L%n

      screen.class = Log::Dispatch::Screen
      screen.min_level = info
      screen.stderr = 1
      screen.format = %m

    In this example, config file is written in AppConfig format. See the
    Log::Dispatch::Configurator::AppConfig manpage for details.

    See the section on "PLUGGABLE CONFIGURATOR" for other config parsing
    scheme.

  GLOBAL PARAMETERS

    dispatchers
          dispatchers = file screen

        "dispatchers" defines logger names, which will be splitted by
        spaces. If this parameter is unset, no logging is done.

    format
          format = [%d] [%p] %m at %F line %L%n

        "format" defines log format. Possible conversions format are

          %d    datetime string (ctime(3))
          %p    priority (debug, info, warning ...)
          %m    message string
          %F    filename
          %L    line number
          %P    package
          %n    newline (\n)
          %%    % itself

        Note that datetime (%d) format is configurable by passing "strftime"
        fmt in braket after %d. (I know it looks quite messy, but its
        compatible with Java Log4j ;)

          format = [%d{%Y%m%d}] %m  # datetime is now strftime "%Y%m%d"

        If you have Time::Piece, this module uses its "strftime"
        implementation, otherwise POSIX.

        "format" defined here would apply to all the log messages to
        dispatchers. This parameter is optional.

        See the section on "CALLER STACK" for details about package, line
        number and filename.

  PARAMETERS FOR EACH DISPATCHER

    Parameters for each dispatcher should be prefixed with "name.", where
    "name" is the name of each one, defined in global "dispatchers"
    parameter.

    You can also use ".ini" style grouping like:

      [foo]
      class = Log::Dispatch::File
      min_level = debug

    See the Log::Dispatch::Configurator::AppConfig manpage for details.

    class
          screen.class = Log::Dispatch::Screen

        "class" defines class name of Log::Dispatch subclasses. This
        parameter is essential.

    format
          screen.format = -- %m --

        "format" defines log format which would be applied only to the
        dispatcher. Note that if you define global "format" also, %m is
        double formated (first global one, next each dispatcher one). This
        parameter is optional.

    (others)
          screen.min_level = info
          screen.stderr = 1

        Other parameters would be passed to the each dispatcher
        construction. See Log::Dispatch::* manpage for the details.

SINGLETON
    Declared "instance" method would make "Log::Dispatch::Config" class
    singleton, so multiple calls of "instance" will all result in returning
    same object.

      my $one = Log::Dispatch::Config->instance;
      my $two = Log::Dispatch::Config->instance; # same as $one

    See GoF Design Pattern book for Singleton Pattern.

    But in practice, in persistent environment like mod_perl, lifetime of
    Singleton instance becomes sometimes messy. If you want to reload
    singleton object manually, call "reload" method.

      Log::Dispatch::Config->reload;

    And, if you want to reload object on the fly, as you edit "log.conf" or
    something like that, what you should do is to call "configure_and_watch"
    method on Log::Dispatch::Config instead of "configure". Then "instance"
    call will check mtime of configuration file, and compares it with last
    configuration time. If config file is newer than last configuration, it
    will automatically reload object.

NAMESPACE COLLISION
    If you use Log::Dispatch::Config in multiple projects on the same perl
    interpreter (like mod_perl), namespace collision would be a problem.
    Bizzare thing will happen when you call
    "Log::Dispatch::Config->configure" multiple times with differenct
    argument.

    In such cases, what you should do is to define your own logger class.

      package My::Logger;
      use Log::Dispatch::Config;
      use base qw(Log::Dispatch::Config);

    Or make wrapper for it. See the POE::Component::Logger manpage
    implementation by Matt.

PLUGGABLE CONFIGURATOR
    If you pass filename to "configure" method call, this module handles the
    config file with AppConfig. You can change config parsing scheme by
    passing another pluggable configurator object.

    Here is a way to declare new configurator class. The example below is
    hardwired version equivalent to the one above in the section on
    "CONFIGURATION".

    *   Inherit from Log::Dispatch::Configurator.

          package Log::Dispatch::Configurator::Hardwired;
          use base qw(Log::Dispatch::Configurator);

    *   Implement two required object methods "get_attrs_global" and
        "get_attrs".

        "get_attrs_global" should return hash reference of global
        parameters. "dispatchers" should be an array reference of names of
        dispatchers.

          sub get_attrs_global {
              my $self = shift;
              return {
                  format => undef,
                  dispatchers => [ qw(file screen) ],
              };
          }

        "get_attrs" accepts name of a dispatcher and should return hash
        reference of parameters associated with the dispatcher.

          sub get_attrs {
              my($self, $name) = @_;
              if ($name eq 'file') {
                  return {
                      class     => 'Log::Dispatch::File',
                      min_level => 'debug',
                      filename  => '/path/to/log',
                      mode      => 'append',
                      format  => '[%d] [%p] %m at %F line %L%n',
                  };
              }
              elsif ($name eq 'screen') {
                  return {
                      class     => 'Log::Dispatch::Screen',
                      min_level => 'info',
                      stderr    => 1,
                      format  => '%m',
                  };
              }
              else {
                  die "invalid dispatcher name: $name";
              }
          }

    *   Implement optional "needs_reload" and "parse" methods.
        "needs_reload" should return boolean value if the object is stale
        and needs reloading itself. This method will be triggered when you
        configure logging object with "configure_and_watch" method.

        Stub config file mtime based "needs_reload" method is declared in
        Log::Dispatch::Configurator as below, so if your config class is
        based on filesystem files, you do not need to reimplement this.

          sub needs_reload {
              my($self, $obj) = @_;
              return $obj->{ctime} < (stat($self->{file}))[9];
          }

        If you do not need *singleton-ness at all*, always return true.

          sub needs_reload { 1 }

        "parse" method should do parsing of the config file. This method is
        called in the first parsing of the config file, and again when
        "needs_reload" returns true. Log::Dispatch::Configurator base class
        has a null "parse" method.

    *   That's all. Now you can plug your own configurator (Hardwired) into
        Log::Dispatch::Config. What you should do is to pass configurator
        object to "configure" method call instead of config file name.

          use Log::Dispatch;
          use Log::Dispatch::Configurator::Hardwired;

          my $config = Log::Dispatch::Configurator::Hardwired->new;
          Log::Dispatch::Config->configure($config);

CALLER STACK
    When you call logging method from your subroutines / methods, caller
    stack would increase and thus you can't see where the log really comes
    from.

      package Logger;
      my $Logger = Log::Dispatch::Config->instance;

      sub logit {
          my($class, $level, $msg) = @_;
          $Logger->$level($msg);
      }

      package main;
      Logger->logit('debug', 'foobar');

    You can adjust package variable $Log::Dispatch::Config::CallerDepth to
    increase the caller stack depth. The default value is 0.

      sub logit {
          my($class, $level, $msg) = @_;
          local $Log::Dispatch::Config::CallerDepth = 1;
          $Logger->$level($msg);
      }

    Note that your log caller's namespace should not match against
    "/^Log::Dispatch/", which makes this module confusing.

AUTHOR
    Tatsuhiko Miyagawa <miyagawa@bulknews.net> with much help from Matt
    Sergeant <matt@sergeant.org>.

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

SEE ALSO
    the Log::Dispatch::Configurator::AppConfig manpage, the Log::Dispatch
    manpage, the AppConfig manpage, the POE::Component::Logger manpage