1 package Object::Remote::Logging::Logger;
6 #TODO sigh invoking a logger with a log level name the same
7 #as an attribute could happen - restrict attributes to _ prefix
8 #and restrict log levels to not start with out that prefix?
9 has format => ( is => 'ro', required => 1, default => sub { '%l: %s' } );
10 has level_names => ( is => 'ro', required => 1 );
11 has min_level => ( is => 'ro', required => 1, default => sub { 'info' } );
12 has max_level => ( is => 'lazy', required => 1 );
13 has _level_active => ( is => 'lazy' );
15 #just a stub so it doesn't get to AUTOLOAD
21 (my $method) = (our $AUTOLOAD =~ /([^:]+)$/);
25 if ($method =~ m/^_/) {
26 croak "invalid method name $method for " . ref($self);
29 if ($method =~ m/^is_(.+)/) {
31 my $is_method = "is_$level_name";
32 *{$is_method} = sub { shift(@_)->_level_active->{$level_name} };
33 return $self->$is_method;
36 my $level_name = $method;
37 *{$level_name} = sub {
39 unless(exists($self->_level_active->{$level_name})) {
40 croak "$level_name is not a valid log level name";
43 $self->_log($level_name, @_);
46 return $self->$level_name(@_);
49 sub _build_max_level {
51 return $self->level_names->[-1];
54 sub _build__level_active {
57 my $min_level = $self->min_level;
58 my $max_level = $self->max_level;
61 foreach my $level (@{$self->level_names}) {
62 if($level eq $min_level) {
66 $active{$level} = $should_log;
68 if (defined $max_level && $level eq $max_level) {
77 my ($self, $level, $content, $metadata_in) = @_;
78 my %metadata = %$metadata_in;
79 my $rendered = $self->_render($level, \%metadata, @$content);
80 $self->_output($rendered);
83 sub _create_format_lookup {
84 my ($self, $level, $metadata, $content) = @_;
85 my $method = $metadata->{method};
87 $method = '(none)' unless defined $method;
90 '%' => '%', 'n' => "\n",
91 t => $self->_render_time($metadata->{timestamp}),
92 r => $self->_render_remote($metadata->{object_remote}),
93 s => $self->_render_log(@$content), l => $level,
94 c => $metadata->{exporter}, p => $metadata->{caller_package}, m => $method,
95 f => $metadata->{filename}, i => $metadata->{line},
96 h => $metadata->{hostname}, P => $metadata->{pid},
100 sub _get_format_var_value {
101 my ($self, $name, $data) = @_;
102 my $val = $data->{$name};
103 return $val if defined $val;
104 return '(undefined)';
108 my ($self, $time) = @_;
109 return scalar(localtime($time));
113 my ($self, $remote) = @_;
114 return 'local' unless defined $remote;
115 my $conn_id = $remote->{connection_id};
116 $conn_id = '(uninit)' unless defined $conn_id;
117 return "remote #$conn_id";
121 my ($self, @content) = @_;
122 return join('', @content);
125 my ($self, $level, $metadata, @content) = @_;
126 my $var_table = $self->_create_format_lookup($level, $metadata, [@content]);
127 my $template = $self->format;
129 $template =~ s/%([\w%])/$self->_get_format_var_value($1, $var_table)/ge;
132 $template =~ s/\n/\n /g;
138 my ($self, $content) = @_;
139 print STDERR $content;
148 Object::Remote::Logging::Logger - Format and output a log message
152 use Object::Remote::Logging::Logger;
153 use Object::Remote::Logging qw( router arg_levels );
155 my $app_output = Object::Remote::Logging::Logger->new(
156 level_names => arg_levels, format => '%t %s',
157 min_level => 'verbose', max_level => 'info',
160 #Selector method can return 0 or more logger
161 #objects that will receive the messages
163 my ($generating_package, $metadata) = @_;
164 return unless $metadata->{exporter} eq 'App::Logging::Subclass';
168 #true value as second argument causes the selector
169 #to be stored with a weak reference
170 router->connect($selector, 1);
172 #disconnect the selector from the router
175 #router will hold this logger forever
176 #and send it all log messages
177 router->connect(Object::Remote::Logging::Logger->new(
178 level_names => arg_levels, format => '%s at %f line %i, log level: %l'
179 min_level => 'warn', max_level => 'error',
184 This class receives log messages from an instance of L<Object::Remote::Logging::Router>,
185 formats them according to configuration, and then outputs them to STDERR. In between
186 the router and the logger is a selector method which inspects the log message metadata
187 and can return 0 or more loggers that should receive the log message.
191 A logger object receives the log messages that are generated and converts them to
192 formatted log entries then displays them to the end user. Each logger has a set
193 of active log levels and will only output a log entry if the log message is at
196 To gain access to the stream of log messages a connection is made to the log router.
197 A logger can directly connect to the router and receive an unfiltered stream of
198 log messages or a selector closure can be used instead. The selector will be executed
199 for each log message with the message metadata and returns a list of 0 or more loggers
200 that should receive the log message. When the selector is executed the first argument
201 is the name of the package that generated the log message and the second argument
202 is a hash reference containing the message metadata.
206 The message metadata is a hash reference with the following keys:
212 Name of the log level of the message.
216 Package name of the logging API that was used to generate the log message.
220 Name of the package that generated the log message.
224 Name of the method the message was generated inside of.
228 Unix time of the message generation.
232 Process id of the Perl interpreter the message was generated in.
236 Hostname of the system where the message was generated.
240 Name of the file the message was generated in.
244 Line of the source file the message was generated at.
248 This is a reference to another hash that contains the Object::Remote
249 specific information. The keys are
255 If the log message was generated on a remote Perl interpreter then the
256 Object::Remote::Connection id of that interpreter will be available here.
268 This is a required attribute. Must be an array ref with the list of log level names
269 in it. The list must be ordered with the lowest level as element 0 and the highest
270 level as the last element. There is no default value.
274 The lowest log level that will be output by the logger. There is no default value.
278 The highest log level that will be output by the logger. The default value is the
279 highest level present in level_names.
283 The printf style format string to use when rendering the log message. The following
284 sequences are significant:
290 Level name that the log message was generated at.
294 Log message rendered into a string with a leading space before any additional lines in a
295 multiple line message.
299 Time the log message was generated rendered into a string. The time value is taken from
300 the Perl interpreter that generated the log message; it is not the time that the logger
301 received the log message on the local interpreter if the log message was forwarded.
305 Object::Remote connection information rendered into a string.
309 Package name of the logging API that was used to generate the log message.
313 Name of the package that generated the log message.
317 Method name that generated the log message.
321 Filename that the log message was generated in.
325 Line number the log message was generated at.
329 Hostname the log message was generated on.
333 Process id of the Perl interpreter that generated the log message.