Tutoriel Tomcat N°3 : gestion des logs

Maîtrisez le système de journalisation de Tomcat : JULI (Java Util Logging Interface) , extension spécifique Tomcat de l’API standard java.util.logging incluse dans le jdk. Maîtrisez la lecture du fichier de configuration logging.properties ’global’ de tomcat. Comprenez comment créer un fichier de log logging.properties par application déployée.

Ce tutoriel est un extrait de séances pratiques de la formation TOMCAT dispensée par Objis.

Prérequis

Installation Java Runtime Environment (Jre)
Installation Tomcat 6

Liens utiles

JULI (logs Tomcat - documentation officielle)
LOG4J
SL4J
LOGBACK

Objectifs

Comprendre la gestion native des logs TOMCAT
Comprendre la structure du fichier logging.properties
Créer un fichier de log pour votre application

Programme

Partie 1 : comprendre les logs TOMCAT
Partie 2 : comprendre le fichier logging.properties
Partie 3 : créer un fichier de log spécifique par application

Qui sommes-nous ?

Partie 1 : comprendre la gestion native des logs TOMCAT


tutoriel-tomcat-log-juli-logging-properties

Partie 2 : la structure du fichier logging.properties


logging.properties

2 sections : la partie ’handlers’ et la partie ’loggers’

Section 1 : les handlers

La première partie du fichier logging.properties permet de spécifier les gestionnaires de fichier journaux. Cette partie permet de répondre à la question : OU envoyer les logs ? Vers une console ? vers un fichier ?

— > Les handlers qui écrivent dans un fichier utilisent la classe org.apache.juli.FileHandler
— > Les handlers qui écrivent dans la console utilisent la classe java.util.logging.ConsoleHandler

Nommage des handlers

Pour déclarer un handler, il faut d’abord lui donner un nom. Ce nom doit être composé d’un préfixe construit à partir d’un chiffre et de lettre , comme 1catalina, auquel on ajoute le nom de la classe du Handler, ce qui donne par exemple 1catalina.org.apache.juli.FileHandler

REMARQUE 1 : le début du fichier logging.properties contient la propriété handlers, qui fait référence à tous les gestionnaires de journaux utilisés dans le fichier.

REMARQUE 2 : le début du fichier logging.properties contient la propriété .handlers, qui permet de référencer le gestionnaire principal pour le serveur.

Configuration des handlers

Une fois nommé, les handlers doivent être configurés grace à des attributs. Certains de ces attributs sont communs aux 2 types de handler (fichier/console), d’autre étant spécifiques à chacun.

Les attriibuts communs sont :

— level : niveau de journalisation . Entre SEVERE, CONFIG, INFO, WARN, FINE, FINEST, ALL

— formatter : classe java pour formater le contenu du fichier. Les valeurs possibles sont java.util.logging.SimpleFormater (par défaut) et java.util.logging.XmlFormater pour générer sortie format XML

Les attributs spécifiques à org.apache.juli.FileHandler sont :

— prefix : spécifie le préfixe du fichier. La valeur par défaut est ’juli.’

— suffix : spécifie le suffixe du fichier. La valeur par défaut est ’.log’

— directory : spécifie répertoire dans lequel sera créé le fichier. Par défaut TOMCAT_HOME\bin\logs

INFO : la rotation des fichiers journaux s’effectue toutes les nuits à minuit , et les noms des fichiers générés ont la syntaxe suivante : ’ ’

Section 2 : les loggers

La deuxième section du fichier logging.properties permet de spécifier les éléments qui écrivent (exemple : les classes qui vont écrire).

En particulier, les balises ’Engine’ , ’Host’ et ’Context’ peuvent écrire

Pour les applications, il faut préciser le nom des classes qui vont ecrire.

Partie 3 : créer un fichier de log par application

Vous devez créer un fichier de configuration logging.properties à embarquer avec la livraison , et qui met en oeuvre un fichier de log spécifique à l’application.

— Création du fichier logging.properties vierge
— Configuration du handler
— Configuration du logger
— Ajout de traces dans une classe particulière liée au Logger

Fichier logging.properties (WEB-INF\classes)