Configurando um Adaptador para Monitoração de Aplicativos Ativos

O Adaptador de Log Genérico fornece uma classe Outputter que permite que os objetos do Common Base Event gerados pelo adaptador sejam enviados a um Agente de Registro. O Log and Trace Analyzer pode ser utilizado para conectar ao Agente de Registro, para monitorar e analisar o log de aplicativos em tempo real.

Pré-requisitos:

Siga estas etapas para configurar o seu adaptador para monitoração.

Configure o Componente Outputter

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

O componente Outputter do arquivo de configuração do adaptador precisa ser atualizado para utilizar a classe CBELogOutputter que grava os objetos do Common Base Event em um Logging Agent. Você pode atualizar o componente Outputter existente ou incluir um novo componente Outputter.

Para incluir um novo componente Outputter:

  1. Para editar o arquivo de configuração do adaptador, selecione o arquivo de configuração do adaptador na área de janela Navegador. Clique com o botão direito do mouse e selecione Open with (Abrir com) > Adapter Configuration Editor (Editor de Configuração do Adaptador). O arquivo será aberto no editor.
  2. Na janela Adapter Configuration Editor, expanda o nó Adapter (Adaptador) > Configuration (Configuração) > Context Instance (Instância do Contexto).
  3. Clique com o botão direito do mouse na Context Instance e selecione Add (Incluir) > Outputter. Um novo componente Outputter será criado na Context Instance.
  4. No campo Outputter Type (Tipo de Outputter), 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 desejado do Logging Agent. Este é o nome que você verá no Log and Trace Analyzer como o Logging Agent a ser monitorado.
  7. Se você desejar que o Outputter aguarde até gravar os Common Base Events no Logging Agent, inclua uma propriedades chamada waitUntilLoggingTime e defina o valor da propriedade como a hora em milissegundos. Para incluir a propriedade, clique com o botão direito do mouse no Outputter recém-criado e selecione Add (Incluir) > Property (Propriedade). Uma nova propriedade é criada no novo nó Outputter.
  8. Para ativar a classe CBELogOutputter, você precisa criar o componente Outputter associado nos Contextos do Basic Context Implementation. Abra Contexts (Contextos) > Context Basic Implementation Context (Contexto do Context Basic Implementation).
  9. Clique com o botão direito do mouse em Context Basic Implementation Context (Contexto do Context Basic Implementation) e selecione Add (Incluir) > Component (Componente). Um novo componente é incluído no contexto.
  10. Configure o novo componente com os seguintes valores:
    Nome: O nome do Outputter no contexto. Por exemplo, Logging Agent Outputter
    Descrição: Descrição do que o Outputter faz
    Classe executável: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    Nível de registro:O nível de registro interno que o componente Outputter deve utilizar. Este nível baseia-se nos valores de gravidade do CommonBaseEvent. Quanto mais alto o número, mais alta a gravidade da mensagem. Para o nível de registro, o número especificado fará com que as mensagens internas do Outputter dessa gravidade e acima sejam registradas pelo componente Outputter. Um valor de 71 ou acima significa que o Outputter não será registrado em nenhum mensagem interna do Outputter. Um valor de 0 significa que o Outputter registrará as mensagens internas do Outputter de todas as gravidades. O valor recomendado é 50 o que significa que apenas as mensagens de erro internas Críticas ou Fatais do Outputter serão registradas.
    Função: Outputter
    UniqueID: Deve apontar para o Outputter definido na Instância do Contexto na etapa 3. Utilize o botão Browse (Procurar) para selecionar o ID correto.
  11. Salve as alterações do arquivo de configuração do adaptador.

Configurar a Instância do Contexto

Se você deseja que o analisador de logs 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 Open with (Abrir com) > Adapter Configuration Editor (Editor de Configuração do Adaptador). O arquivo será aberto no editor.
  2. Na janela do editor, selecione Adapter (Adaptador) > Configuration (Configuração) > Context Instance (Instância do Contexto). Os detalhes da Instância do Contexto serão exibidos na área de janela à direita.
  3. Selecione a caixa de opções Continuous Operation (Operação Contínua).
  4. Configure os campos Maximum Idle Time (Tempo Inativo Máximo) e Pause Interval (Intervalo de Pausa), conforme requerido.
  5. Salve as alterações do arquivo de configuração do adaptador.

Ativar 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 shell em ambientes não-Windows. A seguir, são apresentados 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 registro criado pelo Adaptador de Log Genérico, o Agent Controller deve ser instalado no sistema em que o Adaptador de Log Genérico tiver de ser executado e deve ser iniciado antes que o Adaptador de Log Genérico seja iniciado.

