Implementando o Projeto de Plug-in do Analisador de Log

Pré-requisitos

Depois de criar um projeto de plug-in para conter os artefatos para um analisador de log, é necessário configurar o plug-in para que possa ser utilizado pelo Analisador de Log e Rastreio. Execute as etapas a seguir:

  1. Inclua dependências de plug-in no arquivo de manifesto do plug-in
  2. Inclua um ponto de extensão para o analisador de log no arquivo de manifesto do plug-in
  3. Crie uma classe de analisador estático wrapper
  4. Exporte o plug-in do analisador de log

Incluir Dependências de Plug-in

As dependências de plug-in a seguir devem ser incluídas no arquivo de manifesto de plug-in. Abra o arquivo plugin.xml em um editor de texto e inclua estas linhas após o elemento de tempo de execução:

   <requires>
 <import plugin="org.eclipse.ui"/>
 <import plugin="org.eclipse.core.runtime.compatibility"/>
 <import plugin="org.eclipse.hyades.logging.adapter"/>
 <import plugin="org.eclipse.hyades.logging.parsers"/>
 <import plugin="org.eclipse.hyades.logging.adapter.config"/>
 <import plugin="org.apache.xerces"/>
   </requires>

Incluir um Ponto de Extensão do Analisador de Log

Utilize a marcação a seguir para utilizar o ponto de extensão org.eclipse.hyades.logging.parser. Abra o arquivo plugin.xml em um editor de texto e inclua as linhas a seguir após o elemento requires:

 <extension
         point="org.eclipse.hyades.logging.parsers.logParser">
      <parser
            name="Adaptador de Regras de Amostra para MyApp"
            icon=""
            description="%STR_MYAPP_PARSER_DESCRIPTION"
            class="RulesParser.StaticParserExtension"
            ui_name="Arquivo MyApp myapp.log"
            id="org.eclipse.hyades.logging.parsers.MyAppLogParser">
         <!-- Campo de UI para selecionar o local do arquivo de log do gabarito -->
         <field
               useBrowse="true"
               defaultValue="d:\temp\sample.log"
               name="Diretório"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP1"
               id="file_path"
               browseType="*.log">
         </field>
         <!-- Caixa de combinação da UI para selecionar a versão do arquivo de log a ser importado -->
         <field
               useBrowse="false"
               defaultValue="MyApp 1.0 (regras), MyApp 1.0 (estático)"
               name="Versões suportadas"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP2"
               ui_type="combobox"
               id="version">
         </field>
	<!-- Pesquisa do arquivo Config com base na versão selecionada acima -->
	<!-- O nome do arquivo Config precisa corresponder à cadeia de versão exatamente conforme listado no campo defaultValue da caixa de combinação da UI-->
	<!-- Se houver várias seleções, você poderá definir um dos campos de nomes para o Padrão -->
         <parserParameter
               name="MyApp 1.0 (regras)"
               value="./MyAdapter/myadapter.adapter">
    </parserParameter>
				 <parserParameter
               name="MyApp 1.0 (estático)"
               value="./MyAdapter/mystaticadapter.adapter">
         </parserParameter>

      </parser>
</extension> 

Os campos especificados acima criarão uma opção para o MyApp myapp.log no assistente Importar Log, conforme mostrado a seguir:

Assistente Importar Log mostrando o myapp myapp.log como uma opção para importação

Você poderá utilizar o arquivo plugin.properties para especificar determinadas propriedades no arquivo plugin.xml se houver versões que sempre precisam de atualização. O arquivo plugin.properties para o plugin.xml acima seria semelhante a este:


# ====================================================================
# Para o desenvolvedor de código:
#   NÃO altere as propriedades entre esta linha e a
#   linha "%%% FIM DAS PROPRIEDADES TRADUZIDAS %%%".
#   Crie um novo nome de propriedade, anexe ao final do arquivo e altere
#   o código para utilizar a nova propriedade.
# ====================================================================

# ====================================================================
# %%% FIM DAS PROPRIEDADES TRADUZIDAS %%%
# ====================================================================

pluginName = Arquivos de Configuração do Adaptador de Log Genérico Hyades
providerName = Eclipse.org

# Mensagem(ns) do ponto de extensão logParser:
STR_MYAPP_PARSER_DESCRIPTION = Analisador de regras MyApp v1.0
STR_MYAPP_TOOLTIP1           = Digite o local do arquivo de log
STR_MYAPP_TOOLTIP2           = Selecione a versão do arquivo de log a ser importado

Criar uma Classe Wrapper para o Analisador

Crie uma classe wrapper estática que estenda o org.eclipse.hyades.logging.adapter.config.StaticParserWrapper. Esta classe é utilizada para os analisadores estático e com base em regras.

/*
 * Criado em 12 de abril de 2004
 * Classe StaticParserExtension criada para ser utilizada no Plug-in RulesParser
 */
package RulesParser;

import org.eclipse.hyades.logging.adapter.config.StaticParserWrapper;

/**
 * @autor desenvolvedor
 * Classe StaticParserExtension
 */
public class StaticParserExtension extends StaticParserWrapper {
	public StaticParserExtension(){
		super();
		currentPlugin="RulesParser";
	}
}


Exportar o Plug-in do Analisador de Log

Para utilizar o plug-in no ambiente eclipse, você precisa exportar todos os arquivos do projeto de plug-in de seu espaço de trabalho, incluindo o arquivo plugin.xml, para o diretório de plug-ins do eclipse. Por exemplo:

/eclipse/plugins/YOUR_PLUGIN_DIRECTORY_NAME/plugin.xml
Assegure-se de que o arquivo de configuração do adaptador seja exportado para o diretório correto sob o diretório de plug-in. Por exemplo:
/eclipse/plugins/YOUR_PLUGIN_DIRECTORY_NAME/YOUR_ADAPTER_FOLDER_NAME/MyAdapter.adapter
em que YOUR_ADAPTER_FOLDER_NAME é a pasta do projeto em que você criou o arquivo de configuração do adaptador.

Agora você está pronto para testar o analisador de log recém-criado, utilizando o Analisador de Log e Rastreio.

 

Conceitos Relacionados
Especificação do Formato Common Base Event

Tarefas Relacionadas
Criando um Analisador de Log
Criando um Adaptador Estático
Criando um Adaptador com Base em Regras
Testando um Analisador de Log
Configurando um Projeto de Plug-in para 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