Configuration de la consignation Workplace XT

IBM FileNet Workplace XT utilise le produit Apache log4j pour gérer sa consignation. Pendant la consignation, des informations sur l'activité des applications sont écrites dans les emplacements de sortie comme la console ou des fichiers. Le personnel de support et de développement utilise les informations des entrées de journal pour analyser l'activité des applications, ainsi que pour diagnostiquer et pour résoudre les problèmes. La consignation s'effectue à des fins de diagnostic et ne fournit aucune information sur la sécurité ou sur l'analyse rétrospective.

Activation ou désactivation de la consignation

Le produit log4j est installé pendant l'installation de Workplace XT. Par défaut, la consignation n'est pas activée pendant l'installation.

Pour activer ou désactiver la consignation, procédez comme suit :

  1. Accédez au dossier de configuration de Workplace XT spécifié pendant l'installation. Le chemin par défaut est :
  2. Activez ou désactivez la consignation en renommant le fichier de configuration. L'exemple de fichier de configuration de la consignation est appelé __log4j.properties.
  3. Redémarrez l'application pour que vos modifications soient prises en compte.

Configuration des paramètres de consignation

L'exemple de fichier log4j.properties comporte un ensemble d'options par défaut, spécifiées comme des paires mot clé=valeur. Pour modifier les valeurs par défaut, ouvrez log4j.properties avec un éditeur de texte, effectuez les modifications nécessaires et enregistrez le fichier. Vous pouvez configurer les paramètres de consignation à tout moment après l'installation. Les modifications apportées au fichier de configuration de la consignation sont automatiquement reconnues. Vous n'avez donc pas besoin de redémarrer l'application ou le serveur d'applications.

Les rubriques suivantes fournissent des informations sur certaines des options de configuration de la consignation qui apparaissent dans le ficher. Pour plus d'informations sur les options de consignation, consultez le site Web d'Apache (http://apache.org) (projet de consignation) et le site Web de consignation Apache (http://logging.apache.org/log4j/).

Consignateur

Un consignateur écrit les demandes de consignation activées dans des ajouteurs. Dans le fichier log4j.properties, le premier mot clé décrit le consignateur racine. Celui-ci est le consignateur du niveau le plus élevé dans la hiérarchie et fournit les valeurs par défaut globales. Tout consignateur enfant ne comportant pas d'options explicitement définies hérite du comportement du consignateur racine.

Ajouteur

Vous pouvez indiquer l'emplacement où les données de journal doivent être écrites en configurant un ajouteur, qui envoie les entrées de journal formatées à une destination de sortie spécifiée. Les types de destination peuvent être un fichier ou la console. La sortie peut être réacheminée vers un journal des événements Windows, transmise à un serveur log4j, etc. (Consultez la documentation Apache log4j pour plus d'informations sur toutes les options de destination de sortie et de formatage.) Un seul consignateur peut comprendre plusieurs ajouteurs. Par exemple, vous pouvez écrire la sortie dans une console et dans un fichier en même temps. L'augmentation du nombre de destinations peut affecter les performances.

Dans Workplace XT, deux ajouteurs sont configurés par défaut. Un ajouteur écrit les données du journal au format d'événement de base commun IBM (CBE), utilisé par les outils d'IBM Support Assistant pour traiter le journal, tandis que l'autre écrit dans un format plus lisible par l'homme. Vous pouvez modifier ce dernier ajouteur pour réduire la quantité de sortie ou le désactiver complètement.

REMARQUES : 

Niveau de consignation

Le niveau de consignation que vous indiquez détermine le type et la quantité des informations collectées. Une corrélation directe existe entre la quantité d'informations collectées et l'impact sur le système en termes de performances.

Le journal de l'application Workplace XT prend en charge les niveaux standard INFO, AVERTISSEMENT, ERREUR et FATAL, ainsi que les niveaux TOUS et DESACTIVE. Le tableau suivant décrit brièvement les niveaux standard. Consultez votre documentation Apache log4j pour plus d'informations sur les niveaux.

Niveau Description
INFO Demande les messages d'information décrivant la progression de l'application à un niveau approximatif.
AVERTISSEMENT Demande la consignation des situations potentiellement nuisibles.
ERREUR Demande la consignation des exceptions émises depuis l'application.
FATAL Demande uniquement la consignation des événements d'erreur très graves qui pourraient entraîner un arrêt anormal de l'application.

Le niveau que vous indiquez détermine la quantité des informations collectées. Une corrélation directe existe entre la quantité d'informations collectées et l'impact sur le système en termes de performances.

Format du fichier de sortie

Lors de la configuration de l'ajouteur, vous pouvez utiliser le mot clé layout pour indiquer le format d'écriture des données. Vous avez le choix entre PatternLayout et ConversionPattern. PatternLayout permet d'indiquer un modèle en particulier pour les entrées de journal et ConversionPattern, permet d'identifier le modèle des éléments écrits dans l'ajouteur, définit ce modèle. Examinez l'exemple suivant :

log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout
log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n

donne lieu à l'entrée de journal formatée suivante :

2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before

Pour plus d'informations sur les options de formatage, consultez la documentation Apache log4j.

REMARQUE :  Ne modifiez pas la présentation des entrées de journal d'IBM Common Base Event (CBE). Si vous le faites, la sortie deviendra illisible par les outils IBM Support Assistant.

Analyse de la sortie

Le service d'assistance peut examiner les entrées pour analyser l'activité des applications et diagnostiquer les problèmes qui se produisent dans l'application. En outre, l'utilisation des outils IBM Support Assistant (ISA) automatise la phase d'analyse. Les outils ISA consomment les entrées CBE dans la sortie de consignation de log4j.

Vous pouvez également utiliser un outil comme Apache Chainsaw, visualiseur de journaux avec interface graphique, pour examiner vous-même les entrées de journal non CBE.