NAME

Log::Any::Adapter::ScreenColoredLevel - Send logs to screen with colorized messages according to level

VERSION

This document describes version 0.08 of Log::Any::Adapter::ScreenColoredLevel (from Perl distribution Log-Any-Adapter-ScreenColoredLevel), released on 2015-06-18.

SYNOPSIS

 use Log::Any::Adapter;
 Log::Any::Adapter->set('ScreenColoredLevel',
     # min_level => 'debug', # default is 'warning'
     # colors    => { trace => 'bold yellow on_gray', ... }, # customize colors
     # use_color => 1, # force color even when not interactive
     # stderr    => 0, # print to STDOUT instead of STDERR
     # formatter => sub { "LOG: $_[1]" }, # default none
 );

DESCRIPTION

This Log::Any adapter prints log messages to screen (STDERR/STDOUT) colored according to level. It is just like Log::Log4perl::Appender::ScreenColoredLevel, even down to the default colors (with a tiny difference), except that you don't have to use Log::Log4perl. Of course, unlike Log4perl, it only logs to screen and has minimal features.

Parameters:

• min_level => STRING

  Set logging level. Default is warning. If LOG_LEVEL environment variable is set, it will be used instead. If TRACE environment variable is set to true, level will be set to 'trace'. If DEBUG environment variable is set to true, level will be set to 'debug'. If VERBOSE environment variable is set to true, level will be set to 'info'.If QUIET environment variable is set to true, level will be set to 'error'.

• use_color => BOOL

  Whether to use color or not. Default is true only when running interactively (-t STDOUT returns true).

• colors => HASH

  Customize colors. Hash keys are the logging methods, hash values are colors supported by Term::ANSIColor.

  The default colors are:

   method/level                 color
   ------------                 -----
   trace                        yellow
   debug                        (none, terminal default)
   info, notice                 green
   warning                      bold blue
   error                        magenta
   critical, alert, emergency   red

• stderr => BOOL

  Whether to print to STDERR, default is true. If set to 0, will print to STDOUT instead.

• formatter => CODEREF

  Allow formatting message. If defined, message will be passed before being colorized. Coderef will be passed:

   ($self, $message)

  and is expected to return the formatted message.

  The default formatter can optionally prefix the message with extra stuffs, depending on the content of LOG_PREFIX environment variable, such as: elapsed time (e.g. [0.023ms]) if LOG_PREFIX is elapsed.

  NOTE: Log::Any 1.00+ now has a proxy object which allows formatting/customization of message before it is sent to adapter(s), so formatting does not have to be done on a per-adapter basis. As an alternative to this attribute, you can also consider using the proxy object or the (upcoming?) global proxy object.

ENVIRONMENT

LOG_LEVEL, QUIET, VERBOSE, DEBUG, TRACE. These environment variables can set the default for min_level. See documentation about min_level for more details.

LOG_PREFIX. The default formatter groks these variables. See documentation about formatter about more details.

SEE ALSO

Log::Any

Log::Log4perl::Appender::ScreenColoredLevel

Term::ANSIColor

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Log-Any-Adapter-ScreenColoredLevel.

SOURCE

Source repository is at https://github.com/perlancar/perl-Log-Any-Adapter-ScreenColoredLevel.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Log-Any-Adapter-ScreenColoredLevel

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

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