Log4j

Introducción

Es una librería de código abierto 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 en tiempo de ejecución y no en tiempo de compilación como se realizaba comúnmente.

Las responsabilidades de este componente son:

• Definir las acciones a registrar
• Definir para cada una de las acciones registradas el nivel de evento.
• Definir las salidas y formato del log

La primera ventaja que ofrece, cualquier API de logging con respecto al sistema tradicional es la categorización de varios tipos de logs, permitiendo que estén o no habilitados en función de decisiones del programador.Log4j tiene tres componentes principales Logger, Appender y Layout. Estos tres componentes trabajan juntos para permitir a los desarrolladores generar mensajes según las acciones y niveles de los eventos, además de controlar el formato y almacenamiento de estos mensajes. Log4j, presenta cinco niveles de prioridad para los mensajes que se estructuran de la siguiente manera:

Otra de las posibilidades de Log4j es poder imprimir los mensajes en múltiples destinos , en Log4j  el destino de salida se denomina "Appender" . A continuación ofrecemos  los "appenders" mas utiles:

Existe una capa de Layout que permite al desarrollador definir el formato de los mensajes que se envían por el log. A continuación se comentan los layouts mas importantes:

Usos y Ventajas conocidas

• Utilizado en la generación de trazas por JBoss
• Aplicaciones comerciales (ejemplo REGAC)
• Framework Principado de Asturias OPENFWPA

Ejemplo de uso

En el siguiente ejemplo la clase MyApp primero importa las clases relacionadas de log4j, luego define una variable estática de tipo Logger con el nombre de la clase MyApp.class y finalmente invoca al método BasicConfigurator.configure que crea una configuración de log4j con un ConsoleAppender y define el PatternLayout a "%-4r %t %-5p %c %x - %m%n".

import com.foo.Bar;
// Importa las clases de log4j.
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;

public class MyApp {
// Define una variable estática que tiene una referencia
// a una instancia de Logger llamada "MyApp".
   static Logger logger = Logger.getLogger(MyApp.class);

   public static void main(String[] args) {
     // Crea una simple configuración a la consola
      BasicConfigurator.configure();
      logger.info("Entrando en la aplicación.");
      Bar bar = new Bar();
      bar.doIt();
      logger.info("Saliendo de la aplicación.");
   }
}

MyApp utiliza la clase Bar del paquete com.foo, la cual ya no tiene que configurar el log sino únicamente utilizarlo.

package com.foo;
import org.apache.log4j.Logger;

public class Bar {
    static Logger logger = Logger.getLogger(Bar.class);
    public void doIt() {
       logger.debug("Dentro de Bar!");
    }
}

La salida en el log sería:

0 [main] INFO MyApp - Entrando en la aplicación.
36 [main] DEBUG com.foo.Bar - Dentro de Bar!
51 [main] INFO MyApp - Saliendo de la aplicación.