POE::Component::Log4perl.3pm

Langue: en

Version: 2009-10-04 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

POE::Component::Log4perl - Perl extension for the POE Environemt

SYNOPSIS

   use POE::Component::Log4perl;
 
   POE::Component::Log4perl->spawn(
      Alias => 'logger',
      Category => 'default',
      ConfigFile => 'logging.conf',
      GetLogfile => \&get_logfile,
   );
 
 

DESCRIPTION

Well, just what everybody needs, another logging module for the POE environment. This one will encapsulate the Log4perl modules to do the logging.

This modules understands the following parameters:

  Alias      - The alias for the session
  Category   - The category to use from the configuration file
  ConfigFile - The name of the configuration file
  GetLogfile - This points to a function to return the logfile name
 
 

A word about the ``GetLogfile'' parameter. In my environment, I use a single centralized configuration file to handle the logging environment. This makes management a bit easier. Log4perl allows this to happen by using a callback to your main routine to retrieve the filename. The GetLogfile allows you to name the function to handle that task. The function name should match the one in the configuration file. If you don't use this ability then you can safely ignore this parameter.

EVENTS

info
This event will insert an ``INFO'' line into your logfile.
Example
  $poe_kernel->post('logger' => info => 'my cool message');
 
 
warn
This event will insert a ``WARN'' line into your logfile.
error
This event will insert an ``ERROR'' line into your logfile.
fatal
This event will insert a ``FATAL'' line into your logfile.
Example
  $poe_kernel->post('logger' => fatal => 'bad mojo');
  $poe_kernel->yield('shutdown');
 
 
debug
This event will insert a ``DEBUG'' line into your logfile.

SEE ALSO

  Log::Log4perl
  POE::Component::Logger
  POE::Component::SimpleLogger
 
 

AUTHOR

Kevin L. Esteb, <kesteb@wsipc.org> Copyright (C) 2007 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.