IBM Enterprise Records version 5.1.2    

Configuration du fichier log4j.properties

L'application IBM® Enterprise Records comporte un exemple de fichier log4j.properties que vous pouvez configurer.

Le fichier log4j.properties se trouve dans le dossier chemin_install_ier\RecordsManagerSweep et vous pouvez configurer le comportement de consignation en indiquant des valeurs dans le fichier pour les propriétés suivantes :

Un niveau est affecté à chaque consignateur du fichier log4j.properties. Si vous n'affectez pas de niveau à un consignateur, log4j lui attribue automatiquement le niveau du consignateur parent. Le niveau attribué par défaut est WARN.

Vous pouvez configurer le fichier log4j.properties avec différents paramètres de consignateur, d'ajouteur et de format. Le fichier log4j.properties doit être disponible pour l'application lors de l'exécution depuis le chemin d'accès aux classes. Vous pouvez mettre en commentaire les entrées du fichier d'exemple en préfixant l'instruction d'un symbole dièse (#). Les entrées marquées du symbole dièse (#) sont ignorées au moment de l'exécution.

Pour ouvrir le fichier log4j.properties, accédez au dossier chemin_install_ier\RecordsManagerSweep, puis ouvrez le fichier à l'aide d'un éditeur de texte.

Définition du consignateur et du niveau de consignation

Vous devez tout d'abord définir le consignateur. Vous disposez pour cela d'un certain nombre de consignateurs permettant de classer les types de consignation nécessaires pour l'application. Pour activer la consignation pour toutes les classes de com.filenet.rm et de ses sous-packages, définissez le consignateur comme indiqué dans l'instruction suivante :

log4j.logger.com.filenet.rm 

Sinon, vous pouvez spécifier n'importe quel nom pour le consignateur. Par exemple, vous pouvez l'appeler APILOG comme indiqué dans l'instruction suivante :

log4j.logger.com.filenet.rm=warn, APILOG

Vous devez définir un niveau de consignation afin de définir le niveau détaillé des messages enregistrés par log4j lors de l'exécution. log4j prend en charge cinq niveaux normaux de consignation comme indiqué dans le tableau suivant :

Tableau 1. Niveau des messages enregistrés par log4j lors de l'exécution
Niveau Description
DEBUG Désigne les événements d'information à granularité fine qui sont les plus utiles pour déboguer une application.
INFO Désigne les messages d'information qui mettent en évidence la progression de l'application à un niveau de granularité non fine.
WARN Désigne les situations potentiellement préjudiciables.
ERROR Désigne les événements d'erreur qui peuvent malgré tout ne pas entraver la poursuite de l'exécution de l'application.
FATAL Désigne les événements d'erreur grave et qui risquent de causer l'arrêt de l'application en cours d'exécution.

