log::log4perl::appender::socket(3) [suse man page]

Appender::Socket(3)					User Contributed Perl Documentation				       Appender::Socket(3)

NAME

       Log::Log4perl::Appender::Socket - Log to a socket

SYNOPSIS

	   use Log::Log4perl::Appender::Socket;

	   my $appender = Log::Log4perl::Appender::Socket->new(
	     PeerAddr => "server.foo.com",
	     PeerPort => 1234,
	   );

	   $appender->log(message => "Log me
");

DESCRIPTION

       This is a simple appender for writing to a socket. It relies on IO::Socket::INET and offers all parameters this module offers.

       Upon destruction of the object, pending messages will be flushed and the socket will be closed.

       If the appender cannot contact the server during the initialization phase (while running the constructor "new"), it will "die()".

       If the appender fails to log a message because the socket's "send()" method fails (most likely because the server went down), it will try
       to reconnect once. If it succeeds, the message will be sent.  If the reconnect fails, a warning is sent to STDERR and the "log()" method
       returns, discarding the message.

       If the option "silent_recovery" is given to the constructor and set to a true value, the behaviour is different: If the socket connection
       can't be established at initialization time, a single warning is issued.  Every log attempt will then try to establish the connection and
       discard the message silently if it fails.  If you don't even want the warning, set the "no_warning" option to a true value.

       Connecting at initialization time may not be the best option when running under Apache1 Apache2/prefork, because the parent process creates
       the socket and the connections are shared among the forked children--all the children writing to the same socket could intermingle
       messages.  So instead of that, you can use "defer_connection" which will put off making the connection until the first log message is sent.

EXAMPLE

       Write a server quickly using the IO::Socket::INET module:

	   use IO::Socket::INET;

	   my $sock = IO::Socket::INET->new(
	       Listen	 => 5,
	       LocalAddr => 'localhost',
	       LocalPort => 12345,
	       Proto	 => 'tcp');

	   while(my $client = $sock->accept()) {
	       print "Client connected
";
	       while(<$client>) {
		   print "$_
";
	       }
	   }

       Start it and then run the following script as a client:

	   use Log::Log4perl qw(:easy);

	   my $conf = q{
	       log4perl.category		  = WARN, Socket
	       log4perl.appender.Socket 	  = Log::Log4perl::Appender::Socket
	       log4perl.appender.Socket.PeerAddr  = localhost
	       log4perl.appender.Socket.PeerPort  = 12345
	       log4perl.appender.Socket.layout	  = SimpleLayout
	   };

	   Log::Log4perl->init($conf);

	   sleep(2);

	   for(1..10) {
	       ERROR("Quack!");
	       sleep(5);
	   }

COPYRIGHT AND LICENSE

       Copyright 2002-2009 by Mike Schilli <m@perlmeister.com> and Kevin Goess <cpan@goess.org>.

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

perl v5.12.1							    2010-02-07						       Appender::Socket(3)

Appender::Buffer(3pm)					User Contributed Perl Documentation				     Appender::Buffer(3pm)

NAME

	   Log::Log4perl::Appender::Buffer - Buffering Appender

SYNOPSIS

	   use Log::Log4perl qw(:easy);

	   my $conf = qq(
	   log4perl.category		      = DEBUG, Buffer

	       # Regular Screen Appender
	   log4perl.appender.Screen	      = Log::Log4perl::Appender::Screen
	   log4perl.appender.Screen.stdout    = 1
	   log4perl.appender.Screen.layout    = PatternLayout
	   log4perl.appender.Screen.layout.ConversionPattern = %d %p %c %m %n

	       # Buffering appender, using the appender above as outlet
	   log4perl.appender.Buffer		  = Log::Log4perl::Appender::Buffer
	   log4perl.appender.Buffer.appender	  = Screen
	   log4perl.appender.Buffer.trigger_level = ERROR
	   );

	   Log::Log4perl->init($conf);

	   DEBUG("This message gets buffered.");
	   INFO("This message gets buffered also.");

	   # Time passes. Nothing happens. But then ...

	   print "It's GO time!!!
";

	   ERROR("This message triggers a buffer flush.");

DESCRIPTION

       "Log::Log4perl::Appender::Buffer" takes these arguments:

       "appender"
	   Specifies the name of the appender it buffers messages for. The appender specified must be defined somewhere in the configuration file,
	   not necessarily before the definition of "Log::Log4perl::Appender::Buffer".

       "max_messages"
	   Specifies the maximum number of messages the appender will hold in its ring buffer. "max_messages" is optional. By default,
	   "Log::Log4perl::Appender::Buffer" will not limit the number of messages buffered. This might be undesirable in long-running processes
	   accumulating lots of messages before a flush happens. If "max_messages" is set to a numeric value, "Log::Log4perl::Appender::Buffer"
	   will displace old messages in its buffer to make room if the buffer is full.

       "trigger_level"
	   If trigger_level is set to one of Log4perl's levels (see Log::Log4perl::Level), a "trigger" function will be defined internally to
	   flush the buffer if a message with a priority of $level or higher comes along. This is just a convenience function. Defining

	       log4perl.appender.Buffer.trigger_level = ERROR

	   is equivalent to creating a trigger function like

	       log4perl.appender.Buffer.trigger = sub {   
		   my($self, $params) = @_;		  
		   return $params->{log4p_level} >=	  
			  $Log::Log4perl::Level::ERROR; }

	   See the next section for defining generic trigger functions.

       "trigger"
	   "trigger" holds a reference to a subroutine, which "Log::Log4perl::Appender::Buffer" will call on every incoming message with the same
	   parameters as the appender's "log()" method:

		   my($self, $params) = @_;

	   $params references a hash containing the message priority (key "l4p_level"), the message category (key "l4p_category") and the content
	   of the message (key "message").

	   If the subroutine returns 1, it will trigger a flush of buffered messages.

	   Shortcut

DEVELOPMENT NOTES

       "Log::Log4perl::Appender::Buffer" is a composite appender.  Unlike other appenders, it doesn't log any messages, it just passes them on to
       its attached sub-appender.  For this reason, it doesn't need a layout (contrary to regular appenders).  If it defines none, messages are
       passed on unaltered.

       Custom filters are also applied to the composite appender only.	They are not applied to the sub-appender. Same applies to appender
       thresholds. This behaviour might change in the future.

COPYRIGHT AND LICENSE

       Copyright 2002-2009 by Mike Schilli <m@perlmeister.com> and Kevin Goess <cpan@goess.org>.

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

perl v5.10.1							    2010-07-21						     Appender::Buffer(3pm)