A aplicação IBM® Enterprise Records inclui um ficheiro log4j.properties de exemplo que pode configurar.
O ficheiro log4j.properties está localizado na pasta ier_install_path\RecordsManagerSweep e pode configurar o comportamento da criação de registo, especificando valores no ficheiro para as seguintes propriedades:
É atribuído um nível a cada logger no ficheiro log4j.properties. Se não atribuir um nível a um logger, o ficheiro log4j atribui automaticamente o nível do logger ascendente ao logger sem atribuição. Por predefinição, é atribuído o nível WARN ao logger.
Pode configurar o ficheiro log4j.properties com definições diferentes de logger, appender e layout. O ficheiro log4j.properties tem de estar disponível para a aplicação durante a execução a partir do caminho da classe. Pode excluir entradas no ficheiro de exemplo, adicionando um prefixo na instrução com um símbolo de cardinal (#). As entradas assinaladas com o símbolo de cardinal (#) são ignoradas durante a execução.
Para abrir o ficheiro log4j.properties, aceda à pasta ier_install_path\RecordsManagerSweep e, em seguida, abra o ficheiro utilizando um editor de texto.
É necessário definir primeiro o logger. Pode ter vários loggers para classificar o tipo de criação de registo necessário para a aplicação. Para activar a criação de registos para todas as classes de com.filenet.rm e dos respectivos sub-pacotes, especifique o logger conforme indicado na instrução seguinte:
log4j.logger.com.filenet.rm
Em alternativa, pode especificar qualquer nome para o logger. Por exemplo, pode atribuir o nome APILOG para o logger conforme demonstrado na instrução seguinte:
log4j.logger.com.filenet.rm=warn, APILOG
É necessário definir um nível de criação de registo para estabelecer o nível de detalhes das mensagens gravadas pelo ficheiro log4j durante a execução. O ficheiro log4j suporta cinco níveis normais de registo, conforme apresentado na tabela abaixo:
Nível | Descrição |
---|---|
DEBUG | Designa eventos informativos de granularidade fina, muito úteis para depurar aplicações. |
INFO | Designa mensagens informativas que destacam o progresso da aplicação a nível de granularidade grossa. |
WARN | Designa situações potencialmente prejudiciais. |
ERROR | Designa eventos de erro que podem continuar a permitir que a aplicação permaneça em execução. |
FATAL | Designa vários eventos de erro grave que podem fazer com que a aplicação deixe de ser executada. |
Consulte a documentação sobre o ficheiro log4j no sítio da Web da Apache, para obter informações sobre níveis de registo especiais e personalizados. Por predefinição, a aplicação é iniciada no nível WARN. Este nível pode ser modificado para os níveis DEBUG, INFO, ERROR, WARN ou FATAL durante a execução. Pode também incluir várias instruções de logger, cada uma para o mesmo logger mas com níveis diferentes (tais como DEBUG para um e WARN para outro). Pode excluir um deles no ficheiro de exemplo, adicionando um prefixo na instrução com um símbolo de cardinal (#). Em seguida, alterne entre os níveis DEBUG e WARN, conforme necessário. As entradas assinaladas com o símbolo de cardinal (#) são ignoradas durante a execução. Um logger sem um nível atribuído herda automaticamente o nível do logger ascendente. Por predefinição, o nível WARN é atribuído ao logger da API no IBM Enterprise Records.
Um logger é associado a um ou mais appenders para permitir que as respectivas mensagens de registo sejam gravadas no suporte de saída. Pode definir diferentes tipos de appenders no ficheiro log4j.properties que envia a informação do registo para a localização de saída especificada. A tabela seguinte indica uma lista de todos os appenders utilizados no ficheiro log4j.properties juntamente com descrições resumidas e opções relacionadas.
Appender | Descrição e fragmentos de código |
---|---|
NTEventLogAppender | Anexo ao registo de eventos do Microsoft Windows NT. Este appender apenas pode ser instalado e utilizado num sistema Windows.
|
ConsoleAppender | Anexa mensagens do registo à sequência System.out (a predefinição) ou System.err utilizando um esquema especificado pelo utilizador.
Opções:
|
FileAppender | Anexa mensagens do registo a um ficheiro.
Opções:
|
RollingFileAppender | Expande FileAppender para criar uma cópia de segurança dos ficheiros de registo quando estes atingem um determinado tamanho.
Opções:
|
Pode definir diferentes esquemas no ficheiro log4j.properties que especificam o formato da mensagem do registo. Pode especificar que as mensagens do registo incluem a data, hora, nome do módulo e nome da sessão, entre outras informações. Estas definições de configuração são utilizadas durante a execução ao criar o registo da mensagem.
A tabela seguinte fornece uma lista de todas as estruturas utilizadas no ficheiro log4j.properties do IBM Enterprise Records juntamente com descrições resumidas e opções.
Esquema | Descrição e fragmento de código |
---|---|
SimpleLayout | Imprime o nível, em seguida um traço (-) seguido pelo texto da mensagem do registo.
|
PatternLayout | Formata os eventos de criação de registos de acordo com um padrão de conversão especificado. Os padrões de conversão são constituídos por texto literal e especificadores de conversão. O texto literal é emitido tal como está. Os especificadores de conversão são constituídos pelo carácter % seguido por um modificador de formato opcional e por um carácter de conversão obrigatório. Por exemplo, %-5p [%t]: %m%n é um padrão de conversão constituído por um especificador de conversão de prioridade, seguido pelo texto literal " [". Esta cadeia é seguida por um especificador de conversão de sessão, seguido pelo texto literal text "]: ". Esta cadeia é seguida por um especificador de conversão de mensagem e um separador de linha dependente do sistema.
Opções:
|
HTMLLayout | Formata a saída como tabela HTML.
Opções:
|
Formata a saída como XML.
Opções:
|
O ficheiro log4j.properties fornecido com o IBM Enterprise Records utiliza o formato de mensagem de registo PatternLayout. A tabela seguinte indica uma lista dos padrões de conversão que podem ser declarados no ficheiro de configuração juntamente com descrições resumidas.
Padrão | Descrição |
---|---|
%t | O nome da sessão que cria o pedido de registo |
%c | O nome do logger associado ao pedido de registo |
%-60c | Alinhar à esquerda o nome do logger com um mínimo de 60 espaços |
%r | O número de milissegundos decorridos desde o início da aplicação |
%p | O nível da instrução do registo |
%m | Mensagem |
%Time | A hora em que o registo ocorre |
%d | A data do evento de criação de registo |
%n | Nova linha |
A instrução de código seguinte mostra como activar PatternLayout e especificar um padrão de conversão simples:
log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n
Por exemplo:
WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 102042, [setLoggerMessage]
WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 102342, [setLoggerMessage]