Configurando um Adaptador para Monitoração de Aplicativo Ativo

O Adaptador de Log Genérico fornece uma classe de emissor de saída que permite que os objetos Common Base Event gerados por seu adaptador sejam enviados para um agente de log. O Log and Trace Analyzer pode ser utilizado para conexão ao agente de log, a fim de monitorar e analisar o log de aplicativo em tempo real.

Pré-requisitos:

Siga estas etapas para configurar o adaptador para monitoramento:

Configurar o Componente Emissor de Saída

Nota: Quando um novo arquivo de configuração do adaptador é criado, ele é configurado para utilizar, por padrão, a classe CBELogOutputter. Se você não alterou essa configuração, poderá ignorar este procedimento.

O componente emissor de saída no arquivo de configuração do adaptador precisa ser atualizado para utilizar a classe CBELogOutputter, que grava objetos Common Base Event em um agente de log. Você pode atualizar o Componente Emissor de Saída existente ou incluir um novo componente Emissor de Saída.

Para incluir um novo componente emissor de saída:

  1. Para editar o arquivo de configuração do adaptador, selecione o arquivo de configuração na área de janela Navegador. Clique com o botão direito do mouse e selecione Abrir com > Editor de Configuração de Adaptador. O arquivo é aberto no editor.
  2. Na janela Editor de Configuração de Adaptador, expanda o nó Adaptador > Configuração > Instância do Contexto.
  3. Clique com o botão direito do mouse na Instância do Contexto e selecione Incluir > Emissor de Saída. Um novo emissor de saída é criado na Instância do Contexto.
  4. No campo Tipo de Emissor de Saída, selecione LoggingAgentOutputter.
  5. Clique na propriedade agentName. Os detalhes da propriedade são mostrados na área de janela à direita.
  6. Atualize o valor da propriedade com o nome do agente de log desejado. Este é o nome que você verá no Analisador de Log e Rastreio como o Agente de Log a ser monitorado.
  7. Se quiser que o emissor de saída aguarde antes de gravar os Common Base Events no agente de log, inclua uma propriedade denominada waitUntilLoggingTime e configure o valor da propriedade como o tempo em milissegundos. Para incluir a propriedade, clique com o botão direito do mouse no Emissor de Saída recém-criado e selecione Incluir > Propriedade. Uma nova propriedade é criada sob o novo nó Emissor de Saída.
  8. Para ativar a classe CBELogOutputter, é necessário criar o componente Emissor de Saída associado nos Contextos Implementação de Contexto Básico. Abra Contextos > Contexto Implementação Básica de Contexto.
  9. Clique com o botão direito do mouse em Contexto Implementação Básica de Contexto e selecione Incluir > Componente. Um novo componente é incluído no contexto.
  10. Configure o novo componente com os valores a seguir:
    Nome: Nome do emissor de saída no contexto
    Descrição: Descrição do que esse emissor de saída faz
    Classe Executável: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Nível de Log:O nível de log interno que o componente emissor de saída deve utilizar.
    Um valor 99 significa que o emissor de saída não registrará mensagens.
    Um valor 0 significa que o emissor de saída registrará mensagens de todas as gravidades.
    O valor recomendado é 50, o que significa que apenas as mensagens de erro Críticas ou Fatais internas do emissor de saída serão registradas.
    Função: Emissor de Saída
    ID Exclusivo: Deve apontar para o emissor de saída definido na Instância do Contexto na etapa 3. Utilize o botão Procurar para selecionar o ID correto.
  11. Salve as alterações do arquivo de configuração do adaptador.

Configure a Instância do Contexto

Se quiser que o analisador de log monitore o arquivo de log continuamente, será necessário atualizar as propriedades da instância do contexto do arquivo de configuração do adaptador para operação contínua.

  1. Para editar o arquivo de configuração do adaptador, selecione o arquivo de configuração do adaptador na perspectiva Navegador. Clique com o botão direito do mouse e selecione Abrir com > Editor de Configuração de Adaptador. O arquivo é aberto no editor.
  2. Na janela do editor, selecione Adaptador > Configuração > Instância do Contexto. Os detalhes da Instância do Contexto são exibidos na área de janela à direita.
  3. Selecione a caixa de opções Operação Contínua.
  4. Configure os campos Tempo Máximo Inativo e Intervalo de Pausa, conforme necessário.
  5. Salve as alterações do arquivo de configuração do adaptador.

Ative um Processo Java para Executar o Adaptador

