leggi anche questa guida
Il root logger risiede al top della gerarchia del logger.
Tutti i logger sono istanziati e restituiti con il metodo statico
Logger.getLogger(String name);
dove name è il nome de logger desiderato.
package org.apache.log4j;
public class Logger {
// Creation & retrieval methods:
public static Logger getRootLogger();
public static Logger getLogger(String name);
// printing methods:
public void debug(Object message);
public void info(Object message);
public void warn(Object message);
public void error(Object message);
public void fatal(Object message);
// generic printing method:
public void log(Level l, Object message);
}
Ad un logger può essere assegnato dei livelli. Il set possibile di livelli è DEBUG, INFO, WARN, ERROR, FATAL e sono definiti nella classe org.apache.log4j.Level.
Si possono definire sotto classi, ma questo è sconsigliati.
Le richieste di logging sono fatte invocando uno dei metodi di printing dell'istanza di logger che sono: debug, info, warn, error, fatal e log.
Il metodo di printing determina il livello della richiesta di logging. Per esempio, se c è un'istanza di un logger, allora l'istruzione c.info('..') è una richiesta di logging di livello INFO.
Una richiesta di logging è definita enabled se il suo livello è maggiore uguale del livello del suo logger. Altrimenti la richiesta e definita disabled.Un logger senza un livello assegnato ne eredita uno dalla gerarchia. Questa regole è riassunta sotto:
Basic Selection Rule
Una richiesta di log di livello p è enabled se p>=q dove q è il livello associato al logger.
DEBUG<INFO<WARN<ERROR<FATAL<LOG<ALL
Es.
// get a logger instance named "com.foo"
Logger logger = Logger.getLogger("com.foo");
// Now set its level. Normally you do not need to set the
// level of a logger programmatically. This is usually done
// in configuration files.
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
// This request is enabled, because WARN >= INFO.
logger.warn("Low fuel level.");
// This request is disabled, because DEBUG < INFO.
logger.debug("Starting search for nearest gas station.");
// The logger instance barlogger, named "com.foo.Bar",
// will inherit its level from the logger named
// "com.foo" Thus, the following request is enabled
// because INFO >= INFO.
barlogger.info("Located nearest gas station.");
// This request is disabled, because DEBUG < INFO.
barlogger.debug("Exiting gas station search");
import com.foo.Bar;
// Import log4j classes.
import org.apache.log4j.Logger;
import org.apache.log4j.BasicConfigurator;
public class MyApp {
// Define a static logger variable so that it references the
// Logger instance named "MyApp".
static Logger logger = Logger.getLogger(MyApp.class);
public static void main(String[] args) {
// Set up a simple configuration that logs on the console.
BasicConfigurator.configure();
logger.info("Entering application.");
Bar bar = new Bar();
bar.doIt();
logger.info("Exiting application.");
}
}
Appenders e Layout
Log4j permette che richieste di logging siano stampate su destinazioni multiple. Ciascuna di questa destinazione viene definita appender. Attualmente gli appenders esistono per:
- console
- file
- componenti GUI
- remote socket
- servers
- JMS
- NT Event Loggers
- processi demonit remote UNIX Syslog
Per aggiungere un appender ad un logger si usa il metodo addAppender. Ogni richiesta logging enabled per un certo logger sara rigirato a tutti gli appender del logger così come a tutti gli appender più in alto nella gerarchia.
Si può associare anche layout ad un appender. Si può fare questo usando il PatternLayout che permette di specificare il formato di output in accordo ad un pattern di conversione simile al sintassi della funzione printf del linguaggio C.
Per esempio:
%r[%t]%-5p %c - %m%n
da l'output:
176 [main] INFO org.foo.Bar - Located nearest gas station.
dove il primo campo è il numero di millisecondi passati dallo start del programma. Il secondo è il thread che ha fatto il log request. Il terzo è il livello di un'istruzione di log. Il quarto p il nome del logger associato con il la richiesta di log. %m%n stampa il testo del messaggio.
%5p indica il tpo di priorità del messaggio (WARN, DEBUG, ecc.);
[%t] indica il nome del thread che ha generato il messaggio;
%F nome del file da cui è partita la chiamata;
%L numero di linea che ha prodotto l’output;
%m Mio eventuale messaggio;
%n new line (a capo);
%c Categoria che ha scatenato il log.
Alcuni tipi di appender:
- ConsoleAppender individua come flusso di default quello a monitor, ma è configurabile.
- FileAppender per scrivere su un file.
- RollingFileAppender che permette di definire un file di default con una grandezza massima. Una volta raggiunta tale dimensione ne crea un secondo, cancellando quello vecchio. Si indica il numero massimo di files di backup.
- DailyRollingFileAppender come precedente ma fa un discorso di tipo giornaliero
Il pattern può essere
- PatternLayout
- HTMLLayout
- XMLLayout
- TTCCLayout
Configurazione
L'ambiente log4ij è pienamente configurabile programmaticamente. Comunque la configurazione log4j attraverso file è più flessibile. Il file di configurazione può essere scritto in XML o in un Java properties del formato key=value.
Un invocazione al metodo BasicConfiguration.configure crea un semplice setup log4j. Questo metodo è usato per aggiungere un ConsoleAppender ad un root logger. L'output sarà formattato usanfo un PatterLayout.
Alcuni file di configurazione di esempio:
# Set root logger level to DEBUG and its only appender to A1.
log4j.rootLogger=DEBUG, A1
# A1 is set to be a ConsoleAppender.
log4j.appender.A1=org.apache.log4j.ConsoleAppender
# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n
----------------------------------------------------------------------------------------------------
log4j.rootLogger=DEBUG, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
# Print the date in ISO 8601 format
log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n
# Print only messages of level WARN or above in the package com.foo.
log4j.logger.com.foo=WARN
----------------------------------------------------------------------------------------------------
log4j.rootLogger=debug, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
Nota: Il file log4j.properties deve trovarsi nella stessa directory della classe che lo usa. Es: WEB-INF/classes.