Log::Log4perl::Appender::Screen - Log to STDOUT/STDERR


Log-Log4perl documentation Contained in the Log-Log4perl distribution.

Index


Code Index:

NAME

Top

Log::Log4perl::Appender::Screen - Log to STDOUT/STDERR

SYNOPSIS

Top

    use Log::Log4perl::Appender::Screen;

    my $app = Log::Log4perl::Appender::Screen->new(
      stderr    => 0,
      utf8      => 1,
    );

    $file->log(message => "Log me\n");

DESCRIPTION

Top

This is a simple appender for writing to STDOUT or STDERR.

The constructor new() take an optional parameter stderr, if set to a true value, the appender will log to STDERR. The default setting for stderr is 1, so messages will be logged to STDERR by default.

If stderr is set to a false value, it will log to STDOUT (or, more accurately, whichever file handle is selected via select(), STDOUT by default).

Design and implementation of this module has been greatly inspired by Dave Rolsky's Log::Dispatch appender framework.

To enable printing wide utf8 characters, set the utf8 option to a true value:

    my $app = Log::Log4perl::Appender::Screen->new(
      stderr    => 1,
      utf8      => 1,
    );

This will issue the necessary binmode command to the selected output channel (stderr/stdout).

COPYRIGHT AND LICENSE

Top


Log-Log4perl documentation Contained in the Log-Log4perl distribution.

##################################################
package Log::Log4perl::Appender::Screen;
##################################################

our @ISA = qw(Log::Log4perl::Appender);

use warnings;
use strict;

##################################################
sub new {
##################################################
    my($class, @options) = @_;

    my $self = {
        name   => "unknown name",
        stderr => 1,
        utf8   => undef,
        @options,
    };

    if( $self->{utf8} ) {
        if( $self->{stderr} ) {
            binmode STDERR, ":utf8";
        } else {
            binmode STDOUT, ":utf8";
        }
    }

    bless $self, $class;
}
    
##################################################
sub log {
##################################################
    my($self, %params) = @_;

    if($self->{stderr}) {
        print STDERR $params{message};
    } else {
        print $params{message};
    }
}

1;

__END__