Pour plus d'informations sur les niveaux de consignation spéciaux et personnalisés, consultez la documentation log4j sur le site Web Apache. Par défaut, l'application commence au niveau WARN. Ce niveau peut être modifié en DEBUG, INFO, ERROR, WARN ou FATAL au moment de l'exécution. Vous pouvez également inclure plusieurs instructions logger, chacune se rapportant au même consignateur mais indiquant différents niveaux (par exemple, DEBUG pour l'une, WARN pour l'autre). Vous pouvez mettre en commentaire l'une ou l'autre instruction du fichier d'exemple en préfixant l'instruction d'un symbole dièse (#). Basculez ensuite, si nécessaire, entre les niveaux DEBUG et WARN. Les entrées marquées du symbole dièse (#) sont ignorées au moment de l'exécution. Un consignateur ne possédant pas de niveau défini hérite automatiquement du niveau de son consignateur parent. Par défaut, c'est le niveau WARN qui est affecté au consignateur API dans IBM Enterprise Records.

Définition des ajouteurs

Un consignateur est associé à un ou plusieurs ajouteurs (paramètre appender) afin de permettre l'inscription de ses messages de journal sur un support de sortie. Vous pouvez définir différents types d'ajouteur dans le fichier log4j.properties qui envoie les informations de consignation vers l'emplacement de sortie spécifié. Le tableau suivant fournit une liste de tous les ajouteurs utilisés dans le fichier log4j.properties, ainsi qu'une brève description accompagnée des options possibles.

Tableau 2. Ajouteurs (paramètre appender), descriptions et fragments de code
Ajouteur Description et fragments de code
NTEventLogAppender

Ajoute les données au journal des événements Microsoft Windows NT. Cet ajouteur peut être installé et utilisé uniquement sur un système Windows.

log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender
ConsoleAppender

Ajoute les messages de journal au flux System.out (par défaut) ou System.err à l'aide du format spécifié par l'utilisateur.

 log4j.appender.APILOG=org.apache.log4j.ConsoleAppender

Options :

  • Threshold=WARN : cet ajouteur ne consigne pas de messages ayant un niveau de priorité inférieur à celui spécifié ici, même si la priorité est définie sur un niveau inférieur. Ce paramètre est utile pour réduire le nombre de messages, par exemple, dans un fichier journal lors de l'affichage de tous les messages sur la console.
  • ImmediateFlush=true : La valeur par défaut est true, cela signifiant que les messages de journal ne sont pas placés en mémoire tampon. Si ImmdiateFlush a pour valeur false, les quelques derniers événements du journal ne sont pas écrits sur un support constant en cas de problème avec l'application.
FileAppender

Ajoute les messages de journal à un fichier.

 log4j.appender.APILOG=org.apache.log4j.FileAppender

Options :

  • Threshold=WARN : cet ajouteur ne consigne pas de messages ayant un niveau de priorité inférieur à celui spécifié ici, même si la priorité est définie sur un niveau inférieur. Ce paramètre est utile pour réduire le nombre de messages, par exemple, dans un fichier journal lors de l'affichage de tous les messages sur la console.
  • ImmediateFlush=true : La valeur par défaut est true, cela signifiant que les messages de journal ne sont pas placés en mémoire tampon. Si ImmdiateFlush a pour valeur false, les quelques derniers événements du journal ne sont pas écrits sur un support constant en cas de problème avec l'application.
  • File=mylog.txt : Nom du fichier de consignation. Vous pouvez utiliser ${clé_de_propriété} (par exemple, propriétés système java.home ou user.home) pour désigner le chemin.
  • Append=false : La valeur par défaut est true, cela signifiant que l'ajout des données s'effectue à la fin du fichier. La valeur false provoque l'écrasement des données au début du fichier à chaque exécution de programme.
RollingFileAppender

Extension du paramètre FileAppender qui permet de sauvegarder les fichiers journal lorsqu'ils atteignent une certaine taille.

 log4j.appender.APILOG=org.apache.log4j.RollingFileAppender

Options :

  • Threshold=INFO : cet ajouteur ne consigne pas de messages ayant un niveau de priorité inférieur à celui spécifié ici, même si la priorité est définie sur un niveau inférieur. Ce paramètre est utile pour réduire le nombre de messages, par exemple, dans un fichier journal lors de l'affichage de tous les messages sur la console.
  • ImmediateFlush=true : La valeur par défaut est true, cela signifiant que les messages de journal ne sont pas placés en mémoire tampon. Si ImmdiateFlush a pour valeur false, les quelques derniers événements du journal ne sont pas écrits sur un support constant en cas de problème avec l'application.
  • File=mylog.txt : Nom du fichier de consignation. Vous pouvez utiliser ${clé_de_propriété} (par exemple, propriétés système java.home ou user.home) pour désigner le chemin.
  • Append=false : La valeur par défaut est true, cela signifiant que l'ajout des données s'effectue à la fin du fichier. La valeur false provoque l'écrasement des données au début du fichier à chaque exécution de programme.
  • MaxFileSize=100 KB : Les suffixes peuvent être KB, MB ou GB. Assure l'enregistrement du fichier journal lorsque la taille indiquée est atteinte. Append prend une valeur booléenne qui détermine si les fichiers de sortie sont écrasés (false) ou ajoutés (true). La définition de la valeur sur false (valeur par défaut) empêche la croissance illimitée des fichiers. Utilisez ce paramètre dans un environnement de développement dans lequel vous effectuez des exécutions uniques occasionnelles. La définition de la valeur true provoque l'ajout des données en sortie à un fichier journal existant à chaque exécution JVM. Vous pouvez limiter la taille du fichier de sortie en définissant le mot clé MaxFileSize. Par exemple, si vous configurez un fichier de sortie, cjapi_log.txt, avec la taille MaxFileSize=128 ko et MaxBackupIndex=1, lorsque le fichier dépasse 128 ko, est automatiquement déplacé vers cjapi_log.txt.1. Les copies se poursuivent dans un fichier vide cjapi_log.txt.
  • MaxBackupIndex=2 : Assure la présence d'un maximum de 2 (ceci est un exemple) fichiers de sauvegarde. Efface les fichiers les plus anciens. 0 signifie qu'aucun fichier de sauvegarde n'est conservé.

Définition des formats

Vous pouvez définir différents agencements dans le fichier log4j.properties afin de définir le format du message de journal. Vous pouvez spécifier que les messages de journal incluent la date, l'heure, le nom de module, le nom d'unité d'exécution ainsi que d'autres informations. Ces paramètres de configuration sont utilisés en cours d'exécution lors de la consignation du message.

Le tableau suivant fournit une liste de tous les agencements utilisés dans le fichier log4j.properties IBM Enterprise Records, ainsi qu'une brève description accompagnée des options possibles.

Tableau 3. Formats et descriptions
Format Description et fragment de code
SimpleLayout

Imprime le niveau, puis un tiret (-) suivi du texte du message de journal.

org.apache.log4j.SimpleLayout
PatternLayout

Formate les événements du journal en fonction d'un modèle de conversion défini. Les modèles de conversion se composent de texte littéral et d'indicateurs de conversion. Le texte littéral est présenté tel quel en sortie. Les indicateurs de conversion se composent du caractère % suivi d'un modificateur de format facultatif et d'un caractère de conversion obligatoire. Par exemple, %-5p [%t]: %m%n est un modèle de conversion composé d'un spécificateur de conversion de priorité suivi du texte littéral " [". Cette chaîne est suivie d'un indicateur de conversion d'unité d'exécution, suivi d'un texte littéral "]: ". Cette chaîne est suivie d'un indicateur de conversion de message et d'un séparateur de ligne dépendant du système.

org.apache.log4j.PatternLayout

Options :

  • ConversionPattern=%-5p, [%t]:%m%n : Indique comment formater chaque message de journal (les informations à inclure).
HTMLLayout

Formate la sortie sous forme de tableau HTML.

org.apache.log4j.HTMLLayout

Options :

  • LocationInfo=true : Indique en sortie le nom du fichier Java et le numéro de ligne. La valeur par défaut est false.
  • Title=Mon app : Définit la balise <title> HTML. La valeur par défaut est Log4J Log Messages.
 

Génère une sortie au format XML.

org.apache.log4j.xml.XMLLayout

Options :

  • LocationInfo=true : Indique en sortie le nom du fichier Java et le numéro de ligne. La valeur par défaut est false.

Le fichier log4j.properties fourni avec IBM Enterprise Records utilise le paramètre PatternLayout comme format de message de journal. Le tableau suivant fournit une liste des modèles de conversion pouvant être déclarés dans le fichier de configuration, ainsi qu'une brève description.

Tableau 4. Modèles de conversion et descriptions
Modèle Description
%t Nom de l'unité d'exécution qui effectue la requête de consignation
%c Nom du consignateur associé à la requête de consignation
%-60c Alignement à gauche du nom du consignateur avec un espace de 60 caractères au minimum
%r Nombre de millisecondes écoulé depuis le démarrage de l'application
%p Niveau de l'instruction de consignation
%m Message
%Time Heure de début de la consignation
%d Date de l'événement de consignation
%n Nouvelle ligne

L'instruction de code suivante indique comment activer PatternLayout et spécifier un modèle de conversion simple :

log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {jj MMM aaaa HH:mm:ss,SSS}, 
-%m, %r, [%M] % n

Par exemple :

WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 
102042, [setLoggerMessage]
WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 
102342, [setLoggerMessage]


Commentaires

Dernière mise à jour : Novembre 2013
configure_rm_logging.htm

© Copyright IBM Corp. 2013