Introduction Introduction

Les composants Les composants

Log4j

Les Framework Java

Log4j
1 Introduction

Claude Duvallet 2 Les composants

Universit du Havre
UFR Sciences et Techniques
25 rue Philippe Lebon - BP 540
76058 LE HAVRE CEDEX
Claude.Duvallet@gmail.com
http://litis.univ-lehavre.fr/duvallet/

Claude Duvallet 1/19 Framework Claude Duvallet 2/19 Framework

Introduction Introduction
Les composants Les composants

Log4j : prsentation (1/3) Log4j : prsentation (2/3)

Les bonnes pratiques de dveloppement dconseillent lutilisation

des mthodes System.out.print* et System.err.print*
pour afficher des messages et recommandent plutt lutilisation
dun logger tel Log4J apportant plus de souplesse.
Log4J simplifie les gestions des logs et le dbogage des
applications Java en fournissant des classes et des mthodes
pour lenregistrement de ces informations.
Les fichiers journaux dune application reprsentent la mmoire
dune application, un historique permanent de la vie de celle-ci, il
est donc important de correctement enregistrer ces messages.
Le dveloppeur prfrera envoyer le message quil souhaite
afficher ou enregistrer au logger en lui assignant un certain
niveau de criticit (DEBUG, INFO, WARNING, ERROR,
CRITICAL).
On indiquera aussi la classe/la mthode lorigine de ce
message, la ligne dans le code source, ou toute autre information
utile.
On peut facilement demander une application dafficher tous les
messages de niveau DEBUG et suprieur lcran lors de la
phase de dveloppement.
Puis on peut lui demander de nafficher que les messages de
niveau WARNING et suprieur dans un fichier de log en phase
de production.
Ces diffrents types daffichage des messages peuvent tre
configurs facilement au runtime de log4j par fichier XML ou par
fichier de proprits, donc de faon totalement externe au code.

Claude Duvallet 3/19 Framework Claude Duvallet 4/19 Framework

 Introduction Introduction
Les composants Les composants

Log4j : prsentation (3/3) Le framework Log4j : origines

Log4J est constitu de 3 composants principaux qui permettent

de configurer le dispositif de journalisation :
les Loggers pour crire les messages,
les Appenders pour slectionner la destination des messages
et les Layouts pour la mise en forme des messages.
Log4J permet donc non seulement de gagner en flexibilit sur la
gestion des messages dune application mais galement de
faciliter la recherche et la dtection derreurs.
Cest une partie du projet Jakarta, sous-projet dApache.
Il est distribu en Open Source sous Licence BSD.
Les premires versions sont apparue en 1996.
La documentation officielle est disponible cette adresse :
http://jakarta.apache.org/log4j/docs/index.html.
La version actuelle est 1.2.

Claude Duvallet 5/19 Framework Claude Duvallet 6/19 Framework

Introduction Introduction
Les composants Les composants

La classe Logger Les niveaux de journalisation (1/3)

La notion de niveau de journalisation ou de priorit dun message

Le Logger est lentit de base pour effectuer la journalisation, il reprsente limportance du message journaliser.
est mis en uvre par le biais de la classe Elle est reprsente par la classe org.apache.log4j.Level.
org.apache.log4j.Logger. Un message nest journalis que si sa priorit est suprieure ou
Lobtention dune instance de Logger se fait en appelant la gale la priorit du Logger effectuant la journalisation.
mthode statique Logger.getLogger : LAPI Log4j dfinit 5 niveaux de logging prsents ici par gravit
import org.apache.log4j.Logger; dcroissante :
public class MaClasse {
private static final Logger logger = Logger.getLogger(MaClasse.class); FATAL : journaliser une erreur grave pouvant mener larrt
// suite
} prmatur de lapplication.
ERROR : journaliser une erreur qui nempche cependant pas
Il est possible de donner un nom arbitraire au Logger. lapplication de fonctionner.
Cependant, il est prfrable dutiliser le nom de la classe pour WARN : journaliser un avertissement, il peut sagir par exemple
dune incohrence dans la configuration.
des raisons de facilit.
INFO : journaliser des messages caractre informatif.
DEBUG : gnrer des messages pouvant tre utiles au dbogage.

Claude Duvallet 7/19 Framework Claude Duvallet 8/19 Framework

 Introduction
