Services de journalisation

HCL Commerce fournit des fonctions de journalisation. Pour les clients existants, ECMessage et ECTrace sont toujours pris en charge. Pour les nouvelles implémentations, utilisez les recommandations WebSphere Application Server concernant la consignation et la traçage.

Le but de la journalisation des messages dans le Transaction server est d'enregistrer des erreurs inattendues ou des conditions anormales dans l'application HCL Commerce. Pour plus d'informations sur l'enregistrement d'instructions et de tâches exécutées lors d'une opération de HCL Commerce, reportez-vous à la rubrique Audit métier.) Les journaux des messages et les traces sont d'importants outils de diagnostic qui aident l'administrateur de site à identifier l'origine des incidents. Le traçage permet d'identifier les incidents. Il permet aux développeurs de déboguer le code pendant la phase de développement et à l'équipe du support technique de résoudre les difficultés des clients. L'outil Analyseur de trace et de journal pour Eclipse dans le kit d'outils WebSphere Application Server peut être utilisé. L'outil Analyseur de trace et de journal pour Eclipse est installable à partir de la console du tableau de bord du kit d'outils WebSphere Application Server. Il fournit une fonctionnalité d'affichage et d'analyse interactive qui facilite l'identification des incidents.

Consultez les API de connexion de HCL Commerce suivantes :

ECTrace

Analyse le flux de données. Les entrées de trace sont enregistrées dans un fichier à des fins de débogage. Le traçage permet d'identifier les incidents. Il permet aux développeurs de déboguer le code pendant la phase de développement et à l'équipe du support technique de résoudre les difficultés des clients.

Les informations de traçage sont conservées dans un fichier trace pour référence ultérieure. Une structure de données est composée d'informations contextuelles, telles qu'un nom de classe, un nom de méthode et un message texte. Plusieurs structures de données décrivent le flux de données au sein d'une application logicielle. En analysant la séquence de la structure de données, un développeur peut comprendre le chemin d'accès exécuté, ce qui peut l'aider à déterminer la cause des dysfonctionnements.

ECMessage

Consigne des messages de diagnostic. Les messages sont sensibles à l'environnement local et sont stockés dans des fichiers journaux dans le système de fichiers. Si la notification d'erreur est activée, le support technique reçoit des notifications d'alerte. Les journaux de diagnostic sont utilisés pour l'identification des incidents. Par défaut, le fichier journal s'appelle SystemOut.log.

Les journaux de diagnostic sont utilisés pour l'identification des incidents. ECMessageLog consigne les messages de diagnostic et les messages ECMessages sont localisés. Les messages ECMessages sont subdivisés en catégories :

Messages système

Les messages système s'affichent dans les journaux et servent à consigner les incidents ou les erreurs éventuelles (avertissements). Ils fournissent des informations de diagnostic pour les administrateurs de site. Ces messages peuvent suivre un dysfonctionnement du système, ou indiquer tout autre événement important.

Un ID message spécifique du produit est affecté aux messages système. Les administrateurs de site peuvent utiliser l'ID message pour rechercher d'autres détails associés à ce message ; les clients peuvent transmettre le message au support à des fins d'identification des incidents.

Les messages provenant de versions précédentes de HCL Commerce utilisent le format CMN nnnns, tandis que les messages spécifiques de HCL Commerce 5.6 utilisent le format CWX ccnnnns. Dans les deux cas, vous devez être familiarisé avec le format suivant :

cc: Composant HCL Commerce signalant le message système. Par exemple, CC indique un message relatif au composant catalogue, comme dans CWXCC1234E.
nnnn: Numéro de clé utilisé pour identifier l'élément affecté. Par exemple, 1234, comme dans CWXCC1234E.
s: Gravité du message. Une gravité E correspond à un message d'erreur, I indique un message d'information et W signale des avertissements.

Messages utilisateur

