Personalização do Log

Introdução

O Quality Manager faz uso da biblioteca Apache log4j 2 para registro e auditoria das mensagens geradas pela aplicação tanto para visualização de possíveis falhas quanto para exibição de mensagens informativas. O sistema conta com uma configuração específica de logs log4j2.xml como visto abaixo (versão 2.58 em diante):

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="INFO" monitorInterval="60">

    <Appenders>
        <RollingFile name="ROLLING_FILE_APPENDER"
                     fileName="${sys:catalina.home}/logs/md2-quality-manager.log"
                     filePattern="${sys:catalina.home}/logs/md2-quality-manager.%d{yyyy-MM-dd}-%i.log">
          <PatternLayout charset="UTF-8" 
          pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} - %c{1} - %msg%n%xEx{
         filters(jdk.internal.reflect, java.lang.reflect,org.jboss.weld,org.hibernate.internal,org.hibernate.hql.internal,
         org.hibernate.engine.jdbc.internal, org.hibernate.loader.Loader, org.hibernate.engine.query, org.hibernate.jpa, 
         org.apache.catalina, org.apache.coyote, org.apache.tomcat, javax.faces, com.sun.faces, 
         org.omnifaces, javax.el, org.apache.el)}"/>
            <Policies>
            	<OnStartupTriggeringPolicy/>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="50 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>

        <Console name="CONSOLE_APPENDER" target="SYSTEM_OUT">
          <PatternLayout charset="UTF-8"
          pattern="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} - %c{1} - %msg%n%xEx{
         filters(jdk.internal.reflect, java.lang.reflect,org.jboss.weld,org.hibernate.internal,org.hibernate.hql.internal,
         org.hibernate.engine.jdbc.internal, org.hibernate.loader.Loader, org.hibernate.engine.query, org.hibernate.jpa, 
         org.apache.catalina, org.apache.coyote, org.apache.tomcat, javax.faces, com.sun.faces, 
         org.omnifaces, javax.el, org.apache.el)}"/>
         </Console>
    </Appenders>

    <Loggers>
        <!-- Root Logger -->
        <Root level="INFO" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </Root>

        <!-- Quality Manager Logger -->
        <Logger name="com.md2net" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </Logger>
        
        <!-- Quartz -->
        <Logger name="org.quartz" level="ERROR" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </Logger>
        
        <!-- Flyway -->
        <Logger name="org.flywaydb" level="INFO" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </Logger>
        
        <!-- Hikari -->
        <Logger name="com.zaxxer.hikari" level="ERROR" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </Logger>
        
         <!-- RESTEASY  -->
        <logger name="org.jboss.resteasy" level="ERROR" additivity="false">
             <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </logger>
        
        <!-- WELD  -->
        <logger name="org.jboss.weld" level="ERROR" additivity="false">
             <appender-ref ref="CONSOLE_APPENDER"/>
            <appender-ref ref="ROLLING_FILE_APPENDER"/>
        </logger>

        <!-- Hibernate -->
        <Logger name="org.hibernate" level="ERROR" additivity="false">
             <appender-ref ref="CONSOLE_APPENDER"/>
        </Logger>
        
       <!-- Hibernate Query -->
        <Logger name="org.hibernate.SQL" level="OFF" additivity="false">
            <appender-ref ref="CONSOLE_APPENDER"/>
        </Logger>
      
         <!-- Hibernate Query Params -->
        <Logger name="org.hibernate.type.descriptor.sql" level="OFF" additivity="false">
           <appender-ref ref="CONSOLE_APPENDER"/>
        </Logger>
	    
    </Loggers>
</Configuration>

Acima, pode-se ver que a aplicação dispõe de dois appenders que propagam o registro do log de maneiras distintas: Pela rotação de arquivos e pelo console (stdout)

Rotação em arquivo: Nesta modalidade de log, a aplicação gera uma série de arquivos com prefixo md2-quality-manager-*.log que irá conter todas as mensagens registradas pelos loggers. Este arquivo é regido por políticas quanto ao seu tamanho, tempo e propagação. Este arquivo é disponibilizado pela tela de Interface e Administração para Diagnóstico como mecanismo de diagnóstico de problemas ocorridos em execução.
Console: Nesta modalidade de log, a aplicação gera o registro do log no fluxo de saída (stdout) para visualização no console.

Existem nove Loggers explicitos no arquivo (excluindo o root) para implementação dos appenders sendo eles:

