Log4perl

Ce document est un résumé des spécifications de log4perl. C'est un « document vivant », soutenu au fur et à mesure que de nouvelles versions de log4perl voient le jour.

Bien que nous sachions qu'elles seront légèrement dépassées au moment où vous lirez ce document, nous avons inclus ces spécifications de développement car il s'agit d'une source de référence et que nous pensons que ce document serait incomplet sans elles. vous pouvez consulter la documentation en ligne de la version de log4perl que vous avez installée.

 # Easy mode : simple ...
 use Log::Log4perl qw(:easy);
 Log::Log4perl->easy_init($ERROR);
 DEBUG "This doesn't go anywhere";
 ERROR "This gets logged";
 # ... or standard mode for more features:
 Log::Log4perl::init('/etc/log4perl.conf');
  --or--
 # Check config every 10 secs
 Log::Log4perl::init_and_watch('/etc/log4perl.conf',10);
 --then--
 $logger =Log::Log4perl->get_logger('house.bedrm.desk.topdrwr');
 $logger->debug('debug message');
 $logger->info('info message');
 $logger->warn('etc');
 $logger->error('..');
 $logger->fatal('..');

 #####/etc/log4perl.conf###############################
 log4perl.logger.house = WARN,  FileAppndr1
 log4perl.logger.house.bedroom.desk = DEBUG, FileAppndr1
 log4perl.appender.FileAppndr1 = Log::Log4perl::Appender::File
 log4perl.appender.FileAppndr1.filename = desk.log 
 log4perl.appender.FileAppndr1.layout = Log::Log4perl::Layout::SimpleLayout

######################################################
=head1 ABSTRACT
Log::Log4perl provides a powerful logging API for your application

Si vous avez des questions sur Log4perl, vous pouvez obtenir de l'aide sur la liste de diffusion log4perl-devel@lists.sourceforge.net .

Il est également judicieux de consulter la page de documentation de Log4perl à : http://log4perl.sourceforge.net/releases/Log-Log4perl/docs/html/Log/Log4perl.html Avant de poser une question, quelle qu'elle soit, relisez ce document, consultez les archives et lisez la FAQ de Log4perl.

Les conventions suivantes s'appliquent à ce document : $log Objet descripteur du logger.

Le niveau de journalisation ou de priorité d'un message se base d'une entité représentant l'importance du message à journaliser, elle est représentée par la classe org.apache.log4j.Level. Un message n'est journalisé que si sa priorité est supérieure ou égale à la priorité du Logger effectuant la journalisation. Log4j définit 5 niveaux de logging présentés ici par gravité décroissante.

FATAL

Utilisé pour journaliser une erreur grave pouvant mener à l'arrêt prématuré de l'application.

ERROR

Utilisé pour journaliser une erreur qui n'empêche cependant pas l'application de fonctionner.

WARN

Utilisé pour journaliser un avertissement, il peut s'agir par exemple d'une incohérence dans la configuration, l'application peut continuer à fonctionner mais pas forcément de la façon attendue.

INFO

Utilisé pour journaliser des messages à caractère informatif (nom des fichiers, etc.).

DEBUG

Utilisé pour générer des messages pouvant être utiles au débogage.

Si vous configurez un système de journalisation avec un niveau warning alors tous les messages journalisés avec info() et debug() seront ignorés alors que fatal(), error() et warn() vont passer car leur priorité est supérieure ou égale au niveau configuré

Voir aussi syslog#Niveau de gravité.

Afin de mieux les manipuler, il est nécessaire de connaître le fonctionnement des Appenders et de configurer correctement Log4perl. Log::Log4perl ne définit aucun Appender par défaut. Les Appenders sont le moyen utilisé par log4perl pour enregistrer les événements de journalisation. Chaque Appender a une façon spécifique d'enregistrer ces événements. Les paramètres nécessaires à certains des Appenders sont détaillés dans la partie configuration. Cependant, il est possible d'affecter un niveau seuil (threshold) à tous les Appenders (ce qui est le cas de tous les Appenders fournis avec log4perl). Dans ce cas, un message n'est journalisé par un Appender donné que si son niveau est supérieur ou égal à celui du Logger et qu'il est supérieur ou égal au seuil de l'Appender considéré.

use Log::Log4perl;
# Configuration 
 my $conf = q(
  log4perl.category.Toto.Test        = INFO, Logfile, Screen
  log4perl.appender.Logfile          = Log::Log4perl::Appender::File
  log4perl.appender.Logfile.filename = test.log
  log4perl.appender.Logfile.layout   = Log::Log4perl::Layout::PatternLayout
  log4perl.appender.Logfile.layout.ConversionPattern = [%r] %F %L %m%n
  log4perl.appender.Screen         = Log::Log4perl::Appender::Screen
  log4perl.appender.Screen.stderr  = 0
  log4perl.appender.Screen.layout = Log::Log4perl::Layout::SimpleLayout
 );

# Initialisation du Logger en passant la référence  
 Log::Log4perl::init( \$conf);

Lorsque les messages de journalisation sont récupérés par l’Appender dans le système de journalisation. Un format de présentation des messages est défini, on y trouve des données intéressantes comme la date, l’heure, le pid du processus niveau du message de log> nom du fichier ...

Comme pour Log4j, Log4perl fournit principalement deux Layouts pour mettre en forme les différents événements de journalisation Log::Log4perl::Layout::SimpleLayout et Log::Log4perl::Layout::PatternLayout

• Log::Log4perl::SimpleLayout : Comme son nom l'indique, il s'agit du Layout le plus simple, les événements journalisés ont le format niveau – message (Retour à la ligne) .
• Log::Log4perl::Layout::PatternLayout : permet de formater les événements d'à peu près n'importe quelle façon, le format du message est spécifié par un motif (pattern) composé de texte et de séquences d'échappement indiquant les informations à afficher.

%c catégorie d’événement de journalisation.
%C Nom complet du package (ou classes) de l’appelant
%d Date courante Format in yyyy/MM/dd hh:mm:ss
%F Fichier où l’événement de journalisation s’est produit
%H Hostname
%l Nom complet de la méthode où l’événement s’est produit, suivi par le nom du fichier source et le numéro de la ligne entre parenthèses
%L Numéro de la ligne ou fichier source où l’événement s’est produit
%m Message 
%M Méthode (ou fonction) où l’événement s’est produit
%n retour à la ligne
%p Priorité de l’événement
%P pid du processus en cours
%r Nombre de millisecondes écoulées entre le début du programme et jusqu’à la production de l’événement
%x NDC stack 
%X{clé} MDC 
%% signe littéral de pour cent (%) 

Sinon, par défaut, les événements sont journalisés au format message (Retour à la ligne);

• Remarques :
  • Le format de la date peut être spécifique. par exemple %d{HH:mm} permet de n’afficher que les heures et les minutes
  • Même remarque pour les fichiers, par exemple %F {1} permet de n’afficher que le nom de fichier sans le chemin d’accès
  • %c{2} permet de n’afficher que les deux dernières composantes de la catégorie en cours. par exemple si la catégorie est Toto::Tata::Titi on aura affiché Tata::Titi

• http://logging.apache.org/log4j/docs/
• http://cpan.uwinnipeg.ca/htdocs/Log-Log4perl/Log/Log4perl.html
• http://cpan.org/