svk::logger(3) [osx man page]

SVK::Logger(3)						User Contributed Perl Documentation					    SVK::Logger(3)

NAME

       SVK::Logger - logging framework for SVK

SYNOPSIS

	 use SVK::Logger;

	 $logger->warn('foo');
	 $logger->info('bar');

       or

	 use SVK::Logger '$foo';

	 $foo->error('bad thingimajig');

       DESCRIPTION

       SVK::Logger is a wrapper around Log::Log4perl. When using the module, it imports into your namespace a variable called $logger (or you can
       pass a variable name to import to decide what the variable should be) with a category based on the name of the calling module.

MOTIVATION

       Ideally, for support requests, if something is not going the way it should be we should be able to tell people: "rerun the command with the
       SVKLOGLEVEL environment variable set to DEBUG and mail the output to $SUPPORTADDRESS". On Unix, this could be accomplished in one command
       like so:

	 env SVKLOGLEVEL=DEBUG svk <command that failed> 2>&1 | mail $SUPPORTADDRESS

perl v5.10.0							    2008-08-04							    SVK::Logger(3)

Courier::Filter::Logger::File(3pm)			User Contributed Perl Documentation			Courier::Filter::Logger::File(3pm)

NAME

       Courier::Filter::Logger::File - File logger for the Courier::Filter framework

SYNOPSIS

	   use Courier::Filter::Logger::File;

	   my $logger = Courier::Filter::Logger::File->new(
	       file_name => $file_name
	   );

	   # For use in an individual filter module:
	   my $module = Courier::Filter::Module::My->new(
	       ...
	       logger => $logger,
	       ...
	   );

	   # For use as a global Courier::Filter logger object:
	   my $filter = Courier::Filter->new(
	       ...
	       logger => $logger,
	       ...
	   );

DESCRIPTION

       This class is a file logger class for use with Courier::Filter and its filter modules.  It is derived from
       Courier::Filter::Logger::IOHandle.

   Constructor
       The following constructor is provided:

       new(%options): returns Courier::Filter::Logger::File; throws Courier::Error
	   Creates a new logger that logs messages as lines to a file.	Opens the file for writing, creating it if necessary.

	   %options is a list of key/value pairs representing any of the following options:

	   file_name
	       Required.  The name of the file to which log messages should be written.

	   timestamp
	       A boolean value controlling whether every log message line should be prefixed with a timestamp (in local time, in ISO format).
	       Defaults to false.

   Instance methods
       The following instance methods are provided, as inherited from Courier::Filter::Logger::IOHandle:

       log_error($text): throws Perl exceptions
	   Logs the error message given as $text (a string which may contain newlines).  Prefixes each line with a timestamp if the "timestamp"
	   option has been set through the constructor.

       log_rejected_message($message, $reason): throws Perl exceptions
	   Logs the Courier::Message given as $message as having been rejected due to $reason (a string which may contain newlines).

SEE ALSO

       Courier::Filter::Logger::IOHandle, Courier::Filter::Logger, Courier::Filter::Overview.

       For AVAILABILITY, SUPPORT, and LICENSE information, see Courier::Filter::Overview.

AUTHOR

       Julian Mehnle <julian@mehnle.net>

perl v5.14.2							    2011-12-27					Courier::Filter::Logger::File(3pm)