Ils s'affichent fréquemment sur le navigateur et sont destinés aux clients qui visitent le site. Les messages destinés à l'utilisateur détaillent le problème. Ils indiquent, par exemple, si un paramètre spécifié est incorrect, permettant ainsi à l'utilisateur de déterminer la valeur à corriger lors de la nouvelle soumission de la requête.

Composé de plusieurs packages Java formant une trousse d'outils de journalisation pour la consignation des messages et des primitives de trace de diagnostic. Ces primitives ne sont liées à aucun produit ni à aucune plateforme en particulier. JRas est constitué de plusieurs composants :

Gestionnaires de journalisation

Un consignateur est l'objet principal avec lequel le code utilisateur interagit. Il en existe deux types :

consignateurs de messages
- Créent uniquement des enregistrements de messages.
consignateurs de trace
- Créent des enregistrements de trace.

Un consignateur contient un ou plusieurs gestionnaires auxquels il envoie des événements en vue d'un traitement ultérieur.

Gestionnaires

Un gestionnaire reçoit des événements d'un programme de connexion et fournit une abstraction sur un dispositif de sortie ou un événement client. Par exemple, un gestionnaire de fichiers sait comment écrire un événement dans un fichier.

Formateurs

Les gestionnaires sont configurés avec des programmes de formatage, qui savent comment mettre en forme des événements de certains types.

Types d'événement

Les messages et les traces possèdent leurs propres types d'événement prédéfinis.

Classes d'événement

Les outils de journalisation JRas définissent à la fois les classes d'événement de trace et de message.

Extensions JRas WebSphere

WebSphere fournit un ensemble de classes d'extension en vue d'une intégration à l'exécution de WebSphere Application Server ou d'une utilisation dans un environnement J2EE. La journalisation à partir de HCL Commerce utilise la fonction de journalisation de WebSphere Application Server et ces classes d'extension offrent une meilleure corrélation des messages et des traces générés à partir de différents produits WebSphere. Ces classes d'extension sont appelées extensions JRas WebSphere. Les extensions JRas WebSphere fournissent des classes d'implémentation de programme de connexion appropriées. Les instances de ces classes de consignateur de trace et de messages sont obtenues directement et exclusivement à partir de la classe WebSphere Manager, qui se trouve dans le module com.ibm.websphere.ras. D'autres composants, tels que WebSphere Commerce Payments et la structure de messagerie JCA utilisent également les extensions JRas WebSphere.

HCL Commerce fournit un encapsuleur pour ECMessage et ECTrace, qui appelle les API d'extension JRas WebSphere. Il est toutefois recommandé que les administrateurs de site appellent directement les API JRas.

Remarque : Pour plus d'informations sur le kit d'outils de journalisation JRas, consultez la rubrique Understanding the JRas facility.

Emplacement du fichier de journalisation

Vous pouvez trouver les fichiers de sortie par défaut dans le répertoire suivant :

WC_profiledir/logs/server1
WC_profiledir\logs\server1

Dans le répertoire, vous pouvez trouver les fichiers de sortie par défaut suivants :