Les composants
Les niveaux de journalisation (2/3)
Deux niveaux particuliers, OFF et ALL sont utiliss des fins de
configuration.
La version 1.3 introduira le niveau TRACE qui reprsente le
niveau le plus fin (utilis par exemple pour journaliser lentre ou
la sortie dune mthode).
Plus on descend dans les niveaux, plus les messages sont
nombreux.
Si vous avez besoin de niveaux supplmentaires, vous pouvez
crer les vtres en sous-classant org.apache.log4j.Level.
La journalisation dun message un niveau donn se fait au
moyen de la mthode log(Priority, String).
Il existe diverses variantes permettant par exemple de passer un
Throwable dont la trace sera enregistre.
Claude Duvallet 9/19 Framework
Introduction
Les composants
Linterface Appender (1/3)
Bien que vous ne devriez pas avoir manipuler les Appenders
directement en Java, il est ncessaire de connatre leur
fonctionnement afin de configurer correctement Log4j.
Les Appenders, reprsents par linterface
org.apache.log4j.Appender, sont le moyen utilis par log4j
pour enregistrer les vnements de journalisation.
Chaque Appender a une faon spcifique denregistrer ces
vnements.
Log4j vient avec une srie dAppenders quil est utile de dcrire,
puisquils seront repris dans la configuration :
org.apache.log4j.jdbc.JDBCAppender : Effectue la
journalisation vers une base de donnes ;
org.apache.log4j.net.JMSAppender : Utilise JMS pour
journaliser les vnements ;
org.apache.log4j.nt.NTEventLogAppender : Journalise via
le journal des vnements de Windows (NT/2000/XP) ;
Claude Duvallet 11/19 Framework
Introduction
Les composants
Les niveaux de journalisation (3/3)
Pour les niveaux de base, des mthodes de raccourcis sont
fournies, elle portent le nom du niveau :
try {
// quivaut logger.info("Message dinformation");
logger.log(Level.INFO, "Message dinformation");
// Code pouvant soulever une Exception
//...
} catch(UneException e) {
// quivaut logger.log(Level.FATAL, "Une exception est survenue", e);
logger.fatal("Une exception est survenue", e);
}
Il est possible deffectuer une journalisation avec des messages
localiss au moyen des mthodes l7dlog(Priority, String
cle, [Object[], ] Throwable).
cle correspond lidentifiant du message dans le
ResourceBundle positionn via la mthode
setResourceBundle.
Notez que pour ces mthodes, il nexiste pas de raccourci.
Claude Duvallet 10/19 Framework
Introduction
Les composants
Linterface Appender (2/3)
Suite des Appenders :
org.apache.log4j.lf5.LF5Appender : Journalise les
vnements vers une console base sur Swing, celle-ci permet
de trier ou de filtrer les vnements ;
org.apache.log4j.varia.NullAppender : Neffectue aucune
journalisation ;
org.apache.log4j.net.SMTPAppender : Envoie un email
lorsque certains vnements surviennent ( ne pas activer avec
un niveau de journalisation DEBUG...) ;
org.apache.log4j.net.SocketAppender : Envoie les
vnements de journalisation vers un serveur de journalisation ;
org.apache.log4j.net.SyslogAppender : Journalise les
vnements vers un daemon Syslog (distant ou non) ;
org.apache.log4j.net.TelnetAppender : Journalise les
vnements vers un socket auquel on peut se connecter via
telnet ;
Claude Duvallet 12/19 Framework
 Introduction
