Journalisation des événements système

La fonction de journalisation d'événements système d'HCL Digital Experience permet l'enregistrement d'informations concernant le fonctionnement d'HCL Portal.

Les journaux d'événements fournissent aux administrateurs des informations sur des événements importants ou anormaux, en particulier les erreurs qui se produisent pendant le fonctionnement du produit. Ils contiennent aussi des informations de débogage permettant au service de support IBM de résoudre les incidents.

HCL Portal fournit deux types de journalisation : la journalisation de messages et celle de messages de débogage ou traces.

Pour plus d'informations sur l'utilisation de fichiers journaux et pour consulter la liste des chaînes du programme de consignation de traces, reportez-vous à la rubrique relative aux fichiers journaux d'HCL Portal.

Consignation des messages

Les messages pour HCL Portal sont enregistrés dans les fichiers suivants :
SystemOut.log
Contient des informations utiles pour contrôler la santé du serveur HCL Portal et de tous les processus en cours d'exécution.
System.err
Contient des informations de trace de pile d'exceptions qui s'avèrent utiles pour l'identification des problèmes.
Locating the log files : Les fichiers journaux pour HCL Portal, notamment SystemOut.log et System.err se trouvent dans le répertoire suivant : wp_profile_root/logs/WebSphere_Portal

Journalisation de traces

HCL Portal permet la journalisation de messages de débogage appelés traces. Ces traces sont très utiles pour la résolution des problèmes. Cependant, afin d'économiser les ressources système, ces deux types de journalisation sont désactivés par défaut.

Les traces peuvent être configurées pour différentes durées :
Temporary
Les traces peuvent être définies pour une durée temporaire à l'aide du portlet d'administration Activation de la fonction de trace ou de WebSphere® Integrated Solutions Console. Pour définir des traces à l'aide du portlet, procédez comme suit :
  1. Connectez-vous en tant qu'administrateur.
  2. Click the Administration menu icon. Then, click Portal Analysis > Enable Tracing. Le portlet Activation de la trace s'affiche.
  3. Cliquez sur Administration du site > Administration avancée > Analyse du portail > Activation de la fonction de trace. Le portlet Activation de la trace s'affiche.
  4. Entrez la chaîne de trace requise dans la zone Ajouter ces paramètres de trace :. Cette chaîne peut être par exemple : com.ibm.wps.command.credentialvault.*=finest
  5. Cliquez sur l'icône Ajouter. Enable Tracing updates the Current trace settings field.
Remarque : Le redémarrage d'HCL Portal supprime les traces qui ont été définies à l'aide du portlet Administration de la trace.
Pour désactiver la fonction de trace, utilisez une des méthodes suivantes :
  • Sélectionnez les paramètres de trace en cours sous Paramètres de trace en cours : puis cliquez sur l'icône Suppression. Le paramètre en cours peut être par exemple : com.ibm.wps.command.credentialvault.*=finest.
  • Entrez la chaîne de trace *=info dans le champ Ajouter ces paramètres de trace : puis cliquez sur l'icône Ajout. La chaîne de trace remplace tous les paramètres répertoriés sous Paramètres de trace en cours : et rétablit la valeur par défaut.
Etendue
Pour activer les paramètres de trace pour une période plus longue, c'est-à-dire, pour plus d'une session, activez ces derniers dans la configuration de WebSphere® Application Server. Procédez comme suit :
  1. Accédez à WebSphere® Integrated Solutions Console via l'URL suivante : http://hostname:port_number/ibm/console
  2. Accédez à Serveurs > Types de serveurs > Serveurs d'applications WebSphere.
  3. Sélectionnez le serveur d'applications.
  4. Cliquez sur Identification et résolution des problèmes > Modification des niveaux de détail de journalisation.
  5. Indiquez les paramètres de trace requis. Par exemple, ce paramètre peut être com.ibm.wps.command.credentialvault.*=finest
  6. Enregistrez vos modifications.
  7. Redémarrez le serveur WebSphere_Portal.
  8. Pour désactiver le traçage, indiquez tracestring: *=info puis redémarrez le serveur WebSphere_Portal.