Quality Manager Logger: Controla as mensagens de log geradas pela aplicação.
Quartz Logger: Controla as mensagens exibidas pelo Quartz (Scheduler)
Flyway Logger: Controla as mensagens exibidas pelo Flyway (Migração de Banco)
Hikari Logger: Controla as mensagens exibidas pelo Hikari (Pool de Conexões)
RestEasy Logger: Controla as mensagens exibidas pelo RestEasy (API rest)
Weld Logger: Controla as mensagens exibidas pelo Weld (Injeção de Dependências)
Hibernate Logger: Controla as mensagens exibidas pelo Hibernate (ORM)
Hibernate (SQL) Logger: Controla a exibição das queries geradas pelo Hibernate (Apenas em nível DEBUG)
Hibernate (Type Descriptor) Logger: Controla a exibição dos parâmetros das queries (Apenas em nível TRACE)

Por padrão, a aplicação utiliza o PatternLayout para especificar o formato geral das mensagens como ilustrado abaixo. Todas as mensagens iniciam-se pelo seu nível, data/hora do evento, classe responsável, a mensagem e a stacktrace da exceção (se houver)

Classificação quanto ao nível

O log4j faz uso de diferentes níveis de acordo com a criticidade do evento através dos 6 primeiros níveis (TRACE, DEBUG, INFO, WARN, ERROR e FATAL). Os níveis restantes (ALL e OFF) apenas determinam se a captura dos logs está ativada ou não. A exibição das mensagens quanto ao nível segue abaixo:

Exibição por nível	TRACE	DEBUG	INFO	WARN	ERROR	FATAL
TRACE	Sim	Sim	Sim	Sim	Sim	Sim
DEBUG	Não	Sim	Sim	Sim	Sim	Sim
INFO	Não	Não	Sim	Sim	Sim	Sim
WARN	Não	Não	Não	Sim	Sim	Sim
ERROR	Não	Não	Não	Não	Sim	Sim
FATAL	Não	Não	Não	Não	Não	Sim
ALL	Sim	Sim	Sim	Sim	Sim	Sim
OFF	Não	Não	Não	Não	Não	Não

O Quality Manager faz uso dos níveis de alguns níveis acima para registrar os diferentes eventos ocasionados pelo sistema de acordo com a relação abaixo:

Exibição por nível	Tipo de mensagem
TRACE	Mensagens para o contexto de depuração. Irá registrar a modificação sofrida pelas entidades no banco de dados juntamente com sua chave primária no banco de dados. O formato padrão da mensagem que será exibida é: "Uma instância da entidade [X] foi <inserida \| atualizada \| removida>. ID [Y]"
DEBUG	Mensagens para o contexto de depuração. Irá registrar as ações realizadas no sistema por usuário e por módulo (Navegação, criação ou modificação de registros e etc). O formato padrão desta mensagem para navegação é "Usuário [X] acessou o módulo [Y]" e para ações é "Usuário [X] no módulo [Y] realizou ação Z"
INFO	Mensagens com caráter informativo. Irá registrar as mensagens de inicialização do Quality Manager e a execução das tarefas automatizadas (notificações, envio de emails, expurgos e etc)
WARN	Mensagens para indicar avisos. Irá registrar de falhas em teste de conexão (LDAP, MDM) e informações quanto ao limite gerenciado pelo Licenciamento de Arquivos
ERROR	Mensagens para indicar erros. Irá registrar falha na execução de alguma ação que pode representar um problema com a aplicação

Para controlar a exibição das mensagens, o usuário pode colocar uma cópia do arquivo log4j2.xml na pasta conf do Tomcat antes da inicialização do Quality Manager. Para personalização do nível configurado no nível TRACE, por exemplo, basta alterar a propriedade level em Logger conforme abaixo:

<!-- Quality Manager Logger -->
<Logger name="com.md2net" level="TRACE" additivity="false">
  <appender-ref ref="CONSOLE_APPENDER"/>
  <appender-ref ref="ROLLING_FILE_APPENDER"/>
</Logger>

Por padrão, o arquivo monitora as alterações no arquivo em tempo de execução a cada um minuto. Para modificar esta configuração em 30 segundos, por exemplo, altere a propriedade monitorInterval em Configuration com o valor em segundos:

<Configuration status="INFO" monitorInterval="30">

Personalização do Log

Introdução

Classificação quanto ao nível

No Comments