Configurando o Log4j para o Tomcat 5.5

Colaboração: Danilo Egea Gondolfo

Log4j é um Framework utilizado para o desenvolvimento de Softwares que necessitam de recursos de geração de logs. Bem, o Tomcat já possui estes recursos, basta que sejam ativados. Segue os passos para ativar a geração de logs e o rotacionamento de arquivos de log:

Baixe o Log4j e o commons-logging:

• Log4j ->http://logging.apache.org/site/binindex.cgi
• Commons-logging ->http://jakarta.apache.org/site/downloads/downloads_commons-logging.cgi

Descompacte os dois arquivos, entre no diretório descompactado do Log4j vá em dist/lib, copie o .jar para $TOMCAT_HOME/common/lib

Agora entre no diretório descompactado do commons-logging, copie o commons-logging-x.x.jar para $TOMCAT_HOME/common/lib

Crie o arquivo de configuração log4j.properties dentro de $TOMCAT_HOME/common/classes

Conteúdo e descrição do arquivo:

  # Início - log4j.properties
  log4j.rootLogger=INFO, LOG
  log4j.appender.LOG=org.apache.log4j.RollingFileAppender
  log4j.appender.LOG.layout=org.apache.log4j.PatternLayout
  log4j.appender.LOG.layout.ConversionPattern=%d [%t] %p %c - %m%n
  log4j.appender.LOG.File=$TOMCAT_HOME/logs/catalina.out
  log4j.appender.LOG.MaxFileSize=10MB
  log4j.appender.LOG.MaxBackupIndex=10
  # Fim

Conceitos importantes:

Appender - Qual os destinos das mensagens de log (arquivos, console, email etc.).

Layout - Formatação das mensagens de log.

log4j.rootLogger=INFO, LOG -> Define o nível das mensagens de log e um nome para o appender, os níveis podem ser: INFO, DEBUG, WARN, ERROR, FATAL, ALL e OFF.

log4j.appender.LOG=org.apache.log4j.RollingFileAppender -> Define o appender, neste caso o appender RollingFileAppender é utilizado para rotacionar os arquivos de log. Existem vários appenders diferentes, como por exemplo SMTPAppender utilizado para enviar as mensagens de log por email.

log4j.appender.LOG.layout=org.apache.log4j.PatternLayout -> Define qual layout (formatação das mensagens) será usado, PatternLayout depende da regra abaixo.

log4j.appender.LOG.layout.ConversionPattern=%d [%t] %p %c - %m%n -> Personalização da saída das mensagens, descrição:

• %d - Mostra a data e a hora em que a mensagem foi gerada.
• %t - Mostra qual thread gerou a mensagem.
• %p - Mostra o nível das mensagens.
• %c - Mostra a classe que gerou o erro.
• %m - Mostra a mensagem de log.
• %n - Quebra a linha.

Exemplo:

• 2006-06-20 15:20:26,122 [main] INFO org.apache.catalina.startup.Catalina - Server startup in 54689 ms
• log4j.appender.LOG.File=$TOMCAT_HOME/logs/catalina.out -> Caminho onde será armazenado o arquivo de log.
• log4j.appender.LOG.MaxFileSize=10MB -> Tamanho máximo que o arquivo pode atingir antes de ser rotacionado.
• log4j.appender.LOG.MaxBackupIndex=10 -> Numero de arquivos utilizados para o rotacionamento.

Depois de tudo isso basta iniciar o Tomcat para que Log4j entre em ação.