O adaptador de log criado pode ser executado externamente a partir de um arquivo em batch no ambiente Windows ou em um script de shell em ambientes não-Windows. A seguir estão arquivos de amostra que podem ser utilizados para ativar o processo Java que executará o adaptador de log.
Nota: Para conectar e monitorar o agente de log criado pelo Adaptador de Log Genérico, um Hyades Agent Controller deve ser instalado no sistema no qual o Adaptador de Log Genérico deve ser executado e deve ser iniciado antes que o Adaptador de Log Genérico seja iniciado.

Arquivo em batch do Windows:

@rem USO:  runregex
@rem FINALIDADE: Ilustra as capacidades funcionais do tempo de execução do Adaptador
@rem de Log Genérico (GLA) utilizando um exemplo de arquivo de adaptador e um arquivo de log de amostra.
@rem PREMISSAS: Este arquivo em batch supõe que o tempo de execução do GLA e os arquivos necessários estão
@rem armazenados na seguinte estrutura de diretórios:
@rem %GLA_HOME%\config - arquivos de configuração do adaptador do GLA
@rem %GLA_HOME%\lib - tempo de execução do GLA e jars exigidos
@rem %GLA_HOME%\schema - arquivos de esquema de configuração do adaptador do GLA
@rem INSTRUÇÕES:
@rem Se o tempo de execução do GLA e os arquivos exigidos estiverem armazenados conforme indicado
@rem na seção de premissas acima, altere o valor da variável de ambiente %GLA_HOME%
@rem para o caminho absoluto no qual o tempo de execução do GLA
@rem e os arquivos exigidos estão armazenados.
@rem Se os arquivos de tempo de execução do GLA estiverem armazenados em um ambiente de plug-in
@rem (p.ex., Eclipse), siga as seguintes instruções:
@rem 1) Crie um diretório temporário para armazenar o tempo de execução do GLA e os arquivos exigidos.
@rem 2) Crie os diretórios config, lib e schema no diretório temporário
@rem criado na etapa 1)
@rem 3) Altere o valor da variável de ambiente %GLA_HOME% para o
@rem caminho absoluto do diretório temporário criado na etapa 1)
@rem 4) Copie os arquivos do adaptador que deseja executar para o diretório %GLA_HOME%\config.
@rem Por exemplo, se você quiser executar os arquivos do adaptador Apache, copie o
@rem diretório Apache do plug-in org.eclipse.hyades.logging.adapter.config
@rem e todo o seu conteúdo para o diretório %GLA_HOME%\config.
@rem 5) Copie o conteúdo do diretório schema do
@rem plug-in org.eclipse.hyades.logging.adapter para o diretório %GLA_HOME%\schema.
@rem 6) Copie os seguintes arquivos jar para o diretório %GLA_HOME%\lib directory
@rem Plug-in | JAR
@rem ---------------------------------------------------
@rem org.eclipse.hyades.logging.adapter | hgla.jar
@rem org.eclipse.hyades.logging.core | hlcbe101.jar
@rem org.eclipse.hyades.logging.core | hlcore.jar
@rem org.eclipse.hyades.execution.remote | hexr.jar
@rem org.eclipse.emf.ecore | ecore.jar
@rem org.eclipse.emf.common | common.jar

SET GLA_HOME=d:\GenericLogAdapter
SET CONFIG_FILE=%GLA_HOME%\config\my.adapter
@PUSHD %GLA_HOME%\config\
java -DGLA_HOME="%GLA_HOME%" -classpath "%GLA_HOME%\lib\hgla.jar;%GLA_HOME%\lib\hexr.jar;%GLA_HOME%\lib\hlcbe101.jar;%GLA_HOME%\lib\ecore.jar;%GLA_HOME%\lib\common.jar;%GLA_HOME%\lib\hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%"
POPD


