Servicios de anotación cronológica

HCL Commerce proporciona recursos para el registro. Para los clientes existentes, todavía se da soporte a ECTrace y ECMessage. Para implementaciones nuevas, utilice la recomendación de WebSphere Application Server para la anotación cronológica y el rastreo.

El propósito de registrar mensajes en Transaction server es registrar errores inesperados o condiciones anormales en la aplicación HCL Commerce. (Para obtener más información sobre la grabación de mandatos y tareas que se ejecutan durante una operación de HCL Commerce, consulte la auditoría de negocio.) Los registros de mensajes y los rastreos son herramientas de diagnóstico importantes que ayudan al administrador del sitio a determinar el origen de los problemas. El rastreo es un mecanismo para la determinación de problemas. El rastreo ayuda a los desarrolladores a depurar el código durante la fase de desarrollo, y al equipo de soporte técnico a resolver los problemas de los clientes. Se puede utilizar la herramienta de analizador de anotaciones cronológicas y de rastreo para Eclipse en el kit de herramientas de WebSphere Application Server. La herramienta del analizador de anotaciones cronológicas y de rastreo para Eclipse se puede instalar desde la consola de Launchpad del kit de herramientas de WebSphere Application Server. Proporciona prestaciones de visualización interactiva y análisis que puede ser útil para identificar problemas.

Revise las siguientes API de registro de HCL Commerce:

ECTrace
Rastrea el flujo de datos. Las entradas de rastreo se capturan en un archivo para su posterior depuración. El rastreo se utiliza para la determinación de problemas. El rastreo ayuda a los desarrolladores a depurar el código durante la fase de desarrollo, y al equipo de soporte técnico a resolver los problemas de los clientes.

Los datos de rastreo se conservan, para futuras consultas, en un archivo de rastreo. Una estructura de datos consta de información de contexto, por ejemplo un nombre de clase, un nombre de método y un mensaje de texto. Múltiples estructuras de datos describen el flujo de datos en una aplicación de software. Al analizar la secuencia de la estructura de datos, un desarrollador puede saber la vía de ejecución, lo cual le puede ayudar a determinar la causa de un funcionamiento incorrecto.

ECMessage
Anota cronológicamente los mensajes de diagnóstico. Los mensajes son sensibles al entorno local y se almacenan en archivos de anotaciones cronológicas del sistema de archivos. Si se habilita la notificación de errores, el soporte técnico recibe notificaciones de alerta. Las anotaciones de diagnóstico se utilizan para la determinación de problemas. De forma predeterminada, el nombre de archivo de registro es SystemOut.log.

Las anotaciones de diagnóstico se utilizan para la determinación de problemas. ECMessageLog anota los mensajes de diagnóstico y ECMessages son particulares de un área. ECMessages se divide en las categorías siguientes:

Mensajes del sistema
Los mensajes del sistema se visualizan en las anotaciones cronológicas y sirven para registrar problemas o problemas potenciales (es decir, avisos). Los mensajes del sistema proporcionan información de diagnóstico para los Administradores de sitio. Estos mensajes pueden indicar un mal funcionamiento del sistema u otro suceso significativo.

A los mensajes del sistema se les asigna un ID de mensaje específico de producto. Los Administradores de sitio pueden utilizar el ID de mensaje para buscar más detalles que están asociados con ese mensaje; los clientes pueden informar del mensaje al personal de soporte técnico, para la resolución de problemas.

Los mensajes de las versiones anteriores de HCL Commerce utilizan el formato CMN nnnns y los mensajes nuevos para HCL Commerce 5.6 utilizan el formato CWX ccnnnns. En ambos casos, deberá estar familiarizado con el formato siguiente:

