La aplicación IBM® Enterprise Records incluye un archivo log4j.properties de muestra que se puede configurar.
El archivo log4j.properties se encuentra ubicado en la carpeta ruta_instalación_ier\ RecordsManagerSweep y puede configurar el comportamiento de registro especificando los siguientes valores en el archivo:
Cada registrador del archivo log4j.properties tiene asignado un nivel. Si no asigna ningún nivel a un registrador, el archivo log4j asigna automáticamente el nivel del registrador padre al registrador sin asignación. De forma predeterminada, se asigna el nivel a un registrador.
Puede configurar el archivo log4j.properties con diferentes valores de registrador, agregador y diseño. El archivo log4j.properties debe estar disponible en la aplicación en tiempo de ejecución desde la ruta de clase. Puede comentar las entradas en el archivo de muestra colocando delante de la sentencia el símbolo hash (#); las entradas marcadas con el símbolo hash (#) no se ejecutarán en tiempo de ejecución.
Para abrir el archivo log4j.properties, vaya a la carpeta ruta_instalación_ier\RecordsManagerSweep y, a continuación, abra el archivo con un editor de texto.
En primer lugar, tiene que definir el registrador. Puede disponer de varios registradores para clasificar el tipo de registro que requiera para la aplicación. Para habilitar el registro de todas las clases de com.filenet.rm y sus subpaquetes, especifique el registrador como se indica en la siguiente sentencia:
log4j.logger.com.filenet.rmor
Puede especificar el nombre que desee para el registrador. Por ejemplo, puede llamar al registrador APILOG, como muestra esta sentencia:
log4j.logger.com.filenet.rm=warn, APILOG
Necesita definir un nivel de registro para establecer el nivel de detalle de los mensajes registrados por log4j en tiempo de ejecución.El archivo log4j admite cinco niveles normales de registro como se muestra en la tabla más abajo.
Nivel | Descripción |
---|---|
DEBUG | Designa los eventos informativos precisos que resultan más útiles para depurar una aplicación. |
INFO | Designa mensajes informativos que resaltan el progreso de la aplicación a un nivel general. |
WARN | Designa situaciones potencialmente perjudiciales. |
ERROR | Designa eventos de error que podrían seguir permitiendo la ejecución de la aplicación. |
FATAL | Designa eventos de error muy graves que podrían probablemente hacer que la aplicación terminara anormalmente. |
Consulte la documentación relativa al archivo log4j en el sitio web de Apache para obtener información sobre niveles de registro especiales y personalizados. De forma predeterminada, la aplicación se inicia en el nivel WARN. Este puede cambiarse a los niveles DEBUG, INFO, ERROR, WARN, o FATAL en tiempo de ejecución. También puede incluir varias sentencias de registrador, cada una de ellas para el mismo registrador, pero con distintos niveles (como DEBUG para uno y WARN para otro). Puede comentar una y otra en el archivo de muestra colocando delante de la sentencia el símbolo hash (#) y alternando entre los niveles DEBUG y WARN según resulte necesario. Las entradas marcadas con el símbolo hash (#) no se ejecutarán en tiempo de ejecución. Un registrador sin nivel hereda automáticamente el nivel de su registrador padre. De forma predeterminada, se asigna el nivel WARN al registrador de la API de RM en IBM Enterprise Records.
Un registrador se asocia con uno o varios agregadores para permitir que se graben sus mensajes en los soportes de salida. Puede definir distintas clases de agregadores en el archivo log4j.properties que envía la información de registro a la ubicación de salida especificada. La siguiente tabla ofrece una lista de todos los agregadores que se utilizan en el archivo log4j.properties junto con breves descripciones y opciones relacionadas.
Agregador | Descripción y fragmentos de código |
---|---|
NTEventLogAppender | Se añade al registro de sucesos de Microsoft Windows NT. Este agregador solo se puede instalar y utilizar en un sistema Windows. log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender |
ConsoleAppender | Añade mensajes de registro a la corriente System.out (predeterminada) o System.err mediante un diseño especificado por el usuario. log4j.appender.APILOG=org.apache.log4j.ConsoleAppender Opciones:
|
FileAppender | Añade mensajes de registro a un archivo. log4j.appender.APILOG=org.apache.log4j.FileAppender Opciones:
|
RollingFileAppender | Amplía FileAppender para realizar copia de seguridad de los archivos de registro cuando alcanzan un determinado tamaño. log4j.appender.APILOG=org.apache.log4j.RollingFileAppender Opciones:
|
Puede definir diferentes diseños en el archivo log4j.properties que especifiquen el formato del mensaje de registro. Puede especificar que los mensajes de registro incluyan la fecha, la hora, el nombre de módulo, el nombre de hebra, etc. Estos valores de configuración se utilizan en tiempo de ejecución al registrar el mensaje.
La siguiente tabla ofrece una lista de todos los agregadores que se utilizan en el archivo log4j.properties de IBM Enterprise Records log4j.properties junto con breves descripciones y opciones.
Diseño | Descripción y fragmento de código |
---|---|
SimpleLayout | Imprime el nivel, y a continuación un guion (-) seguido del texto del mensaje de registro. org.apache.log4j.SimpleLayout |
PatternLayout | Da formato a los eventos de anotaciones según un patrón de conversión especificado. Los patrones de conversión se componen de texto literal y especificadores de conversión. La salida del texto literal es tal cual. Los especificadores de conversión constan del carácter % seguido de un modificador de formato opcional y un carácter de conversión obligatorio. Por ejemplo, %-5p [%t]: %m%n es un patrón de conversión compuesto de un especificador de conversión de prioridad (también conocida como nivel) seguido del texto literal " [", seguido de un especificador de conversión de hebra, seguido del texto literal "]: " seguido de un especificador de conversión de mensajes y un separador de línea dependiente del sistema. org.apache.log4j.PatternLayout Opciones:
|
HTMLLayout | Da formato a la salida como un tabla HTML. org.apache.log4j.HTMLLayout Opciones:
|
Da formato a la salida como XML. org.apache.log4j.xml.XMLLayout Opciones:
|
El archivo log4j.properties suministrado con IBM Enterprise Records utiliza PatternLayout para el formato del mensaje de registro. En la tabla siguiente se ofrece una lista de patrones de conversión que se pueden declarar en el archivo de configuración junto con sus descripciones breves:
Patrón | Descripción |
---|---|
%t | Nombre de la hebra que realiza la solicitud de registro |
%c | Nombre del registrador asociado con la solicitud de registro |
%-60c | Ajusta por la izquierda del nombre del registrador en un mínimo de 60 espacios |
%r | Número de milisegundos transcurridos desde el inicio de la aplicación |
%p | Nivel de la sentencia de anotación |
%m | Mensaje |
%Time | Hora a la que se producirán las anotaciones |
%d | Fecha del evento de anotaciones |
%n | Nueva línea |
La siguiente sentencia de código muestra cómo activar PatternLayout y especificar un patrón de conversión simple:
log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n
Por ejemplo:
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]