native_stderr.log: Journal de traitement contenant le texte écrit dans le flux stderr.
native_stdout.log: Journal de traitement contenant le texte écrit dans le flux stdout.
startServer.log: Journal écrit lors du démarrage du serveur.
stopServer.log: Journal écrit lors de l'arrêt du serveur.
SystemErr.log: Journalisation de toutes les erreurs système lors de l'exécution du serveur.
SystemOut.log: Journalisation du fichier de sortie système lors de l'exécution du serveur.
activity.log: Journalisation de l'activité continue. Le journal se trouve dans le répertoire WAS_installdir/logs.
trace.log: Si la trace est activée, journalisation des messages de trace des composants pendant que le service est en cours d'exécution.; Remarque :
Lorsque vous collaborez avec IBM pour déboguer des incidents relatifs au traitement d'une requête, il est possible que, dans certains cas, des composants de traçage de bas niveau doivent être activés pour capturer des informations détaillées sur la façon dont la requête est traitée. Ces composants de traçage Application Server de bas niveau ne connaissent pas l'intention de la requête ni les données potentielles qu'elle contient. Par conséquent, une fois activés, il est possible que ces composants de traçage incluent des informations confidentielles, en texte en clair, dans le fichier de trace.
Il est conseillé de ne pas activer ces types de composants de traçage sur un système de production et d'essayer de simuler l'incident dans un environnement d'assurance qualité afin de capturer les informations appropriées. Cependant, si les composants de la fonction de trace doivent être activés sur un système de production, gérez les fichiers de trace avec précaution. Avant d'envoyer la trace, supprimez des données confidentielles qui peuvent être dans le fichier de trace avant de permettre à un tiers d'utiliser la trace pour diagnostic. Par ailleurs, une fois que la trace n'est plus nécessaire, supprimez les fichiers à l'aide d'un processus d'effacement des données d'un niveau de fiabilité supérieur. Lorsque le problème est trouvé et le composant de traçage n'est plus nécessaire, désactivez immédiatement les composants de traçage de bas niveau.

Niveaux de journalisation

Il existe trois niveaux de journalisation ou de gravité dans le système de journalisation HCL Commerce :

erreur
avertissement
information

Remarque : Bien que la fonction de journalisation de WebSphere Application Server utilise également les niveaux de journalisation état et débogage, HCL Commerce utilise et met en correspondance les messages des niveaux erreur, avertissement et information.

Les messages d'erreur: Toujours consignés par défaut. Les messages d'erreur exposent une condition d'erreur pouvant entraîner un dysfonctionnement du système. Un message d'erreur peut être envoyé sous forme de courrier électronique, de message IBM MQ ou toute autre forme de notification à un administrateur de site enregistré dans la messagerie.
Messages d'avertissement: Ils signalent un incident potentiel.
Messages d'information: Ils sont liés à l'apparition d'événements dans le système HCL Commerce. Les messages d'information sont liés à des événements qui déclenchent des modifications au niveau de l'état du système. Par exemple, un message d'information est conservé lorsqu'une commande est envoyée.

Etant donné que HCL Commerce utilise la fonction de journalisation de WebSphere Application Server, reportez-vous au tableau suivant pour savoir comment les niveaux de journalisation de HCL Commerce sont mappés sur WebSphere Application Server :


Niveaux de journalisation dans HCL Commerce	Niveaux de journalisation dans WebSphere Application Server
DEBUG	`TYPE_INFORMATION/TYPE_INFO`
ERROR/ERR	`TYPE_ERROR/TYPE_ERR`
INFORMATION/INFO	`TYPE_INFORMATION/TYPE_INFO`
STATUS	`TYPE_INFORMATION/TYPE_INFO`
WARNING/WARN	`TYPE_WARNING/TYPE_WARN`

L'interface utilisateur WebSphere Application Server est utilisée pour contrôler l'activation du niveau de journalisation ou du type de gravité. Les administrateurs de site peuvent indiquer les niveaux de gravité de journalisation à enregistrer dans la console d'administration de WebSphere Application Server.

Affichage des fichiers journaux

Vous pouvez visualiser les fichiers affectés de plusieurs manières différentes. Les modes d'affichage suivants sont généralement proposés selon le type de fichier journal :

Utilisez l'afficheur de journaux d'activité de Rational Application Developer (RAD) ou AST pour afficher les fichiers journaux d'activité et les fichiers de trace WebSphere Application Server.
Utilisez l'outil Analyseur de trace et de journal pour Eclipse pour visualiser les fichiers journaux d'activité et les fichiers de trace de WebSphere Application Server.
Utilisez n'importe quel éditeur de texte pour visualiser les fichiers de trace de WebSphere Application Server, les fichiers journaux externes du système ou les fichiers journaux d'erreurs du système.

Le diagramme suivant est une illustration de ces modes de visualisation proposés :

Diagramme illustrant diverses méthodes de lecture des fichiers journaux.