cc
El componente de HCL Commerce que está informando sobre el mensaje del sistema. Por ejemplo, CC indica un mensaje relacionado con el componente de catálogo, como en CWXCC1234E.
nnnn
El número de clave que se utiliza para identificar lo que está afectado. Por ejemplo 1234, como en CWXCC1234E.
s
La gravedad del mensaje. La gravedad de E indica un mensaje de error, I indica mensajes informativos y W indica avisos.
Mensajes del usuario
Se muestran con frecuencia en el navegador y son para beneficio de un cliente que visite el sitio. Los mensajes de usuario proporcionan detalles sobre el problema. Por ejemplo, indica si un parámetro que se ha especificado no es válido, lo que indica al cliente los valores que debe arreglar cuando vuelva a someter la solicitud.
Consta de varios paquetes java que proporcionan primitivos de rastreo de diagnóstico y registro de mensajes. Estos primitivos no están vinculados a ningún producto o plataforma en particular. JRas consta de varios componentes:
Anotadores cronológicos
Un anotador cronológico es el objeto primario con el que interactúa el código de usuario. Existen dos tipos de anotadores cronológicos:
  • anotadores cronológicos de mensajes
    • Crea sólo registros de mensajes.
  • anotadores cronológico de rastreo
    • Crear registros de rastreo.
Un anotador cronológico contiene uno o más manejadores a los que envía los eventos para su proceso adicional.
Manejadores
Un manejador recibe los eventos de un anotador y proporciona una abstracción a través de un dispositivo de salida o un consumidor de eventos. Un manejador de archivos, que sabe cómo grabar un evento en un archivo, es un ejemplo de manejador.
Formateadores
Los manejadores se configuran con formateadores, que saben cómo formatear eventos de determinados tipos.
Tipos de evento
Los mensajes y los rastreos tienen sus propios tipos de evento predefinidos.
Clases de evento
El kit de utilidades de anotaciones cronológicas define las clases de eventos de rastreo y de mensajes.
Extensiones JRas de WebSphere
Para integrarlas en el tiempo de ejecución de WebSphere Application Server o para utilizarlas en un entorno J2EE, WebSphere proporciona un conjunto de clases de extensión. La anotación cronológica de HCL Commerce utiliza el recurso de registro de WebSphere Application Server y estas clases de extensión proporcionan una mejor correlación de los mensajes y rastreos que se generan desde los diferentes productos de WebSphere. Este conjunto de clases de extensión se denominan extensiones JRas de WebSphere. Las extensiones JRas de WebSphere proporcionan las clases apropiadas de implementación de anotadores. Las instancias de las clases de anotadores cronológicos de mensajes y rastreos se obtienen directa y exclusivamente de la clase WebSphere Manager, que se encuentra en el paquete com.ibm.websphere.ras. Otros componentes por ejemplo Payments y la infraestructura de mensajería JCA también utilizan las extensiones JRas de WebSphere.

Aunque HCL Commerce proporciona un wrapper para ECMessage y ECTrace que llama a las API de extensión JRas de WebSphere, es recomendable que los Administradores de sitio llamen a las API de JRas directamente.

Nota: Para obtener más información sobre el kit de utilidades de anotación cronológica JRas, consulte el tema Understanding the JRas facility.

Ubicación del archivo de anotaciones cronológicas

Puede encontrar los archivos de salida predeterminados en el directorio siguiente:
  • LinuxAIXFor IBM i OS operating systemWC_profiledir/logs/server1
  • WindowsWC_profiledir\logs\server1

En el directorio, puede encontrar los archivos de salida predeterminados siguientes:

native_stderr.log
Un registro de proceso que contiene texto que se graba en la secuencia stderr.
native_stdout.log
Un registro de proceso que contiene texto que se graba en la secuencia stdout.
startServer.log
Un registro grabado cuando se ha iniciado el servidor.
stopServer.log
Un registro grabado cuando se ha detenido el servidor.
SystemErr.log
Anota los errores del sistema mientras el servidor está en ejecución.
SystemOut.log
Anota el archivo de salida del sistema mientras el servidor está en ejecución.
activity.log
Anota la actividad continua. Este registro se encuentra en el directorio WAS_installdir/logs.
trace.log
Si el rastreo está habilitado, anota los mensajes de rastreo de componentes mientras se ejecuta el servicio.
Nota:

