package Log::Contextual;
+# ABSTRACT: Simple logging interface with a contextual log
+
use strict;
use warnings;
-our $VERSION = '1.000';
+my @levels = qw(debug trace warn info error fatal);
-require Exporter;
+use Exporter::Declare;
+use Exporter::Declare::Export::Generator;
use Data::Dumper::Concise;
+use Scalar::Util 'blessed';
-BEGIN { our @ISA = qw(Exporter) }
-
-my @dlog = (qw{
- Dlog_debug DlogS_debug
- Dlog_trace DlogS_trace
- Dlog_warn DlogS_warn
- Dlog_info DlogS_info
- Dlog_error DlogS_error
- Dlog_fatal DlogS_fatal
-});
-
-my @log = (qw{
- log_debug
- log_trace
- log_warn
- log_info
- log_error
- log_fatal
-});
-
-our @EXPORT_OK = (
- @dlog, @log,
- qw{set_logger with_logger}
-);
-
-our %EXPORT_TAGS = (
- dlog => \@dlog,
- log => \@log,
-);
-
-sub import {
- my $package = shift;
- die 'Log::Contextual does not have a default import list'
- unless @_;
-
- for my $idx ( 0 .. $#_ ) {
- if ( $_[$idx] eq '-logger' ) {
- set_logger($_[$idx + 1]);
- splice @_, $idx, 2;
- last;
- }
- }
- $package->export_to_level(1, $package, @_);
-}
+use B qw(svref_2object);
-our $Get_Logger;
+sub stash_name {
+ my ($coderef) = @_;
+ ref $coderef or return;
+ my $cv = B::svref_2object($coderef);
+ $cv->isa('B::CV') or return;
+ # bail out if GV is undefined
+ $cv->GV->isa('B::SPECIAL') and return;
-sub set_logger {
- my $logger = $_[0];
- $logger = do { my $l = $logger; sub { $l } }
- if ref $logger ne 'CODE';
- $Get_Logger = $logger;
+ return $cv->GV->STASH->NAME;
}
-sub with_logger {
- my $logger = $_[0];
- $logger = do { my $l = $logger; sub { $l } }
- if ref $logger ne 'CODE';
- local $Get_Logger = $logger;
- $_[1]->();
-}
+my @dlog = ((map "Dlog_$_", @levels), (map "DlogS_$_", @levels));
-sub log_trace (&) {
- my $log = $Get_Logger->();
- $log->trace($_[0]->())
- if $log->is_trace;
-}
+my @log = ((map "log_$_", @levels), (map "logS_$_", @levels));
-sub log_debug (&) {
- my $log = $Get_Logger->();
- $log->debug($_[0]->())
- if $log->is_debug;
-}
+sub _maybe_export {
+ my ($spec, $target, $name, $new_code) = @_;
-sub log_info (&) {
- my $log = $Get_Logger->();
- $log->info($_[0]->())
- if $log->is_info;
-}
+ if (my $code = $target->can($name)) {
-sub log_warn (&) {
- my $log = $Get_Logger->();
- $log->warn($_[0]->())
- if $log->is_warn;
+ # this will warn
+ $spec->add_export("&$name", $new_code)
+ unless (stash_name($code) eq __PACKAGE__);
+ } else {
+ $spec->add_export("&$name", $new_code)
+ }
}
-sub log_error (&) {
- my $log = $Get_Logger->();
- $log->error($_[0]->())
- if $log->is_error;
-}
+eval {
+ require Log::Log4perl;
+ die if $Log::Log4perl::VERSION < 1.29;
+ Log::Log4perl->wrapper_register(__PACKAGE__)
+};
-sub log_fatal (&) {
- my $log = $Get_Logger->();
- $log->fatal($_[0]->())
- if $log->is_fatal;
-}
+# ____ is because tags must have at least one export and we don't want to
+# export anything but the levels selected
+sub ____ { }
+exports('____', @dlog, @log, qw( set_logger with_logger ));
+export_tag dlog => ('____');
+export_tag log => ('____');
+import_arguments qw(logger package_logger default_logger);
-sub Dlog_trace (&@) {
- my $code = shift;
- my @values = @_;
- log_trace {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
+sub router {
+ our $Router_Instance ||= do {
+ require Log::Contextual::Router;
+ Log::Contextual::Router->new
+ }
}
-sub DlogS_trace (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_trace {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
-}
+sub default_import {
+ my ($class) = shift;
-sub Dlog_debug (&@) {
- my $code = shift;
- my @values = @_;
- log_debug {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
-}
+ die 'Log::Contextual does not have a default import list';
-sub DlogS_debug (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_debug {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
+ ()
}
-sub Dlog_info (&@) {
- my $code = shift;
- my @values = @_;
- log_info {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
-}
+sub arg_logger { $_[1] }
+sub arg_levels { $_[1] || [qw(debug trace warn info error fatal)] }
+sub arg_package_logger { $_[1] }
+sub arg_default_logger { $_[1] }
+
+sub before_import {
+ my ($class, $importer, $spec) = @_;
+ my $router = $class->router;
+ my $exports = $spec->exports;
+ my %router_args = (
+ exporter => $class,
+ target => $importer,
+ arguments => $spec->argument_info
+ );
+
+ my @tags = $class->default_import($spec)
+ if $spec->config->{default};
+
+ for (@tags) {
+ die "only tags are supported for defaults at this time"
+ unless $_ =~ /^:(.*)$/;
+
+ $spec->config->{$1} = 1;
+ }
-sub DlogS_info (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_info {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
-}
+ $router->before_import(%router_args);
-sub Dlog_warn (&@) {
- my $code = shift;
- my @values = @_;
- log_warn {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
-}
+ if ($exports->{'&set_logger'}) {
+ die ref($router) . " does not support set_logger()"
+ unless $router->does('Log::Contextual::Role::Router::SetLogger');
-sub DlogS_warn (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_warn {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
-}
+ _maybe_export($spec, $importer, 'set_logger',
+ sub { $router->set_logger(@_) },
+ );
+ }
-sub Dlog_error (&@) {
- my $code = shift;
- my @values = @_;
- log_error {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
-}
+ if ($exports->{'&with_logger'}) {
+ die ref($router) . " does not support with_logger()"
+ unless $router->does('Log::Contextual::Role::Router::WithLogger');
-sub DlogS_error (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_error {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
+ _maybe_export($spec, $importer, 'with_logger',
+ sub { $router->with_logger(@_) },
+ );
+ }
+
+ my @levels = @{$class->arg_levels($spec->config->{levels})};
+ for my $level (@levels) {
+ if ($spec->config->{log} || $exports->{"&log_$level"}) {
+ _maybe_export(
+ $spec,
+ $importer,
+ "log_$level",
+ sub (&@) {
+ my ($code, @args) = @_;
+ $router->handle_log_request(
+ exporter => $class,
+ caller_package => scalar(caller),
+ caller_level => 1,
+ message_level => $level,
+ message_sub => $code,
+ message_args => \@args,
+ );
+ return @args;
+ },
+ );
+ }
+ if ($spec->config->{log} || $exports->{"&logS_$level"}) {
+ _maybe_export(
+ $spec,
+ $importer,
+ "logS_$level",
+ sub (&@) {
+ my ($code, @args) = @_;
+ $router->handle_log_request(
+ exporter => $class,
+ caller_package => scalar(caller),
+ caller_level => 1,
+ message_level => $level,
+ message_sub => $code,
+ message_args => \@args,
+ );
+ return $args[0];
+ },
+ );
+ }
+ if ($spec->config->{dlog} || $exports->{"&Dlog_$level"}) {
+ _maybe_export(
+ $spec,
+ $importer,
+ "Dlog_$level",
+ sub (&@) {
+ my ($code, @args) = @_;
+ my $wrapped = sub {
+ local $_ = (@_ ? Data::Dumper::Concise::Dumper @_ : '()');
+ &$code;
+ };
+ $router->handle_log_request(
+ exporter => $class,
+ caller_package => scalar(caller),
+ caller_level => 1,
+ message_level => $level,
+ message_sub => $wrapped,
+ message_args => \@args,
+ );
+ return @args;
+ },
+ );
+ }
+ if ($spec->config->{dlog} || $exports->{"&DlogS_$level"}) {
+ _maybe_export(
+ $spec,
+ $importer,
+ "DlogS_$level",
+ sub (&$) {
+ my ($code, $ref) = @_;
+ my $wrapped = sub {
+ local $_ = Data::Dumper::Concise::Dumper($_[0]);
+ &$code;
+ };
+ $router->handle_log_request(
+ exporter => $class,
+ caller_package => scalar(caller),
+ caller_level => 1,
+ message_level => $level,
+ message_sub => $wrapped,
+ message_args => [$ref],
+ );
+ return $ref;
+ });
+ }
+ }
}
-sub Dlog_fatal (&@) {
- my $code = shift;
- my @values = @_;
- log_fatal {
- do { local $_ = Data::Dumper::Concise::Dumper @values; $code->() };
- };
- @values
+sub after_import {
+ my ($class, $importer, $spec) = @_;
+ my %router_args = (
+ exporter => $class,
+ target => $importer,
+ arguments => $spec->argument_info
+ );
+ $class->router->after_import(%router_args);
}
-sub DlogS_fatal (&$) {
- my $code = $_[0];
- my $value = $_[1];
- log_fatal {
- do { local $_ = Data::Dumper::Concise::Dumper $value; $code->() };
- };
- $value
+for (qw(set with)) {
+ no strict 'refs';
+ my $sub = "${_}_logger";
+ *{"Log::Contextual::$sub"} = sub {
+ die "$sub is no longer a direct sub in Log::Contextual. "
+ . 'Note that this feature was never tested nor documented. '
+ . "Please fix your code to import $sub instead of trying to use it directly"
+ }
}
1;
__END__
-=head1 NAME
-
-Log::Contextual - Super simple logging interface
-
=head1 SYNOPSIS
- use Log::Contextual qw{:log set_logger with_logger};
+ use Log::Contextual qw( :log :dlog set_logger with_logger );
+ use Log::Contextual::SimpleLogger;
+ use Log::Log4perl ':easy';
+ Log::Log4perl->easy_init($DEBUG);
- my $logger = Log::Contextual::SimpleLogger->new({ levels => [qw{debug}]});
+ my $logger = Log::Log4perl->get_logger;
- set_logger { $logger };
+ set_logger $logger;
- log_debug { "program started" };
+ log_debug { 'program started' };
sub foo {
- with_logger Log::Contextual::SimpleLogger->new({
- levels => [qw{trace debug}]
- }) => sub {
+
+ my $minilogger = Log::Contextual::SimpleLogger->new({
+ levels => [qw( trace debug )]
+ });
+
+ my @args = @_;
+
+ with_logger $minilogger => sub {
log_trace { 'foo entered' };
+ my ($foo, $bar) = Dlog_trace { "params for foo: $_" } @args;
# ...
log_trace { 'foo left' };
};
}
+ foo();
+
+Beginning with version 1.008 L<Log::Dispatchouli> also works out of the box
+with C<Log::Contextual>:
+
+ use Log::Contextual qw( :log :dlog set_logger );
+ use Log::Dispatchouli;
+ my $ld = Log::Dispatchouli->new({
+ ident => 'slrtbrfst',
+ to_stderr => 1,
+ debug => 1,
+ });
+
+ set_logger $ld;
+
+ log_debug { 'program started' };
+
=head1 DESCRIPTION
-This module is a simple interface to extensible logging.
+Major benefits:
+
+=over 2
+
+=item * Efficient
+
+The logging functions take blocks, so if a log level is disabled, the
+block will not run:
+
+ # the following won't run if debug is off
+ log_debug { "the new count in the database is " . $rs->count };
+
+Similarly, the C<D> prefixed methods only C<Dumper> the input if the level is
+enabled.
+
+=item * Handy
+
+The logging functions return their arguments, so you can stick them in
+the middle of expressions:
+
+ for (log_debug { "downloading:\n" . join qq(\n), @_ } @urls) { ... }
+
+=item * Generic
+
+C<Log::Contextual> is an interface for all major loggers. If you log through
+C<Log::Contextual> you will be able to swap underlying loggers later.
+
+=item * Powerful
+
+C<Log::Contextual> chooses which logger to use based on L<< user defined C<CodeRef>s|/LOGGER CODEREF >>.
+Normally you don't need to know this, but you can take advantage of it when you
+need to later.
+
+=item * Scalable
+
+If you just want to add logging to your basic application, start with
+L<Log::Contextual::SimpleLogger> and then as your needs grow you can switch to
+L<Log::Dispatchouli> or L<Log::Dispatch> or L<Log::Log4perl> or whatever else.
+
+=back
+
+This module is a simple interface to extensible logging. It exists to
+abstract your logging interface so that logging is as painless as possible,
+while still allowing you to switch from one logger to another.
+
+It is bundled with a really basic logger, L<Log::Contextual::SimpleLogger>,
+but in general you should use a real logger instead. For something
+more serious but not overly complicated, try L<Log::Dispatchouli> (see
+L</SYNOPSIS> for example.)
+
+=head1 A WORK IN PROGRESS
+
+This module is certainly not complete, but we will not break the interface
+lightly, so I would say it's safe to use in production code. The main result
+from that at this point is that doing:
+
+ use Log::Contextual;
+
+will die as we do not yet know what the defaults should be. If it turns out
+that nearly everyone uses the C<:log> tag and C<:dlog> is really rare, we'll
+probably make C<:log> the default. But only time and usage will tell.
+
+=head1 IMPORT OPTIONS
+
+See L</SETTING DEFAULT IMPORT OPTIONS> for information on setting these project
+wide.
+
+=head2 -logger
+
+When you import this module you may use C<-logger> as a shortcut for
+L</set_logger>, for example:
+
+ use Log::Contextual::SimpleLogger;
+ use Log::Contextual qw( :dlog ),
+ -logger => Log::Contextual::SimpleLogger->new({ levels => [qw( debug )] });
+
+sometimes you might want to have the logger handy for other stuff, in which
+case you might try something like the following:
+
+ my $var_log;
+ BEGIN { $var_log = VarLogger->new }
+ use Log::Contextual qw( :dlog ), -logger => $var_log;
+
+=head2 -levels
+
+The C<-levels> import option allows you to define exactly which levels your
+logger supports. So the default,
+C<< [qw(debug trace warn info error fatal)] >>, works great for
+L<Log::Log4perl>, but it doesn't support the levels for L<Log::Dispatch>. But
+supporting those levels is as easy as doing
+
+ use Log::Contextual
+ -levels => [qw( debug info notice warning error critical alert emergency )];
+
+=head2 -package_logger
+
+The C<-package_logger> import option is similar to the C<-logger> import option
+except C<-package_logger> sets the logger for the current package.
+
+Unlike L</-default_logger>, C<-package_logger> cannot be overridden with
+L</set_logger> or L</with_logger>.
+
+ package My::Package;
+ use Log::Contextual::SimpleLogger;
+ use Log::Contextual qw( :log ),
+ -package_logger => Log::Contextual::WarnLogger->new({
+ env_prefix => 'MY_PACKAGE'
+ });
+
+If you are interested in using this package for a module you are putting on
+CPAN we recommend L<Log::Contextual::WarnLogger> for your package logger.
+
+=head2 -default_logger
+
+The C<-default_logger> import option is similar to the C<-logger> import option
+except C<-default_logger> sets the B<default> logger for the current package.
+
+Basically it sets the logger to be used if C<set_logger> is never called; so
+
+ package My::Package;
+ use Log::Contextual::SimpleLogger;
+ use Log::Contextual qw( :log ),
+ -default_logger => Log::Contextual::WarnLogger->new({
+ env_prefix => 'MY_PACKAGE'
+ });
+
+=head1 SETTING DEFAULT IMPORT OPTIONS
+
+Eventually you will get tired of writing the following in every single one of
+your packages:
+
+ use Log::Log4perl;
+ use Log::Log4perl ':easy';
+ BEGIN { Log::Log4perl->easy_init($DEBUG) }
+
+ use Log::Contextual -logger => Log::Log4perl->get_logger;
+
+You can set any of the import options for your whole project if you define your
+own C<Log::Contextual> subclass as follows:
+
+ package MyApp::Log::Contextual;
+
+ use base 'Log::Contextual';
+
+ use Log::Log4perl ':easy';
+ Log::Log4perl->easy_init($DEBUG)
+
+ sub arg_default_logger { $_[1] || Log::Log4perl->get_logger }
+ sub arg_levels { [qw(debug trace warn info error fatal custom_level)] }
+ sub default_import { ':log' }
+
+ # or maybe instead of default_logger
+ sub arg_package_logger { $_[1] }
+
+ # and almost definitely not this, which is only here for completeness
+ sub arg_logger { $_[1] }
+
+Note the C<< $_[1] || >> in C<arg_default_logger>. All of these methods are
+passed the values passed in from the arguments to the subclass, so you can
+either throw them away, honor them, die on usage, etc. To be clear,
+if you define your subclass, and someone uses it as follows:
+
+ use MyApp::Log::Contextual -default_logger => $foo,
+ -levels => [qw(bar baz biff)];
+
+Your C<arg_default_logger> method will get C<$foo> and your C<arg_levels>
+will get C<[qw(bar baz biff)]>;
+
+Additionally, the C<default_import> method is what happens if a user tries to
+use your subclass with no arguments. The default just dies, but if you'd like
+to change the default to import a tag merely return the tags you'd like to
+import. So the following will all work:
+
+ sub default_import { ':log' }
+
+ sub default_import { ':dlog' }
+
+ sub default_import { qw(:dlog :log ) }
+
+See L<Log::Contextual::Easy::Default> for an example of a subclass of
+C<Log::Contextual> that makes use of default import options.
=head1 FUNCTIONS
my $logger = WarnLogger->new;
set_logger $logger;
-Arguments: Ref|CodeRef $returning_logger
+Arguments: L</LOGGER CODEREF>
C<set_logger> will just set the current logger to whatever you pass it. It
expects a C<CodeRef>, but if you pass it something else it will wrap it in a
-C<CodeRef> for you.
+C<CodeRef> for you. C<set_logger> is really meant only to be called from a
+top-level script. To avoid foot-shooting the function will warn if you call it
+more than once.
=head2 with_logger
}
};
-Arguments: Ref|CodeRef $returning_logger, CodeRef $to_execute
+Arguments: L</LOGGER CODEREF>, C<CodeRef $to_execute>
C<with_logger> sets the logger for the scope of the C<CodeRef> C<$to_execute>.
-as with L<set_logger>, C<with_logger> will wrap C<$returning_logger> with a
+As with L</set_logger>, C<with_logger> will wrap C<$returning_logger> with a
C<CodeRef> if needed.
=head2 log_$level
-Arguments: CodeRef $returning_message
+Import Tag: C<:log>
-All of the following six functions work the same except that a different method
+Arguments: C<CodeRef $returning_message, @args>
+
+C<log_$level> functions all work the same except that a different method
is called on the underlying C<$logger> object. The basic pattern is:
- sub log_$level (&) {
+ sub log_$level (&@) {
if ($logger->is_$level) {
- $logger->$level(shift->());
+ $logger->$level(shift->(@_));
}
+ @_
}
-=head3 log_trace
+Note that the function returns it's arguments. This can be used in a number of
+ways, but often it's convenient just for partial inspection of passthrough data
+
+ my @friends = log_trace {
+ 'friends list being generated, data from first friend: ' .
+ Dumper($_[0]->TO_JSON)
+ } generate_friend_list();
+
+If you want complete inspection of passthrough data, take a look at the
+L</Dlog_$level> functions.
+
+Which functions are exported depends on what was passed to L</-levels>. The
+default (no C<-levels> option passed) would export:
- log_trace { 'entered method foo with args ' join q{,}, @args };
+=over 2
-=head3 log_debug
+=item log_trace
- log_debug { 'entered method foo' };
+=item log_debug
-=head3 log_info
+=item log_info
- log_info { 'started process foo' };
+=item log_warn
-=head3 log_warn
+=item log_error
- log_warn { 'possible misconfiguration at line 10' };
+=item log_fatal
-=head3 log_error
+=back
- log_error { 'non-numeric user input!' };
+=head2 logS_$level
-=head3 log_fatal
+Import Tag: C<:log>
- log_fatal { '1 is never equal to 0!' };
+Arguments: C<CodeRef $returning_message, Item $arg>
+
+This is really just a special case of the L</log_$level> functions. It forces
+scalar context when that is what you need. Other than that it works exactly
+same:
+
+ my $friend = logS_trace {
+ 'I only have one friend: ' . Dumper($_[0]->TO_JSON)
+ } friend();
+
+See also: L</DlogS_$level>.
=head2 Dlog_$level
-Arguments: CodeRef $returning_message
+Import Tag: C<:dlog>
+
+Arguments: C<CodeRef $returning_message, @args>
-All of the following six functions work the same as their log_$level brethren,
-except they return what is passed into them and as a bonus put the stringified
+All of the following six functions work the same as their L</log_$level>
+brethren, except they return what is passed into them and put the stringified
(with L<Data::Dumper::Concise>) version of their args into C<$_>. This means
you can do cool things like the following:
"fRUE"
"fiSMBoC"
-=head3 Dlog_trace
+Which functions are exported depends on what was passed to L</-levels>. The
+default (no C<-levels> option passed) would export:
- my ($foo, $bar) = Dlog_trace { "entered method foo with args $_" } @_;
+=over 2
-=head3 Dlog_debug
+=item Dlog_trace
- Dlog_debug { "random data structure: $_" } { foo => $bar };
+=item Dlog_debug
-=head3 Dlog_info
+=item Dlog_info
- return Dlog_info { "html from method returned: $_" } "<html>...</html>";
+=item Dlog_warn
-=head3 Dlog_warn
+=item Dlog_error
- Dlog_warn { "probably invalid value: $_" } $foo;
+=item Dlog_fatal
-=head3 Dlog_error
+=back
- Dlog_error { "non-numeric user input! ($_)" } $port;
+=head2 DlogS_$level
-=head3 Dlog_fatal
+Import Tag: C<:dlog>
- Dlog_fatal { '1 is never equal to 0!' } 'ZOMG ZOMG' if 1 == 0;
+Arguments: C<CodeRef $returning_message, Item $arg>
-=head1 AUTHOR
+Like L</logS_$level>, these functions are a special case of L</Dlog_$level>.
+They only take a single scalar after the C<$returning_message> instead of
+slurping up (and also setting C<wantarray>) all the C<@args>
-frew - Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+ my $pals_rs = DlogS_debug { "pals resultset: $_" }
+ $schema->resultset('Pals')->search({ perlers => 1 });
-=head1 DESIGNER
+=head1 LOGGER CODEREF
-mst - Matt S. Trout <mst@shadowcat.co.uk>
+Anywhere a logger object can be passed, a coderef is accepted. This is so
+that the user can use different logger objects based on runtime information.
+The logger coderef is passed the package of the caller, and the caller level the
+coderef needs to use if it wants more caller information. The latter is in
+a hashref to allow for more options in the future.
-=head1 COPYRIGHT
+Here is a basic example of a logger that exploits C<caller> to reproduce the
+output of C<warn> with a logger:
-Copyright (c) 2010 the Log::Contextual L</AUTHOR> and L</DESIGNER> as listed
-above.
+ my @caller_info;
+ my $var_log = Log::Contextual::SimpleLogger->new({
+ levels => [qw(trace debug info warn error fatal)],
+ coderef => sub { chomp($_[0]); warn "$_[0] at $caller_info[1] line $caller_info[2].\n" }
+ });
+ my $warn_faker = sub {
+ my ($package, $args) = @_;
+ @caller_info = caller($args->{caller_level});
+ $var_log
+ };
+ set_logger($warn_faker);
+ log_debug { 'test' };
+
+The following is an example that uses the information passed to the logger
+coderef. It sets the global logger to C<$l3>, the logger for the C<A1>
+package to C<$l1>, except the C<lol> method in C<A1> which uses the C<$l2>
+logger and lastly the logger for the C<A2> package to C<$l2>.
+
+Note that it increases the caller level as it dispatches based on where
+the caller of the log function, not the log function itself.
+
+ my $complex_dispatcher = do {
+
+ my $l1 = ...;
+ my $l2 = ...;
+ my $l3 = ...;
+
+ my %registry = (
+ -logger => $l3,
+ A1 => {
+ -logger => $l1,
+ lol => $l2,
+ },
+ A2 => { -logger => $l2 },
+ );
+
+ sub {
+ my ( $package, $info ) = @_;
+
+ my $logger = $registry{'-logger'};
+ if (my $r = $registry{$package}) {
+ $logger = $r->{'-logger'} if $r->{'-logger'};
+ my (undef, undef, undef, $sub) = caller($info->{caller_level} + 1);
+ $sub =~ s/^\Q$package\E:://g;
+ $logger = $r->{$sub} if $r->{$sub};
+ }
+ return $logger;
+ }
+ };
+
+ set_logger $complex_dispatcher;
+
+=head1 LOGGER INTERFACE
+
+Because this module is ultimately pretty looking glue (glittery?) with the
+awesome benefit of the Contextual part, users will often want to make their
+favorite logger work with it. The following are the methods that should be
+implemented in the logger:
+
+ is_trace
+ is_debug
+ is_info
+ is_warn
+ is_error
+ is_fatal
+ trace
+ debug
+ info
+ warn
+ error
+ fatal
+
+The first six merely need to return true if that level is enabled. The latter
+six take the results of whatever the user returned from their coderef and log
+them. For a basic example see L<Log::Contextual::SimpleLogger>.
+
+=head1 LOG ROUTING
+
+In between the loggers and the log functions is a log router that is responsible for
+finding a logger to handle the log event and passing the log information to the
+logger. This relationship is described in the documentation for C<Log::Contextual::Role::Router>.
-=head1 LICENSE
+C<Log::Contextual> and packages that extend it will by default share a router singleton that
+implements the with_logger() and set_logger() functions and also respects the -logger,
+-package_logger, and -default_logger import options with their associated default value
+functions. The router singleton is available as the return value of the router() function. Users
+of Log::Contextual may overload router() to return instances of custom log routers that
+could for example work with loggers that use a different interface.
-This library is free software and may be distributed under the same terms as
-Perl 5 itself.
+=head1 CONTRIBUTORS
+
+=encoding utf8
+
+triddle - Tyler Riddle <t.riddle@shadowcat.co.uk>
+
+voj - Jakob Voß <voss@gbv.de>
+
+=head1 DESIGNER
+
+mst - Matt S. Trout <mst@shadowcat.co.uk>
=cut
projects / p5sagit/Log-Contextual.git / blobdiff