PDF de programación - Manual de Log4J

Manual de Log4J

Mauricio Santacruz, VimeWorks Cia. Ltda.

Este documento está publicado bajo los términos de la Apache Software License, una copia de
dicha licencia se encuentra en http://www.apache.org/LICENSE.

El presente documento es una traducción del manual Short introduction to log4j
[http://jakarta.apache.org/log4j/docs/manual.html] publicado originalmente en Inglés bajo los
términos de la Apache Software License, además contiene aclaraciones tomadas de los artículos
Don't Use System.out.println! Use Log4j [http://www.vipan.com/htdocs/log4jhelp.html], Build
Flexible Logs With log4j [http://www.onjava.com/pub/a/onjava/2002/08/07/log4j.html?page=1] y
de la experiencia personal del autor.

Table of Contents

Loggers ..................................................................................................................................... 1
Appenders ................................................................................................................................. 2
ConsoleAppender (org.apache.log4j.ConsoleAppender) ............................................................. 2
FileAppender (org.apache.log4j.FileAppender) ......................................................................... 2
RollingFileAppender (org.apache.log4j.RollingFileAppender) ..................................................... 3
DailyRollingFileAppender (org.apache.log4j.DailyRollingFileAppender) ...................................... 3
SocketAppender (org.apache.log4j.net.SocketAppender) ............................................................ 4
SMTPAppender (org.apache.log4j.net.SMTPAppender) ............................................................. 5
JDBCAppender (org.apache.log4j.jdbc.JDBCAppender) ............................................................ 5
SyslogAppender (org.apache.log4j.net.SyslogAppender) ............................................................ 6
NTEventLogAppender (org.apache.log4j.nt.NTEventLogAppender) ............................................. 6
JMSAppender (org.apache.log4j.net.JMSAppender) .................................................................. 6
Layouts ..................................................................................................................................... 7
SimpleLayout ..................................................................................................................... 7
PatternLayout ..................................................................................................................... 7
HTMLLayout ..................................................................................................................... 11
XMLLayout ....................................................................................................................... 11
TTCCLayout ...................................................................................................................... 11
Configuración ............................................................................................................................ 11
Inicialización en Servlet ............................................................................................................... 14
Nested Diagnostic Context / Mapped Diagnostic Context .................................................................... 15
Rendimiento .............................................................................................................................. 17

Abstract

El presente documento describe el API de log4j, esto únicamente en diseño y modo de utilización. Log4J es un
producto open source basado en el trabajo de muchos autores. Este permite a los desarrolladores el controlar la
salida de sus mensajes y hacia donde son direccionados con gran granularidad. Es completamente configurable en
tiempo de ejecución utilizando archivos externos de configuración. Log4J ha sido implementado en otros lenguajes
como: C, C++, C#, Python, Ruby, e Eiffel.

Loggers

La primera y una de las mayores ventajas de cualquier API de logging sobre el tradicional System.out.println es la

1

Manual de Log4J

capacidad de habilitar y deshabilitar ciertos logs, mientras otros no sufren ninguna alteración. Esto se realiza
categorizando los mensajes de logs de acuerdo al criterio del programador.

Log4J tiene por defecto 5 niveles de prioridad para los mensajes de logs:

DEBUG: Se utiliza para escribir mensajes de depuración, este log no debe estar activado cuando la aplicación se
encuentre en producción.

INFO: Se utiliza para mensajes similares al modo "verbose" en otras aplicaciones.

WARN: Se utiliza para mensajes de alerta sobre eventos que se desea mantener constancia, pero que no afectan el
correcto funcionamiento del programa.

ERROR: Se utiliza en mensajes de error de la aplicación que se desea guardar, estos eventos afectan al programa
pero lo dejan seguir funcionando, como por ejemplo que algún parámetro de configuración no es correcto y se carga
el parámetro por defecto.

FATAL: Se utiliza para mensajes críticos del sistema, generalmente luego de guardar el mensaje el programa
abortará.

Adicionalmente a estos niveles de log, existen 2 niveles extras que solo se utilizan en el archivo de configuración,
estos son:

ALL: este es el nivel más bajo posible, habilita todos los logs.

OFF: este es el nivel más alto posible, deshabilita todos los logs.

Appenders

La posibilidad de selectivamente habilitar y deshabilitar ciertos logs es solo una parte del alcance, log4j permite que
los mensajes de logs se impriman en multiples destinos; en Log4J el destino de salida se denomina un appender.

Algunos de los Appenders disponibles son:

ConsoleAppender (org.apache.log4j.ConsoleAppender)

Este appender despliega el log en la consola, tiene las siguientes opciones:

Threshold=WARN: Este parámetro establece que el appender no despliega ningún mensaje con prioridad menor a
la especificada aquí.

ImmediateFlush=true: El valor por defecto es true, esto quiere decir que los mensajes de log no son almacenados
en un buffer, sino que son enviados directamente al destino.

Target=System.err: El valor por defecto es System.out. Establece la salida del sistema a ser utilizada.

FileAppender (org.apache.log4j.FileAppender)

Este appender redirecciona los mensajes de logs hacia un archivo.

Threshold=WARN: Este parámetro establece que el appender no despliega ningún mensaje con prioridad menor a
la especificada aquí.

ImmediateFlush=true: El valor por defecto es true, esto quiere decir que los mensajes de log no son almacenados
en un buffer, sino que son enviados directamente al destino.

File=mylog.txt: Nombre del archivo donde se almacenará el log. Se puede utilizar el nombre de algún property
(${nombre_de_la_propiedad}) para especificar el nombre o la ubicación del archivo.

2

Manual de Log4J

Append=false: El valor por defecto es true, para que los nuevos mensajes de logs se adicionen al archivo existente.
Si se especifica false, cuando se inicie la aplicación el archivo de log se sobreescribirá.

RollingFileAppender (org.apache.log4j.RollingFileAppender)

Este appender redirecciona los mensajes de logs hacia un archivo, se pueden definir politicas de rotación para que el
archivo no crezca indefinidamente.

Threshold=WARN: Este parámetro establece que el appender no despliega ningún mensaje con prioridad menor a
la especificada aquí.

ImmediateFlush=true: El valor por defecto es true, esto quiere decir que los mensajes de log no son almacenados
en un buffer, sino que son enviados directamente al destino.

File=mylog.txt: Nombre del archivo donde se almacenará el log. Se puede utilizar el nombre de algún property
(${nombre_de_la_propiedad}) para especificar el nombre o la ubicación del archivo.

Append=false: El valor por defecto es true, para que los nuevos mensajes de logs se adicionen al archivo existente.
Si se especifica false, cuando se inicie la aplicación el archivo de log se sobreescribirá.

MaxFileSize=100KB: Los sufijos pueden ser KB, MB o GB. Rota el archivo de log cuando alcanza el tamaño
especificado.

MaxBackupIndex=2: Mantiene un máximo de 2 (por ejemplo) archivos de respaldo. Borra los archivos anteriores.
Si se especifica 0 no se mantiene respaldos.

DailyRollingFileAppender
(org.apache.log4j.DailyRollingFileAppender)

Este appender redirecciona los mensajes de logs hacia un archivo, se pueden definir politicas de rotación basados en
la fecha.

Threshold=WARN: Este parámetro establece que el appender no despliega ningún mensaje con prioridad menor a
la especificada aquí.

ImmediateFlush=true: El valor por defecto es true, esto quiere decir que los mensajes de log no son almacenados
en un buffer, sino que son enviados directamente al destino.

File=mylog.txt: Nombre del archivo donde se almacenará el log. Se puede utilizar el nombre de algún property
(${nombre_del_property}) para especificar el nombre o la ubicación del archivo.

Append=false: El valor por defecto es true, para que los nuevos mensajes de logs se adicionen al archivo existente.
Si se especifica false, cuando se inicie la aplicación el archivo de log se sobreescribirá.

DatePattern='.'yyyy-ww: Rota el archivo cada semana Se puede especificar que la frecuencia de rotación sea
mensual, semanal, diaria, 2 veces al día, cada hora o cada minuto. Este valor no solo especifica la frecuencia de
rotación sino el sufijo del archivo de respaldo. Algunos ejemplos de frecuencia de rotación son:

'.'yyyy-MM: Rota el archivo el primero de cada mes
'.'yyyy-ww: Rota el archivo al inicio de cada semana
'.'yyyy-MM-dd: Rota el archivo a la media noche todos los días
'.'yyyy-MM-dd-a: Rota el archivo a la media noche y al media día, todos los días
'.'yyyy-MM-dd-HH: Rota el archivo al inicio de cada hora
'.'yyyy-MM-dd-HH-mm: Rota el archivo al inicio de cada minuto

3

Manual de Log4J

SocketAppender (org.apache.log4j.net.SocketAppender)

Redirecciona los mensajes de logs hacia un servido