Badger::Log::File

NAME

Top Close Open

Badger::Log::File - writes log messages to a log file

SYNOPSIS

Top Close Open
use Badger::Log::File;

my $log = Badger::Log::File->new({
    filename  => '/var/log/badger.log',
    keep_open => 1,
});

$log->log('a debug message');
$log->info('an info message');
$log->warn('a warning message');
$log->error('an error message');
$log->fatal('a fatal error message');

DESCRIPTION

Top Close Open

This module is a subclass of Badger::Log that implements a simple mechanism for logging messages to a file. It uses Badger::Filesystem for all the underlying file operations.

CONFIGURATION OPTIONS

Top Close Open

The following configuration options are available in addition to those inherited form the Badger::Log base class.

filename

Top Close Open

The name of the log file which you want messages appended to. This parameter is mandatory.

filesystem

Top Close Open

An optional reference to a Badger::Filesystem object, or the name of a filesystem class having a file() method similar to that in Badger::Filesystem. This defaults to the Badger::Filesystem class.

keep_open

Top Close Open

A flag indicating if the log file should be kept open between calls to logging methods. The default value is 0 meaning that the file will be opened for each message and closed again afterwards. Set it to any true value to have the file kept open.

METHODS

Top Close Open

The following methods are implemented in addition to those inherited from Badger::Log and its base classes.

log($level,$message)

Top Close Open

This method redefines the log() method in Badger::Log to write logging messages to the log file.

INTERNAL METHODS

Top Close Open

init(\%config)

Top Close Open

Custom initialiser method which calls the base class init_log() method followed by the init_file() method.

init_file(\%config)

Top Close Open

Custom initialiser method which handles the configuration and initialisation of the file-specific parts of the logger.

acquire()

Top Close Open

This method acquires a file handle (an IO::File object) for the specified filename, opened ready for appending log messages.

release()

Top Close Open

The method releases a previously acquired file handle. i.e. it closes the log file.

AUTHOR

Top Close Open

Andy Wardley http://wardley.org/

COPYRIGHT

Top Close Open

Copyright (C) 2005-2009 Andy Wardley. All Rights Reserved.

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