Log::Contextual::WarnLogger - Simple logger for libraries using Log::Contextual
package My::Package; use Log::Contextual::WarnLogger; use Log::Contextual qw( :log ), -default_logger => Log::Contextual::WarnLogger->new({ env_prefix => 'MY_PACKAGE' }); # warns '[info] program started' if $ENV{MY_PACKAGE_TRACE} is set log_info { 'program started' }; # no-op because info is not in levels sub foo { # warns '[debug] entered foo' if $ENV{MY_PACKAGE_DEBUG} is set log_debug { 'entered foo' }; ... }
This module is a simple logger made for libraries using Log::Contextual. We recommend the use of this logger as your default logger as it is simple and useful for most users, yet users can use "set_logger" in Log::Contextual to override your choice of logger in their own code thanks to the way Log::Contextual works.
Arguments: Dict[ env_prefix => Str ] $conf
Dict[ env_prefix => Str ] $conf
my $l = Log::Contextual::WarnLogger->new({ env_prefix });
Creates a new logger object where env_prefix defines what the prefix is for the environment variables that will be checked for the six log levels. For example, if env_prefix is set to FREWS_PACKAGE the following environment variables will be used:
env_prefix
FREWS_PACKAGE
FREWS_PACKAGE_TRACE FREWS_PACKAGE_DEBUG FREWS_PACKAGE_INFO FREWS_PACKAGE_WARN FREWS_PACKAGE_ERROR FREWS_PACKAGE_FATAL
Arguments: @anything
@anything
All of the following six methods work the same. The basic pattern is:
sub $level { my $self = shift; warn "[$level] " . join qq{\n}, @_; if $self->is_$level; }
$l->trace( 'entered method foo with args ' join q{,}, @args );
$l->debug( 'entered method foo' );
$l->info( 'started process foo' );
$l->warn( 'possible misconfiguration at line 10' );
$l->error( 'non-numeric user input!' );
$l->fatal( '1 is never equal to 0!' );
All of the following six functions just return true if their respective environment variable is enabled.
say 'tracing' if $l->is_trace;
say 'debuging' if $l->is_debug;
say q{info'ing} if $l->is_info;
say 'warning' if $l->is_warn;
say 'erroring' if $l->is_error;
say q{fatal'ing} if $l->is_fatal;
See "AUTHOR" in Log::Contextual
See "COPYRIGHT" in Log::Contextual
See "LICENSE" in Log::Contextual
To install Log::Contextual, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Log::Contextual
CPAN shell
perl -MCPAN -e shell install Log::Contextual
For more information on module installation, please visit the detailed CPAN module installation guide.