Modification du nom du fichier journal et de son emplacement

Vous pouvez configurer l'emplacement des fichiers journaux dans WebSphere® Integrated Solutions Console. Accédez à Troubleshooting > Journaux et trace > nom_serveur, puis sélectionnez le type de programme de journalisation à modifier. Dans la boîte de dialogue de configuration, accédez au chemin du fichier journal selon les besoins.

Modification de la langue utilisée dans le fichier journal

Par défaut, les informations dans le fichier journal sont écrites dans la langue utilisée pour l'installation d'HCL Portal. Cependant, étant donné qu'HCL Portal prend en charge un certain nombre de langues, vous pouvez opter pour l'écriture des informations de fichier journal dans une langue autre que celle utilisée pendant l'installation.

To change the language that is used for the log file, edit the file log.properties. Ce fichier se trouve dans le chemin HCL Portal suivant :
Ajoutez la ligne de commande suivante :
locale=xx 
Where xx is the two-letter abbreviation for the locale. Pour obtenir une liste des abréviations d'environnement local utilisées avec HCL Portal, reportez-vous à la rubrique relative à la structure de répertoire et accédez à la section relative aux répertoires pour les langues. Pour que les informations de journal soient générées en anglais, ajoutez la ligne suivante :
 locale=en 

Référence : Options de format de fichier

Si les journaux sont affichés dans les fichiers d'HCL Portal et non redirigés vers la fonction de journalisation de WebSphere® Application Server, le fichier journal est constitué d'une séquence d'enregistrements de journalisation séparés par des lignes vides.

Les enregistrements de journalisation présentent le format suivant :

     timestamp classification classname method threadID
     messagecode: logmessage
Où :
  • L'timestamp correspond à l'heure (à la milliseconde près) où l'enregistrement de journal a été créé.
  • La valeur suivante classification correspond à l'une des lettres suivantes :
    E
    Pour les messages d'erreur
    W
    Pour les messages d'avertissement
    I
    Pour les messages d'informations
    l
    Pour les traces (niveau bas de détails)
    min
    Pour les traces (niveau moyen de détails)
    h
    Pour les traces (niveau élevé de détails)
  • La valeur classname indique la classe Java contenant le code qui a déclenché l'événement de journalisation.
  • La valeur method indique le nom de la méthode Java renfermant le code qui a déclenché l'événement de journalisation.
  • La valeur messagecode correspond à un identificateur unique pour ce message, qui identifie de manière unique le message concerné et y fait référence lorsque vous consultez la documentation ou le support. Le code du message est disponible uniquement pour les messages d'erreur, d'avertissement ou d'information, et non pour les traces. Il comprend :
    • Un identificateur à quatre caractères pour le composant qui définit le message.
    • Un nombre à quatre chiffres qui identifie de manière unique le message figurant dans le composant.
    • Un code de classification à une lettre, qui peut être E, W ou I.
  • La valeur logmessage indique le message de journalisation réel décrivant l'événement de journalisation. Les messages d'erreur, d'avertissement et d'information sont traduits dans l'environnement local système. Les messages de trace ne sont pas traduits.
  • threadID correspond à l'identification de l'unité d'exécution qui a déclenché l'événement à enregistrer.
Remarque :
  1. Les traces ne sont écrites que si les fonctions de traçage spécifiques sont activées ; tous les autres messages sont toujours écrits.
  2. L'environnement local du système fait partie des fonctions d'internationalisation d'HCL Portal et peut être configuré à l'aide de LocalizerService. Pour plus d'informations, voir les rubriques relatives à la définition des propriétés de configuration de service et aux services de configuration de portail.
Voici un exemple d'enregistrement de journal :

2011.05.16 13:36:14.449 W com.ibm.wps.services.datastore.DataStoreServiceImpl init 0000003a
DSTO0063W: The transaction isolation level is not set to READ_COMMITTED.

The current value is TRANSACTION_REPEATABLE_READ.