mail::spamassassin::logger(3pm) [debian man page]

Mail::SpamAssassin::Logger(3pm) 			User Contributed Perl Documentation			   Mail::SpamAssassin::Logger(3pm)

NAME

       Mail::SpamAssassin::Logger - SpamAssassin logging module

SYNOPSIS

	 use Mail::SpamAssassin::Logger;

	 $SIG{__WARN__} = sub {
	   log_message("warn", $_[0]);
	 };

	 $SIG{__DIE__} = sub {
	   log_message("error", $_[0]) if $_[0] !~ /in eval/;
	 };

METHODS

       add_facilities(facilities)
	   Enable debug logging for specific facilities.  Each facility is the area of code to debug.  Facilities can be specified as a hash
	   reference (the key names are used), an array reference, an array, or a comma-separated scalar string. Facility names are case-
	   sensitive.

	   If "all" is listed, then all debug facilities are implicitly enabled, except for those explicitly disabled.	A facility name may be
	   preceded by a "no" (case-insensitive), which explicitly disables it, overriding the "all".  For example: all,norules,noconfig,nodcc.
	   When facility names are given as an ordered list (array or scalar, not a hash), the last entry applies, e.g. 'nodcc,dcc,dcc,noddc' is
	   equivalent to 'nodcc'.  Note that currently no facility name starts with a "no", it is advised to keep this practice with newly added
	   facility names to make life easier.

	   Higher priority informational messages that are suitable for logging in normal circumstances are available with an area of "info".
	   Some very verbose messages require the facility to be specifically enabled (see "would_log" below).

       log_message($level, @message)
	   Log a message at a specific level.  Levels are specified as strings: "warn", "error", "info", and "dbg".  The first element of the
	   message must be prefixed with a facility name followed directly by a colon.

       dbg("facility: message")
	   This is used for all low priority debugging messages.

       info("facility: message")
	   This is used for informational messages indicating a normal, but significant, condition.  This should be infrequently called.  These
	   messages are typically logged when SpamAssassin is run as a daemon.

       add(method => 'syslog', socket => $socket, facility => $facility)
	   "socket" is the type the syslog ("unix" or "inet").	"facility" is the syslog facility (typically "mail").

       add(method => 'file', filename => $file)
	   "filename" is the name of the log file.

       add(method => 'stderr')
	   No options are needed for stderr logging, just don't close stderr first.

       remove(method)
	   Remove a logging method.  Only the method name needs to be passed as a scalar.

       would_log($level, $facility)
	   Returns 0 if a message at the given level and with the given facility would be logged.  Returns 1 if a message at a given level and
	   facility would be logged normally.  Returns 2 if the facility was specifically enabled.

	   The facility argument is optional.

       close_log()
	   Close all logs.

perl v5.14.2							    2011-06-06					   Mail::SpamAssassin::Logger(3pm)

Logger::Syslog(3pm)					User Contributed Perl Documentation				       Logger::Syslog(3pm)

NAME

       Logger::Syslog -- an intuitive wrapper over Syslog for Perl

DESCRIPTION

       You want to deal with syslog, but you don't want to bother with Sys::Syslog, that module is for you.

       Logger::Syslog takes care of everything regarding the Syslog communication, all you have to do is to use the function you need to send a
       message to syslog.

       Logger::Syslog provides one function per Syslog message level: debug, info, warning, error, notice, critic, alert.

NOTES

       Logger::Syslog is compliant with mod_perl, all you have to do when using it in such an environement is to call logger_init() at the
       beginning of your CGI, that will garantee that everything will run smoothly (otherwise, issues with the syslog socket can happen in
       mod_perl env).

SYNOPSIS

	   use Logger::Syslog;

	   info("Starting at ".localtime());
	   ...
	   if ($error) {
	       error("An error occured!");
	       exit 1;
	   }
	   ...
	   notice("There something to notify");

FUNCTIONS

   logger_init
       Call this to explicitly open a Syslog socket. You can optionaly specify a Syslog facility.

       That function is called when you use the module, if you're not in a mod_perl environement.

       Examples:

	   # open a syslog socket with default facility (user)
	   logger_init();

	   # open a syslog socket on the 'local' facility
	   logger_init('local');

   logger_close
       Call this to close the Syslog socket.

       That function is called automatically when the calling program exits.

   logger_prefix
       That function lets you set a string that will be prefixed to every messages sent to syslog.

       Example:

	   logger_prefix("my program");
	   info("starting");
	   ...
	   info("stopping");

   logger_set_default_facility(facility)
       You can choose which facility to use, the default one is "user".  Use that function if you want to switch smoothly from a facility to
       another.

       That function will close the existing socket and will open a new one with the appropriate facility.

       Example:

	   logger_set_default_facility("cron");

LOGGING

       Logger::Syslog provides one function per Syslog level to let you send messages.	If you want to send a debug message, just use debug(), for
       a warning, use warning() and so on...

       All those function have the same signature : thay take a string as their only argument, which is the message to send to syslog.

       Examples:

	   debug("my program starts at ".localtime());
	   ...
	   warning("some strange stuff occured");
	   ...
	   error("should not go there !");
	   ...
	   notice("Here is my notice");

LICENSE

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

COPYRIGHT

       This program is copyright X 2004-2006 Alexis Sukrieh

AUTHOR

       Alexis Sukrieh <sukria@sukria.net>

       Very first versions were made at Cegetel (2004-2005) ; Thomas Parmelan gave a hand for the mod_perl support.

perl v5.12.4							    2006-11-27						       Logger::Syslog(3pm)