Hoje em dia é muito comum utilizar uma API de logging de mensagens como o Log4j para indicar os comportamentos de uma aplicação.

Transcrição

1 Introdução Hoje em dia é muito comum utilizar uma API de logging de mensagens como o Log4j para indicar os comportamentos de uma aplicação. O Log4j é um é um projeto open source distribuído pela Apache Software License e foi portado por autores independentes a C, C++, Python, ruby, Eiffel. Instalando Para utilizar o Log4j, você precisa: Baixar o Log4j: Adicionar o jar do Log4j no classpath Lo4j Hello World package log; import org.apache.log4j.basicconfigurator; import org.apache.log4j.logger; public class HelloWorld { static Logger logger = Logger.getLogger(HelloWorld.class); static public void main(string[] args) { logger.debug("hello world."); Ao executar essa classe, ele não produzirá nenhum logging, mas lançará o seguinte warning: log4j:warn No appenders could be found for logger (log.helloworld). log4j:warn Please initialize the log4j system properly. O Log4j está reclamando porque nós ainda não o configuramos. Existem várias formas de configurar o Log4j. A forma mais simples e menos flexível é chamando o método: BasicConfigurator.configure(); Agora que já sabemos a causa dos warnings gerados, vamos modificar a classe HelloWorld.

2 package log; import org.apache.log4j.*; public class HelloWorld { static Logger logger = Logger.getLogger(HelloWorld.class); static public void main(string[] args) { BasicConfigurator.configure(); logger.debug("hello world."); Ao executar a classe acima, será gerada a seguinte saída: A saída contém: 10 [main] DEBUG log.helloworld Hello world. O tempo relativo, isto é, o número de millisegundos que transcorreram até a invocação do logging. O nome da thread invocada entre colchetes. O nível do logger. O nome do logger e a mensagem. Receita para utilizar o Log4j em suas aplicações: 1 Configurar o Log4j para o seu ambiente. Como foi dito anteriormente, o Log4j oferece diversas maneiras de configuração. 2 Em toda classe que você deseje utilizar logging, recupere um objeto Logger invocando o método Logger.getLogger() passando uma String, normalmente o nome da classe completo. O objeto Logger é geralmente declarado como static final. Há uma variação do método Logger.getLogger(). Para uma classe HelloWorld em uma pacote com.log, os seguintes expressões são equivalentes: Logger.getLogger( com.log.helloworld ); Logger.getLogger(HelloWorld.class.getName()); Logger.getLogger(HelloWorld.class);

3 3 Utilize a instância de Logger para invocar os métodos: debug(), info(), warn(), error(), fatal() Ou o método mais genérico: log() Logger Uma das principais vantagens de qualquer API de logging sobre a simples System.out.println, reside na possibilidade de desabilitar certas declarações de log enquanto outras permitidas são exibidas. O logger é o núcleo do processo de logging. No Log4j existem 5 níveis normais de logger disponíveis: static Level DEBUG O nível DEBUG designa informações úteis para debugar uma aplicação. static Level INFO O nível INFO designa informações que focalizam no progresso da aplicação. static Level WARN O nível WARN designa situações potencialmente prejudiciais. static Level ERROR O nível ERROR designa eventos de erro que poderão permitir que a aplicação continue funcionando. static Level FATAL O nível FATAL designa eventos de erro severos que presumivelmente poderão interromper a aplicação. Os métodos ALL e OFF são intencionados somente para o gerenciamento. Appender O Log4j permite exibir logs em múltiplos destinos. Um Appender controla como será a saída do log. Os Appenders pode ser:

4 ConsoleAppender Eventos de log System.out ou System.err, usando um layout especificado pelo usuário. DailyRollingFileAppender Estende FileAppender sobrescrevendo o arquivo. FileAppender Adiciona eventos de log em um arquivo. RollingFileAppender Estende FileAppender e realiza backup dos arquivos de log dado um certo tamanho. WriterAppender Adiciona eventos de log em um Writer ou OutPutStream, dependendo da escolha do usuário. SMTPAppender Envia um quando um evento de log específico ocorre. Tipicamente nos erros fatais. SocketAppender Envia objetos de log para servidor de log remoto. SocketHubAppender Envia objetos de log para ajuste de servidores de log remotos. SyslogAppender Envia mensagens para um syslog daemon remoto. TelnetAppender É um Appender especializado em escrever sockets read-only. Utilizando os principais Appenders

5 ConsoleAppender O ConsoleAppender, como o nome diz, adiciona no console, ou precisamente em System.out ou System.err formatando eventos com o layout especificado pelo usuário. Exemplo: ConsoleAppender appender = new ConsoleAppender(new PatternLayout()); O código acima cria um ConsoleAppender, com o default PatternLayout. FileAppender O FileAppender, uma sub-classe de WriterAppender, adiciona eventos de log em um arquivo. Exemplo: FileAppender appender = null; try { appender = new FileAppender(new PatternLayout(),"myfile.log"); catch(exception e) { WriterAppender O WriterAppender adiciona eventos para um java.io.writer. Exemplo: WriterAppender appender = null; try { appender = new WriterAppender(new PatternLayout(),new FileOutputStream("filename")); catch(exception e) { Layouts Os layouts são responsáveis pelo formato de saída dos logs. Os três principais tipos de layouts são: HTMLLayout Formata a saída do log como uma tabela HTML.

6 package log; import java.io.*; import org.apache.log4j.*; public class HTMLExample{ static Logger logger = Logger.getLogger(HTMLExample.class); public static void main(string args[]){ // cria o layout HTMLLayout layout = new HTMLLayout(); // cria o appender do tipo WriterAppender WriterAppender appender = null; try { // cria o arquivo HTML FileOutputStream output = new FileOutputStream("output.html"); // cria um WriterAppender passando o layout e o file appender = new WriterAppender(layout,output); catch(exception e) { // logando uma exception, caso ocorra logger.error("erro: " + e.getmessage()); // adicionando o appender criado ao logger logger.addappender(appender); // ajustando o nível do log logger.setlevel((level) Level.DEBUG); // logando logger.debug("logando um DEBUG"); logger.info("logando um INFO"); logger.warn("logando um WARN"); O resultado será parecido com esse:

7 PatternLayout Formata a saída do log baseado em um padrão de conversão. O PatternLayout retorna uma String que pode ser modificada pela conversão de pattern. A conversão de pattern é composta de um literal e de um especificador de conversão. Cada conversão começa com um sinal de porcentagem (%) e é seguido por um modificador de formato opcional e um caractere de conversão. O caractere de conversão controla o tipo de dado para uso: nome do logger, data, thread.

8 Relação dos principais caracters de conversão: %C exibe o nome da classe %D exibe a data do evento de log %l exibe o método que chamou o evento de log %L exibe a o número da linha onde o evento de log foi requisitado %m exibe a mensagem %M o método em que o evento de log foi requisitado %p exibe o nível do evento de log %r exibe o número de milisegundos passados desde o início do evento de log %t exibe o nome da thread que gerou o evento de log %n quebra de linha Exemplo: package log; import org.apache.log4j.*; public class PatternLayoutExample{ static Logger logger = Logger.getLogger(PatternLayoutExample.class); public static void main(string args[]) { // criando um output pattern String padrao_log = "Milisegundos desde o ínicio do programa: %r %n"; padrao_log += "Classe: %C %n"; padrao_log += "Data: %d{dd/mm/yyyy %n"; padrao_log += "Hora: %d{hh:mm:ss %n"; padrao_log += "Local: %l %n"; padrao_log += "Mensagem: %m %n"; padrao_log += " %n"; // criando um PatternLayout passando o output pattern criado PatternLayout layout = new PatternLayout(padrao_log); // criando um ConsoleAppender passando o layout criado ConsoleAppender appender = new ConsoleAppender(layout); // adicionando o appender ao logger logger.addappender(appender); // ajustando o nível logger.setlevel((level) Level.DEBUG);

9 // logando logger.debug("logando um DEBUG"); logger.info("logando um INFO"); logger.warn("logando um WARN"); SimpleLayout Formata a saída do log de uma maneira muito simples: exibindo o nível, um traço e após, a mensagem de log. Exemplo: package log; import org.apache.log4j.*; public class SimpleLayoutExample{ static Logger logger = Logger.getLogger(SimpleLayoutExample.class); public static void main(string args[]){ // cria o layout SimpleLayout layout = new SimpleLayout(); // cria o appender do tipo FileAppender FileAppender appender = null; try{ /* criação do FileAppender passando o layout, nome do arquivo, true se o arquivo será sobrescrito e false se não for sobrescrito */ appender = new FileAppender(layout,"output.log",true); catch(exception e){ // logando uma exception, caso ocorra logger.error("erro: " + e.getmessage()); // adicionando o appender criado ao logger logger.addappender(appender); // ajustando o nível do log logger.setlevel((level) Level.DEBUG);

10 // logando logger.info("logando um INFO"); Até a próxima!!! Comentários, críticas ou sugestões: javaplayer@hotmail.com Referências Log4j The Complete Manual