Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::Log(User Contributed Perl DocumentatOpenXPKI::Server::Log(3)

Name
       OpenXPKI::Server::Log - logging implementation for OpenXPKI

Description
       This is the logging layer of OpenXPKI. Mainly we	use Log::Log4perl.
       The important difference	is that	we replace the original	DBI appender
       with our	own appender which can handle some funny details of some
       special databases. Additionally our log function	do some	special	things
       to meet our requirements.

Functions
   Constructor
       The constructor only accepts the	named parameter	"CONFIG" which can
       either be

       o   a path to the Log::Log4perl configuration file,

       o   a reference to a scalar holding the Log4perl	configuration string
	   or

       o   undef to either use an already initialized Log4perl or create a
	   screen only logger using "easy_init"	in Log::Log4perl

   audit
       Returns the audit logger	of the given subcategory
       openxpki.audit.$subcat.

       Positional parameters:

       o   $subcat sub category	- optional, default: system

   log DEPRECATED
       This is the old method used in pre 1.18 and shouldnt be used any
       longer!	Each call triggers a deprecation warning with facility
       "openxpki.deprecated"

       This function creates a new log message it accept the following
       parameters:

       o   PRIORITY (debug, info, warn,	error, fatal)

       o   FACILITY (auth, audit, monitor, system, workflow)

	   It is possible to specify more than one facility by passing an
	   array reference here.

       o   MESSAGE (normal text	string)

       o   MODULE (overwrites the internally determined	caller)	- optional

       o   FILENAME (overwrites	the internally determined caller) - optional

       o   LINE	(overwrites the	internally determined caller - optional)

       Default is "system.fatal: [OpenXPKI] undefined message".

   debug
       Shortcut	method that logs a message with	"PRIORITY => "debug"".

       Positional parameters:

       o   $message log	message

       o   $facility the logging facility - optional, default: "system"

   info
       Shortcut	method that logs a message with	"PRIORITY => "info"". Similar
       to "debug".

   warn
       Shortcut	method that logs a message with	"PRIORITY => "warn"". Similar
       to "debug".

   error
       Shortcut	method that logs a message with	"PRIORITY => "error"". Similar
       to "debug".

   fatal
       Shortcut	method that logs a message with	"PRIORITY => "fatal"". Similar
       to "debug".

perl v5.32.0			  2020-08-29	      OpenXPKI::Server::Log(3)

Name | Description | Functions

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::Log&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help