Arquivo em batch do Windows:

@rem USAGE:  runregex
@rem PURPOSE:  Illustrates the functional capabilities of the Generic Log Adapter (GLA) run-time using an example adapter file and sample log file.
@rem INSTRUCTIONS:  When executing in a GLA run-time environment, change the value of the %GLA_HOME% environment variable to the absolute path of the unzipped GLA run-time.
@rem NOTE:  When executing in a plug-in (e.g. Eclipse) run-time environment, create a temporary working directory and change the value of the %GLA_HOME% environment variable to the 
@rem        absolute path of the new temporary working directory.  Furthermore, create a %GLA_HOME%\config directory and copy the contents of the org.eclipse.hyades.logging.adapter.config 
@rem        plug-in to the new %GLA_HOME%\config directory.  Finally, create a %GLA_HOME%\lib directory and copy the following JAR files to the new %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 MY_DIRECTORY=MyAdapter
SET CONFIG_FILE=%GLA_HOME%\config\%MY_DIRECTORY%\myadapter.adapter
PUSHD %GLA_HOME%\config\%MY_DIRECTORY%\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
# USAGE:  runregex_example.sh
# PURPOSE: Illustrates the functional capabilities of the Generic Log Adapter (GLA) run-time using an example adapter file and sample log file.
# INSTRUCTIONS: When executing in a GLA run-time environment, change the value of the $GLA_HOME environment variable to the absolute path of the unzipped GLA run-time.
# NOTE: When executing in a plug-in (e.g. Eclipse) run-time environment, create a temporary working directory and change the value of the $GLA_HOME environment variable to the 
# absolute path of the new temporary working directory. Furthermore, create a $GLA_HOME/config directory and copy the contents of the com.ibm.etools.logging.adapter.config 
# plug-in to the new $GLA_HOME/config directory. Finally, create a $GLA_HOME/lib directory and copy the following JAR files to the new $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

YOUR_DIRECTORY=MY_DIRECTORY
export MY_DIRECTORY

CONFIG_FILE="$GLA_HOME/config/$MY_DIRECTORY/myadapter.adapter"
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config/$MY_DIRECTORY

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 será executado no adaptador.

Monitorando o Log de Aplicativos Ativos

Agora você está pronto para monitorar o log de aplicativos ativos.

  1. Assegure-se de que o log esteja ativado nas preferências.
    1. Na barra de ferramentas principal, selecione Window (Janela) > Preferences (Preferências). O assistente Preferences é exibido.
    2. Selecione Profiling and Logging (Traçado de Perfil e Log) na área de janela à esquerda. As preferências de Traçado de Perfil e Log são carregadas na área de janela à direita.
    3. Selecione Enable logging (Ativar Log) nas opções Profiling and Logging.

      A caixa de opções Enable logging é selecionada na área de janela Preferences de Profiling and Logging

    4. Selecione OK para aplicar as alterações.
  2. Na perspectiva Profiling and Logging, clique na barra de ferramentas Profiling Ícone da ferramenta Traçado de Perfil e selecione Profile (Perfil). O assistente Profile é exibido.
  3. Selecione Attach - Java Process (Conectar - Processo Java) e clique no botão New (Novo), na parte inferior da lista. Uma nova configuração do processo Java será criada.
  4. Clique na guia Hosts e selecione o host no qual o log de aplicativos reside, movendo-o para a área de janela Selected agents (Agentes Selecionados) utilizando o botão de seta.
    Nota: Para monitorar um log de aplicativos ativo, o Agent Controller deve estar em execução no mesmo sistema do aplicativo.
  5. Clique na guia Agents (Agentes) e utilize as teclas de seta para selecionar o Logging Agent configurado.

    No assistente de preferências do traçado de perfil, o Logging Agent que o usuário criou está na área de janela à esquerda

  6. Clique em Apply (Aplicar).
  7. Clique em Profile (Perfil) para conectar ao Logging Agent.
  8. Na visualização Monitor do Traçado de Perfil da perspectiva Profiling and Logging, selecione o Logging Agent..
  9. Clique com o botão direito do mouse no Logging Agent e selecione Start monitoring (Iniciar Monitoração).
  10. Clique com o botão direito do mouse no Logging Agent e selecione Open with (Abrir com) > Log View (Visualização de Log). Os eventos de log do log de aplicativos são carregados na visualização Log.

 

Conceitos Relacionados
Visão Geral do Hyades Generic Log Adapter
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 do Adaptador
Gramática de Expressão Comum