Configurar a Criação de Log do Workplace XT

Sobre Esta Tarefa

O IBM® FileNet Workplace XT usa o produto Apache log4j para gerenciar sua criação de log. Durante a criação de log, informações sobre a atividade do aplicativo são gravadas em locais de saída, como o console ou arquivos. O pessoal de suporte e desenvolvimento usa as informações em entradas de log para analisar a atividade do aplicativo, assim como para diagnosticar e resolver problemas. A criação de log serve para propósitos de diagnóstico apenas e não fornece informações de segurança ou de trilha de auditoria.

O produto log4j é instalado durante a instalação do Workplace XT. Por padrão, a criação de log não é ativada durante a instalação.

Para ativar ou desativar a criação de log:

Procedimento

  1. Navegue para a pasta de configuração do Workplace XT especificada durante a instalação. O caminho padrão é: A pasta de configuração do Workplace XT especificada durante a instalação. O caminho padrão é:
    • Windows: <unidade>:\Program Files\FileNet\Config\WebClient
    • UNIX: /opt/FileNet/config/WebClient
  2. Ative ou desative a criação de log renomeando o arquivo de configuração. O arquivo de configuração de criação de log de amostra chama-se __log4j.properties.
    • Para ativar a criação de log, renomeie __log4j.properties para log4j.properties.
    • Para desativar a criação de log, renomeie log4j.properties para outro nome, por exemplo, __log4j.properties.
  3. Reinicie o aplicativo para que as mudanças sejam efetivadas.

Resultados

Configurar Definições de Criação de Log

O arquivo de amostra log4j.properties possui um conjunto de opções padrão, especificadas como pares de keyword=value. Para alterar os padrões, abra log4j.properties com um editor de texto, modifique conforme necessário e salve o arquivo. É possível configurar as definições de criação de log a qualquer momento após a instalação. As mudanças feitas no arquivo de configuração de criação de log são reconhecidas automaticamente; não é necessário reiniciar o aplicativo ou o servidor de aplicativos.

Os tópicos a seguir fornecem algumas informações sobre algumas das opções de configuração de criação de log que você verá no arquivo. Para obter informações adicionais sobre as opções de criação de log, consulte o Web site do Apache (http://apache.org) no Projeto de Criação de Log, e o Web site de criação de log do Apache (http://logging.apache.org/log4j/).

Criador de Logs

Um criador de logs grava solicitações de criação de log ativadas em anexadores. No arquivo log4j.properties, a primeira palavra-chave descreve o criador de logs raiz. O criador de logs raiz é o criador de logs de nível mais alto na hierarquia e fornece padrões globais; qualquer criador de logs filho que não tiver configurado opções explicitamente herdará seu comportamento do criador de logs raiz.

Anexador

É possível especificar onde os dados de log serão gravados configurando um anexador, que envia entradas de log formatadas para um destino de saída especificado. Os tipos de destino podem ser um arquivo ou o console; a saída pode ser redirecionada para um log de eventos do Windows, encaminhada para um servidor log4j remoto, etc. (Consulte a documentação de log4j do Apache para obter todas as opções de destino de saída e de formatação.) Um único criador de logs pode ter mais de um anexador. Por exemplo, é possível gravar a saída em um console e em um arquivo ao mesmo tempo. Aumentar o número de destinos pode afetar o desempenho.

No Workplace XT, dois anexadores são configurados, por padrão. Um anexador grava os dados de log no formato IBM Common Base Event (CBE), que é usado pelas ferramentas do IBM Support Assistant para processar o log, e o outro anexador grava em um formato mais legível pelo usuário. É possível alterar o último anexador para reduzir a quantidade de saída, ou desativá-lo completamente.

Nota:

Nível

O nível de criação de log especificado determina o tipo e a quantidade de informações coletadas. Existe uma correlação direta entre a quantidade de informações coletadas e o impacto no desempenho no sistema.

O log do aplicativo Workplace XT suporta os níveis padrão INFO, WARN, ERROR e FATAL, assim como os níveis ALL e OFF. A tabela a seguir descreve brevemente os níveis padrão; consulte a documentação de log4j do Apache para obter informações adicionais sobre os níveis.

Tabela 1. Esta tabela descreve os níveis padrão INFO, WARN, ERROR e FATAL, assim como os níveis ALL e OFF.
Nível Descrição
INFO Solicita mensagens informativas que descrevem o progresso do aplicativo em um nível de alta granularidade.
WARN Solicita criação de log para situações potencialmente prejudiciais.
ERRO Solicita criação de log para exceções lançadas a partir do aplicativo.
FATAL Solicita criação de log apenas para eventos de erro muito graves que possam, aparentemente, levar à falha do aplicativo.

O nível especificado determina a quantidade de informações coletadas. Existe uma correlação direta entre a quantidade de informações coletadas e o impacto no desempenho no sistema.

Formato do Arquivo de Saída

Ao configurar o anexador, é possível usar a palavra-chave de layout para especificar o formato em que os dados são gravados. Você escolhe um PatternLayout e um ConversionPattern. O PatternLayout especifica um padrão específico para entradas de log, e o ConversionPattern, que identifica o padrão de elementos que são gravados no anexador, define o padrão. Considere este exemplo:

log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n

resulta na seguinte entrada de log formatada:

2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before

Para obter informações adicionais sobre as opções de formatação, consulte a documentação de log4j do Apache.

Nota: Não altere o layout das entradas de log do IBM Common Base Event (CBE). Se isso for feito, a saída ficará ilegível para as ferramentas do IBM Support Assistant.

Analisar a Saída

A equipe de suporte pode examinar entradas em um arquivo de log para analisar a atividade do aplicativo e diagnosticar problemas ocorridos no aplicativo. Além disso, o uso das ferramentas do IBM Support Assistant (ISA) automatizam a fase de análise. As ferramentas do ISA consomem as entradas CBE na saída de criação de log de log4j.

Também é possível usar uma ferramenta como a Apache Chainsaw, um visualizador de log baseado na GUI para que você mesmo examine entradas de log não CBE.