Changeset 275 for LATMOS-Accounts/lib

Timestamp:

07/26/09 02:28:51 (15 years ago)

Author:

nanardon

Message:

• fix ident name in syslog
• provide a basic documentation

File:

• LATMOS-Accounts/lib/LATMOS/Accounts/Log.pm (modified) (5 diffs)

LATMOS-Accounts/lib/LATMOS/Accounts/Log.pm

@@ -5 +5 @@
 use Sys::Syslog qw(:standard :macros);
 use Exporter ();
-use vars qw(@EXPORT_OK @EXPORT @ISA);
-@ISA = qw(Exporter);
-@EXPORT = qw(
-    la_set_log la_log
+
+=head1 NAME
+
+LATMOS::Accounts::Log - Log dispatcher for LATMOS::Accounts
+
+=head1 SYNOPSYS
+
+    use LATMOS::Accounts::Log
+    la_log(LA_ERR, "An error has occur");
+
+=head1 DESCRIPTION
+
+This module provide facilities to log to both console, syslog or using callback.
+
+When the environement variable C<LA_DEBUG> is set, all message are print to
+C<stderr>.
+
+=cut
+
+our @loglevels = qw(
     LA_EMERG
     LA_ALERT
@@ -20 +36 @@
     LA_DEBUG
 );
+
+use vars qw(@EXPORT_OK @EXPORT %EXPORT_TAGS @ISA);
+@ISA = qw(Exporter);
+@EXPORT = (qw(
+    la_set_log la_log
+    ), @loglevels);
+
 @EXPORT_OK = @EXPORT;
+%EXPORT_TAGS = (LOGLEVELS => [ @loglevels ]);
 
 our $VERSION = (q$Rev$ =~ /^Rev: (\d+) /)[0];
 
+=head1 LOG LEVEL
+
+=over 4
+
+=item LA_EMERG
+
+=cut
+
 sub LA_EMERG { LOG_EMERG } # system is unusable
+
+=item LA_ALERT
+
+=cut
 
 sub LA_ALERT { LOG_ALERT } # action must be taken immediately
 
+=item LA_CRIT
+
+=cut
 sub LA_CRIT { LOG_CRIT } # critical conditions
+
+=item LA_ERR
+=item LA_ERROR
+
+=cut
 
 sub LA_ERR   { LOG_ERR } # error conditions
 sub LA_ERROR { LA_ERR } # Alias for ERR
 
+=item LA_WARN
+=item LA_WARNING
+
+=cut
+
 sub LA_WARNING { LOG_WARNING } # warning conditions
 sub LA_WARN    { LA_WARNING } # warning conditions
 
+=item LA_NOTICE
+
+=cut
+
 sub LA_NOTICE { LOG_NOTICE } # normal, but significant, condition
+
+=item LA_INFO
+
+=cut
 
 sub LA_INFO { LOG_INFO } # informational message
 
+=item LA_DEBUG
+
+=cut
+
 sub LA_DEBUG { LOG_DEBUG } # debug-level message
+
+=back
+
+=cut
 
 my %log_method = (
@@ -48 +113 @@
 );
 
+=head1 FUNCTIONS
+
+=head2 la_set_log(%options)
+
+Set options to log dispatcher:
+
+=over 4
+
+=item syslog
+
+=item console
+
+=item callback
+
+=back
+
+=cut
+
 sub la_set_log {
     my (%options) = @_;
@@ -54 +137 @@
             if ($val) {
                 my ($ident, $logopt, $facility) =  @{ ref $val ? $val : [] };
-                $ident ||= $$;
+                $ident ||= 'LA';
                 $logopt ||= 'pid';
                 $facility ||= 'LOG_USER';
@@ -66 +149 @@
     1;
 }
+
+=head2 la_log($level, @sprintf_args)
+
+=cut
 
 sub la_log {