Les composants
Linterface Appender (3/3)
Fin des Appenders :
org.apache.log4j.ConsoleAppender : Effectue la
journalisation vers la console ;
org.apache.log4j.FileAppender : Journalise dans un fichier ;
org.apache.log4j.DailyRollingFileAppender : Journalise
dans un fichier qui tourne rgulirement (contrairement ce que
son nom suggre, ce nest pas forcment tous les jours) ;
org.apache.log4j.RollingFileAppender : Journalise dans
un fichier, celui-ci est renomm lorsquil atteint une certaine taille
et la journalisation reprend dans un nouveau fichier.
Les paramtres ncessaires certains de ces Appenders sont
dtaills dans la partie configuration.
Notez cependant quil est possible daffecter un niveau seuil
(threshold) tous les Appenders tendant la classe
org.apache.log4j.AppenderSkeleton.
Claude Duvallet 13/19 Framework
Introduction
Les composants
Cibles des messages (2/3)
En affectant par exemple une cible console au logger racine et
une cible fichier au logger org.test aura les consquences
suivantes :
les messages du logger org seront affichs en console.
et les messages de org.progx (et de tous ses enfants) seront
affichs en console et enregistrs dans un fichier.
Vous pouvez nanmoins prvenir ce fonctionnement en
excutant setAdditivity(false) sur le logger concern.
Attention, toutefois car ceci brisera la chane de dlgation des
appenders :
Logger.getRootLogger().addAppender(new ConsoleAppender());
Logger log1 = Logger.getLogger("org");
log1.setAdditivity(false);
log1.addAppender(new FileAppender(new SimpleLayout(), "test.log"));
Logger log2 = Logger.getLogger("org.test");
Claude Duvallet 15/19 Framework
Introduction
Les composants
Cibles des messages (1/3)
Un appender reprsente donc la cible dun message, cest--dire
lendroit o celui-ci sera physiquement affich ou stock.
log4j vous propose ainsi des appenders pour la console, les
fichiers, les sockets, le gestionnaire dvnements Windows NT,
le dmon Unix syslog ou encore les composants graphiques.
Chaque logger dispose de la mthode addAppender()
permettant de lui affecter une nouvelle cible.
La hirarchie des loggers joue un rle trs important.
En effet, chaque message de journalisation sera transmis aux
cibles du logger courant ainsi quaux cibles de tous ses parents.
Claude Duvallet 14/19 Framework
Introduction
Les composants
Cibles des messages (3/3)
Dans lexemple prcdent, les loggers org et org.test utilisent
une cible de type fichier.
Aucun dentre eux ne pourra bnficier de la cible console
affecte la racine.
Et si les diffrentes cibles offertes par log4j ne vous suffisent pas,
vous pourrez en crer de nouvelles trs facilement.
Pouvoir personnaliser la destination des messages ne donne
absolument aucune indication sur leur format.
Claude Duvallet 16/19 Framework
 Introduction Introduction
Les composants Les composants

Les Layouts Les Layouts

Les Layouts fournis par log4j sont les suivants, lexistance du
Les Layouts sont utiliss pour mettre en forme les diffrents
vnements de journalisation avant quils ne soient enregistrs.
Ils sont utiliss en conjugaison avec les Appenders.
Bien que tous les Appenders acceptent un Layout, ils ne sont pas
forcs de lutiliser (les Appenders utilisant un Layout sont
reprables au fait que leur mthode requiresLayout renvoie true).
PatternLayout permet de formatter les vnements d peu prs
nimporte quelle faon :
org.apache.log4j.SimpleLayout : Comme son nom lindique, il
sagit du Layoutle plus simple, les vnements journaliss ont le
format Niveau - Message[Retour la ligne] ;
org.apache.log4j.PatternLayout : Layout le plus flexible, le format
du message est spcifi par un motif (pattern) compos de texte
et de squences dchappement indiquant les informations
afficher.
org.apache.log4j.XMLLayout : Comme son nom lindique, formate
les donnes de lvnement de journalisation en XML ( utiliser en
conjugaison avec un Appender de la famille des FileAppenders) ;
org.apache.log4j.HTMLLayout : Les vnements sont journaliss
au format HTML. Chaque nouvelle session de journalisation
(rinitialisation de Log4j) donne lieu un document HTML
complet (ie. prambule DOCTYPE, <html>, etc).

Claude Duvallet 17/19 Framework Claude Duvallet 18/19 Framework

Introduction
Les composants

Format des messages

Le plus intressant est indubitablement PatternLayout dont la

souplesse saura combler toutes vos exigences :
Logger log = Logger.getLogger("org.test");
PatternLayout layout = new PatternLayout("\%d \%-5p \%c - \%F:\%L - \%m\%n");
ConsoleAppender stdout = new ConsoleAppender(layout);
log.addAppender(stdout);
Le format dfini dans cet exemple affiche lheure et la date, le
niveau derreur (align gauche), le nom du logger, le nom du
fichier, le numro de la ligne de code correspondante et enfin le
message lui-mme.
Le rsultat apparatra ainsi dans votre console :
2003-44-29 04:44:32,211 DEBUG org.test - exemple3.java:18 - Starting
2003-44-29 04:44:32,221 DEBUG org.test - exemple3.java:20 - Exiting

Claude Duvallet 19/19 Framework