Arquivo em batch não-Windows:
#!/bin/sh
# USO: runregex.sh
# FINALIDADE: Ilustra as capacidades funcionais do tempo de execução do Adaptador
# de Log Genérico (GLA) utilizando um exemplo de arquivo de adaptador e um arquivo de log de amostra.
# PREMISSAS: Este arquivo de shell supõe que o tempo de execução do GLA e os arquivos necessários estão
# armazenados na seguinte estrutura de diretórios:
# %GLA_HOME%/config - arquivos de configuração do adaptador do GLA
# %GLA_HOME%/lib - tempo de execução do GLA e jars exigidos
# %GLA_HOME%/schema - arquivos de esquema de configuração do adaptador do GLA
# INSTRUÇÕES:
# Se o tempo de execução do GLA e os arquivos exigidos estiverem armazenados conforme indicado
# na seção de premissas acima, altere o valor da variável de ambiente %GLA_HOME%
# para o caminho absoluto no qual o tempo de execução do GLA
# e os arquivos exigidos estão armazenados.
# Se os arquivos de tempo de execução do GLA estiverem armazenados em um ambiente de plug-in
# (p.ex., Eclipse), siga as seguintes instruções:
# 1) Crie um diretório temporário para armazenar o tempo de execução do GLA e os arquivos exigidos.
# 2) Crie os diretórios config, lib e schema no diretório temporário
# criado na etapa 1)
# 3) Altere o valor da variável de ambiente %GLA_HOME% para o
# caminho absoluto do diretório temporário criado na etapa 1)
# 4) Copie os arquivos do adaptador que deseja executar para o diretório %GLA_HOME%/config.
# Por exemplo, se você quiser executar os arquivos do adaptador Apache, copie o
# diretório Apache do plug-in org.eclipse.hyades.logging.adapter.config
# e todo o seu conteúdo para o diretório %GLA_HOME%/config.
# 5) Copie o conteúdo do diretório schema do
# plug-in org.eclipse.hyades.logging.adapter para o diretório %GLA_HOME%/schema.
# 6) Copie os seguintes arquivos jar para o diretório %GLA_HOME%\lib directory
# Plug-in | JAR
# --------------------------------------------------- 
# org.eclipse.hyades.logging.adapter | hgla.jar
# org.eclipse.hyades.logging.core | hlcbe101.jar
# org.eclipse.hyades.logging.core | hlcore.jar
# org.eclipse.hyades.execution.remote | hexr.jar
# org.eclipse.emf.ecore | ecore.jar
# org.eclipse.emf.common | common.jar

GLA_HOME=/home/eclipse/GenericLogAdapter
export GLA_HOME

CONFIG_FILE="$GLA_HOME/config/my.adapter"
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config"

java -DGLA_HOME="$GLA_HOME" -classpath "$GLA_HOME/lib/hgla.jar:$GLA_HOME/lib/hexr.jar:$GLA_HOME/lib/hlcbe101.jar:$GLA_HOME/lib/ecore.jar:$GLA_HOME/lib/common.jar:$GLA_HOME/lib/hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "$CONFIG_FILE" -cc "$CONFIG_FILE"

cd "$CUR_DIR"
Configure o arquivo, conforme necessário, para ativar o processo Java que executará o adaptador.

Monitorando o Log de Aplicativo Ativo

Agora você está pronto para monitorar o log de aplicativo ativo.

  1. Assegure-se de que o log esteja ativado nas preferências.
    1. Na barra de ferramentas principal, selecione Janela > Preferências. O assistente Preferências é aberto.
    2. Selecione Gerenciamento de Perfis e Log na área de janela à esquerda. As preferências de Gerenciamento de Perfis e Log são carregadas na área de janela à direita.
    3. Selecione Ativar Log sob as opções de Gerenciamento de Perfis e Log.

      A caixa de opções Ativar Log é selecionada na área de janela de preferências para Gerenciamento de Perfis e Log

    4. Selecione OK para aplicar as alterações.
  2. Na perspectiva Traçado de Perfil e Log, clique em Traçado de Perfil Ícone da ferramenta de traçado de perfil na barra de ferramentas e selecione Perfil.O assistente de Perfil é aberto.
  3. Selecione Anexar - Processo Java e clique no botão Novo na parte inferior da lista. Uma nova configuração do processo Java é criada.
  4. Clique na guia Hosts e selecione o host no qual o log de aplicativo reside.
    Nota: Para monitorar um log de aplicativo ativo, o Agent Controller deve estar em execução no mesmo sistema que o aplicativo.
  5. Clique na guia Agentes e utilize as teclas de seta para selecionar o agente de log que você configurou.

    No assistente de preferências de traçado de perfil, o agente de log que o usuário criou está na área de janela da esquerda

  6. Clique em Aplicar.
  7. Clique em Perfil para conectar-se ao agente de Log.
  8. Na perspectiva Gerenciamento de Perfis e Log na visualização Monitor de Gerenciamento de Perfis, selecione o agente de log.
  9. Clique com o botão direito do mouse no agente e selecione Iniciar Monitoração.
  10. Clique com o botão direito do mouse no agente e selecione Abrir com > Visualização Log. Os eventos de log do log de aplicativo são carregados na visualização Log.
    Nota: Se você não vir nenhum registro de log na visualização Log, clique no botão Atualizar Visualizações na parte superior da área de janela Monitor de Traçado de Perfil.

 

Conceitos Relacionados
Visão Geral do Adaptador de Log Genérico
Especificação do Formato Common Base Event

Tarefas Relacionadas
Criando um Analisador de Log

Referências Relacionadas
Estrutura do Arquivo de Configuração do Adaptador
Editor de Configuração de Adaptador
Gramática de Expressão Comum