log::dispatch::file(3pm) [debian man page]

Log::Dispatch::File(3pm)				User Contributed Perl Documentation				  Log::Dispatch::File(3pm)

NAME

       Log::Dispatch::File - Object for logging to files

VERSION

       version 2.32

SYNOPSIS

	 use Log::Dispatch;

	 my $log = Log::Dispatch->new(
	     outputs => [
		 [
		     'File',
		     min_level => 'info',
		     filename  => 'Somefile.log',
		     mode      => '>>',
		     newline   => 1
		 ]
	     ],
	 );

	 $log->emerg("I've fallen and I can't get up");

DESCRIPTION

       This module provides a simple object for logging to files under the Log::Dispatch::* system.

       Note that a newline will not be added automatically at the end of a message by default.	To do that, pass "newline => 1".

CONSTRUCTOR

       The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

       o   filename ($)

	   The filename to be opened for writing.

       o   mode ($)

	   The mode the file should be opened with.  Valid options are 'write', '>', 'append', '>>', or the relevant constants from Fcntl.  The
	   default is 'write'.

       o   binmode ($)

	   A layer name to be passed to binmode, like ":encoding(UTF-8)" or ":raw".

       o   close_after_write ($)

	   Whether or not the file should be closed after each write.  This defaults to false.

	   If this is true, then the mode will aways be append, so that the file is not re-written for each new message.

       o   autoflush ($)

	   Whether or not the file should be autoflushed.  This defaults to true.

       o   permissions ($)

	   If the file does not already exist, the permissions that it should be created with.	Optional.  The argument passed must be a valid
	   octal value, such as 0600 or the constants available from Fcntl, like S_IRUSR|S_IWUSR.

	   See "chmod" in perlfunc for more on potential traps when passing octal values around.  Most importantly, remember that if you pass a
	   string that looks like an octal value, like this:

	    my $mode = '0644';

	   Then the resulting file will end up with permissions like this:

	    --w----r-T

	   which is probably not what you want.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2011 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-05-25						  Log::Dispatch::File(3pm)

Check Out this Related Man Page

Log::Dispatch::Email(3pm)				User Contributed Perl Documentation				 Log::Dispatch::Email(3pm)

NAME

       Log::Dispatch::Email - Base class for objects that send log messages via email

VERSION

       version 2.32

SYNOPSIS

	 package Log::Dispatch::Email::MySender;

	 use Log::Dispatch::Email;
	 use base qw( Log::Dispatch::Email );

	 sub send_email {
	     my $self = shift;
	     my %p    = @_;

	     # Send email somehow.  Message is in $p{message}
	 }

DESCRIPTION

       This module should be used as a base class to implement Log::Dispatch::* objects that send their log messages via email.  Implementing a
       subclass simply requires the code shown in the SYNOPSIS with a real implementation of the "send_email()" method.

CONSTRUCTOR

       The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

       o   subject ($)

	   The subject of the email messages which are sent.  Defaults to "$0: log email"

       o   to ($ or @)

	   Either a string or a list reference of strings containing email addresses.  Required.

       o   from ($)

	   A string containing an email address.  This is optional and may not work with all mail sending methods.

       o   buffered (0 or 1)

	   This determines whether the object sends one email per message it is given or whether it stores them up and sends them all at once.
	   The default is to buffer messages.

METHODS

       o   send_email(%p)

	   This is the method that must be subclassed.	For now the only parameter in the hash is 'message'.

       o   flush

	   If the object is buffered, then this method will call the "send_email()" method to send the contents of the buffer and then clear the
	   buffer.

       o   DESTROY

	   On destruction, the object will call "flush()" to send any pending email.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2011 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-05-25						 Log::Dispatch::Email(3pm)

Linux and UNIX Man Pages

log::dispatch::file(3pm) [debian man page]

Check Out this Related Man Page