Cuando se trabaja con IBM para depurar problemas de proceso de solicitud, es posible que haya ocasiones en las que los componentes de rastreo de bajo nivel deban habilitarse para capturar detalles, lo que permite saber cómo se procesa la solicitud. Estos componentes de rastreo del servidor de aplicaciones de bajo nivel no conocen la intención de la solicitud ni los datos potenciales contenidos. Por consiguiente, cuando se habilitan, es posible que estos componentes de rastreo puedan incluir información confidencial en texto sin formato en el archivo de rastreo.

Es recomendable no habilitar estos tipos de componentes de rastreo en un sistema de producción e intentar simular el problema en un entorno de garantía de calidad para capturar la información adecuada. Sin embargo, si los componentes de rastreo deben estar habilitados en un sistema de producción, maneje los archivos de rastreo con precaución. Antes de enviar el rastreo, elimine los datos confidenciales que pueden estar en el rastreo antes de permitir que un tercero utilice el rastreo de diagnóstico. Además, cuando el rastreo ya no es necesario, elimine los archivos con un proceso de eliminación de datos de tipo militar. Cuando se ha detectado el problema y el componente de rastreo ya no es necesario, estos componentes de rastreo deben inhabilitarse de forma inmediata.

Niveles de anotación cronológica

Existen tres niveles de anotación cronológica, o gravedad, en el sistema de anotación cronológica de HCL Commerce:

  • error
  • aviso
  • informativo
Nota: Aunque el recurso de anotación cronológica de WebSphere Application Server también utiliza los niveles de anotación cronológica de depuración y estado, HCL Commerce utiliza los niveles de anotación cronológica de error, aviso e informativo y se correlaciona con ellos.
Mensajes de error
Siempre registrados de forma predeterminada. Los mensajes de error exponen una condición de error que puede llevar a un funcionamiento incorrecto del sistema. Un mensaje de error puede enviarse en forma de correo electrónico, mensaje de IBM MQ u otra forma de notificación a un Administrador de sitio registrado con mensajería.
Mensajes de aviso
Revelan un problema potencial.
Mensajes informativos
Siguen a los sucesos que se producen en el sistema HCL Commerce. Los mensajes de información están relacionados con los eventos que desencadenan cambios en el estado del sistema. Por ejemplo, se emite un mensaje de información cuando se somete un pedido.

Dado que HCL Commerce utiliza el recurso de anotación cronológica de WebSphere Application Server, consulte la tabla siguiente para obtener información sobre cómo se correlacionan los niveles de anotación cronológica de HCL Commerce con WebSphere Application Server:

Niveles de anotación cronológica en HCL Commerce Niveles de anotación cronológica en 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

La interfaz de usuario de WebSphere Application Server se utiliza para controlar la habilitación del nivel de anotación cronológica o del tipo de gravedad. Los administradores de sitio pueden especificar qué gravedades de anotación cronológica se deben registrar en la consola de administración de WebSphere Application Server.

Visualización de los archivos de anotaciones cronológicas

Puede ver los archivos de anotaciones cronológicas de varios modos. En función del tipo de archivo de anotaciones cronológicas, éstos son los métodos sugeridos normalmente para verlos:

  • Utilice el visor de anotaciones cronológicas de actividad de RAD (Rational Application Developer) o AST para ver los archivos de registro de actividad y los archivos de rastreo de WebSphere Application Server.
  • Utilice la herramienta Analizador de anotaciones cronológicas y rastreo para Eclipse para ver los archivos de registro de actividad y los archivos de rastreo de WebSphere Application Server.
  • Utilice cualquier editor de texto para ver los archivos de rastreo de WebSphere Application Server, los archivos de registro de salida de sistema o los archivos de registro de errores de sistema.

El diagrama siguiente ilustra estos métodos de visión sugeridos:

Diagrama para ilustrar diferentes métodos de visualización para leer archivos de registro.