Log4j

Log4j es una biblioteca open source desarrollada en Java por la Apache Software Foundation que permite a los desarrolladores de software elegir la salida y el nivel de granularidad de los mensajes o “logs” (logging) a tiempo de ejecución y no a tiempo de compilación como es comúnmente realizado. La configuración de salida y granularidad de los mensajes es realizada a tiempo de ejecución mediante el uso de archivos de configuración externos. Log4J ha sido implementado en otros lenguajes como: C, C++, C#, Perl, Python, Ruby y Eiffel.

Conceptos

Niveles de prioridad de los mensajes

Por defecto Log4J tiene 6 niveles de prioridad para los mensajes (trace, debug, info, warn, error, fatal). Además existen otros dos niveles extras (all y off):

Niveles de prioridad (De mayor -poco detalle- a menor -mucho detalle-):

• FATAL: se utiliza para mensajes críticos del sistema, generalmente después de guardar el mensaje el programa abortará.

• 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.

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

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

• DEBUG: se utiliza para escribir mensajes de depuración. Este nivel no debe estar activado cuando la aplicación se encuentre en producción.

• TRACE: se utiliza para mostrar mensajes con un mayor nivel de detalle que debug.

Extras:

• ALL: este es el nivel de máximo detalle, habilita todos los logs (en general equivale a TRACE).

• OFF: este es el nivel de mínimo detalle, deshabilita todos los logs.

Appenders

En Log4J los mensajes son enviados a una (o varias) salida de destino, lo que se denomina un appender.

Existen varios appenders disponibles y configurados, aunque también podemos crear y configurar nuestros propios appenders.

Típicamente la salida de los mensajes es redirigida a un fichero de texto .log (FileAppender, RollingFileAppender), a un servidor remoto donde almacenar registros (SocketAppender), a una dirección de correo electrónico (SMTPAppender), e incluso en una base de datos (JDBCAppender).

Casi nunca es utilizado en un entorno de producción la salida a la consola (ConsoleAppender) ya que perdería gran parte de la utilidad de Log4J.

Layouts

Es el responsable de dar un formato de presentación a los mensajes.

Permite presentar el mensaje con el formato necesario para almacenarlo simplemente en un archivo de texto .log (SimpleLayout y PatternLayout), en una tabla HTML (HTMLLayout), o en un archivo XML (XMLLayout).

Además podemos añadir información extra al mensaje, como la fecha en que se generó, la clase que lo generó, el nivel que posee...

Configuración

La API es totalmente configurable, ya que se realiza mediante un archivo en formato XML o en formato Java Properties (clave=valor), generalmente llamado log4j.properties.

En el siguiente ejemplo implementamos un fichero properties de configuración, y configuramos dos registros.

• CONSOLE imprimirá los mensajes en la consola por líneas (%m%n).
• LOGFILE añadirá (append) los mensajes a un fichero (aplicación.log), reservando los primeros 4 caracteres para los milisegundos en que se generó el mensaje (%-4r), entre corchetes quién generó el mensaje ( [%t]), cinco espacios para la prioridad del mensaje (%-5p), la categoría del mensaje (%c) y finalmente el propio mensaje junto con un retorno de carro (%m%n).

 ################################################################
 ### Configuración para LOCAL                                 ###
 ################################################################
 #log4j.rootCategory=DEBUG, LOGFILE, CONSOLE 
 
 #log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
 
 #log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
 #log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
 #log4j.appender.CONSOLE.layout.ConversionPattern=%-5p %c %x - %m%n 
 
 
 ################################################################
 ### Configuración para DESARROLLO, PREPRODUCCION, PRODUCCION ###
 ###   Sólo nos interesa el nivel de ERROR    		       ###
 ###   No hay salida de consola			       ###
 ################################################################
 log4j.rootCategory=ERROR, diario
 
 
 ################################################################
 ### Configuración Común		  		       ###
 ################################################################
 log4j.appender.LOGFILE=org.apache.log4j.DailyRollingFileAppender
 log4j.appender.LOGFILE.file=${catalina.base}/logs/aplicacion.log
 log4j.appender.LOGFILE.append=true
 log4j.appender.LOGFILE.DatePattern='.'yyyy-MM-dd
 
 log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
 log4j.appender.LOGFILE.layout.ConversionPattern=%-4r [%t] %-5p %c - %m%n

Uso

Para utilizarlo debemos por supuesto importar las clases que necesitamos de Log4J en nuestro código.

A continuación debemos definir una variable estática del tipo org.apache.log4j.Logger con el nombre de la clase que va a escribir en el registro.

Finalmente debemos configurar el objeto Logger.

• Podemos utilizar la configuración básica, invocamos el método org.apache.log4j.BasicConfigurator.configure que configura el registro como un ConsoleAppender y un PatternLayout también predefinido.
• Podemos configurar la API del Log4J también en el mismo código.
• Podemos leer la configuración de nuestro fichero log4j.properties, donde definimos el nivel mínimo que debe poseer la traza para ser almacenada en el registro, el o los appenders que utilizaremos, y sus correspondientes layouts. Por defecto al instanciar un Logger Log4J busca en la raíz del classpath de la aplicación un fichero llamado log4j.properties para configurarse.

Un ejemplo para esta última opción:

 private static org.apache.log4j.Logger registro;
 		try {
 			URL url = Loader.getResource("log4j.properties");
 			PropertyConfigurator.configure(url);
 			registro = Logger.getLogger(CreaTrazas.class);
 System.out.println ("[" + url.toString() + "] Logger inicializado.");
 		} catch (Exception e) {
 			BasicConfigurator.configure();
 			registro = Logger.getLogger(CreaTrazas.class);
 System.out.println ("Excepción al inicializar el log: " + e.toString());
 		}

Lo más útil y flexible en los entornos empresariales reales es utilizar la última opción (archivos de configuración).

Enlaces externos

• Official Log4j Homepage
• Log4j Javadocs
• Log4j Wiki
• Log::Log4perl módulo Perl en CPAN
• Complete log4j manual (comercial)
• Log4J en Lyckapedia
• Manual Corto de Log4j