Net::Server::Log::Log::Log4perl

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index

NAME

Net::Server::Log::Log::Log4perl - log via Log4perl

SYNOPSIS

    use base qw(Net::Server::PreFork);

    __PACKAGE__->run(
        log_file => 'Log::Log4perl',
        log4perl_conf => '/path/to/my/log4perl.conf',
        log4perl_logger => 'myapp',
    );

DESCRIPTION

This module provides Log::Log4perl style logging to the Net::Server system.

CONFIGURATION

log_file: To begin using Log::Log4perl logging, simply set the Net::Server log_file configuration parameter to ``Log::Log4perl''.
If the magic name ``Log::Log4perl'' is used, all logging will be directed to the Log4perl system. If used, the "log4perl_conf", "log4perl_poll", "log4perl_logger" may also be defined.
log4perl_conf: Only available if "log_file" is equal to ``Log::Log4perl''. This is the filename of the log4perl configuration file - see Log::Log4perl. If this is not set, will die on startup. If the file is not readable, will die.
log4perl_poll: If set to a value, will initialise with Log::Log4perl::init_and_watch with this polling value. This can also be the string ``HUP'' to re-read the log4perl_conf when a HUP signal is received. If set to 0, no polling is done. See Log::Log4perl for more details.
log4perl_logger: This is the facility name. Defaults to ``Net::Server''.

DEFAULT ARGUMENTS FOR Net::Server

The following arguments are available in the default "Net::Server" or "Net::Server::Single" modules. (Other personalities may use additional parameters and may optionally not use parameters from the base class.)

    Key               Value                    Default

    ## log4perl parameters (if log_file eq Log::Log4perl)
    log4perl_conf     "filename"               will die if not set
    log4perl_poll     number or HUP            0 (no polling)
    log4perl_logger   "name"                   "Net::Server"

METHODS

"initialize": This method is called during the initilize_logging method of Net::Server. It returns a single code ref that will be stored under the log_function property of the Net::Server object. That code ref takes log_level and message as arguments and calls the initialized log4perl system.

LICENCE

Distributed under the same terms as Net::Server