Distribuzione del progetto plugin del programma di analisi del log

Prerequisiti

Una volta creato un progetto plugin per contenere le risorse per un programma di analisi del log, è necessario configurare il plugin in modo da poter essere utilizzato dall'Analizzatore di log e di traccia. Procedere come segue:

  1. Aggiungere le dipendenze plugin al file manifest del plugin
  2. Aggiungere un punto di estensione per il programma di analisi del log al file manifest del plugin
  3. Creare una classe del programma di analisi wrapper statico
  4. Verificare le impostazioni del plugin del programma di analisi del log
  5. Creare pacchetti del plugin del programma di analisi del log per la distribuzione
  6. Distribuire il programma di analisi del log

Aggiungere le dipendenze plugin

Le seguenti dipendenze plugin devono essere incluse nel file manifest del plugin. Aprire il file plugin.xml in un editor di testo e aggiungere le seguenti righe dopo l'elemento di runtime:

   
<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"/>
</requires>

Aggiungere un punto di estensione del programma di analisi del log

È necessario definire un punto di estensione per ciascun tipo di file di log dell'applicazione da analizzare e importare nell'Analizzatore di log e di traccia. Di seguito viene riportato un esempio di punto di estensione per l'applicazione MyApp con l'adattatore di regole e l'adattatore statico definiti:

 <extension
         point="org.eclipse.hyades.logging.parsers.logParser">
	      <parser
            name="Sample Rules Adapter for MyApp"
            icon=""
            description="%STR_MYAPP_PARSER_DESCRIPTION"
            class="RulesParser.StaticParserExtension"
            ui_name="MyApp myapp.log file"
            id="org.eclipse.hyades.logging.parsers.MyAppLogParser">  
         <field
               useBrowse="true"
               defaultValue="d:\temp\sample.log"
               name="Directory"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP1"
               id="file_path"
               browseType="*.log">
         </field>         
         <field
               useBrowse="false"
               defaultValue="MyApp 1.0(rules), MyApp 1.0(static)"
               name="Supported versions"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP2"
               ui_type="combobox"
               id="version">
         </field>
         <parserParameter
               name="MyApp 1.0(rules)"
               value="./MyAdapter/myadapter.adapter">
    </parserParameter>
	<parserParameter
               name="MyApp 1.0(static)"
               value="./MyAdapter/mystaticadapter.adapter">
         </parserParameter>

      </parser>
   </extension>

Per personalizzare il punto di estensione per il programma di analisi del log, è necessario apportare una serie di aggiornamenti:

  1. Sostituire RulesParser in questo punto di estensione con il nome del plugin creato per il progetto plugin del programma di analisi del log.
  2. Sostituire MyAdapter in questo punto di estensione con il nome della cartella nel plugin contenente i file dell'adattatore.
  3. Il tag <parser> specifica informazioni di alto livello per il programma di analisi ed è un elemento obbligatorio. Sostituire i seguenti attributi:
  4. Il primo tag <field> definisce il campo UI per la selezione del percorso del file di log. È un elemento obbligatorio. Sostituire i seguenti attributi:
  5. Il secondo tag <field> definisce la casella combinata UI per la selezione della versione del file di log da importare. È un elemento obbligatorio. Sostituire i seguenti attributi:
  6. Il tag <parserParameter> definisce il file di configurazione dell'adattatore da utilizzare per ciascuna versione del file di log supportata. Sostituire i seguenti attributi:
Suggerimento: Un valore Default deve essere definito nel caso in cui non sia possibile trovare le corrispondenza per una versione. Se si ha un solo file di configurazione dell'adattatore, è necessario avere solo il seguente valore Default parserParameter:
         <parserParameter
   name="Default"
   value="./MyAdapter/myadapter.adapter">
</parserParameter>

I campi specificati creeranno un'opzione per MyApp myapp.log nella procedura guidata di importazione log come mostrato di seguito:

Procedura guidata di importazione log che mostra myapp myapp.log come opzione da importare

È possibile utilizzare un file plugin.properties per definire alcune proprietà nel file plugin.xml con diverse versioni. Ad esempio, in presenza di stringhe di testo che verranno incluse nella procedura guidata Importa file di log e che dovranno essere tradotte in diverse lingue, è possibile definirle nel file plugin.properties e includere diversi file delle proprietà per le lingue da supportare. Nel file plugin.properties vengono definite variabili di sostituzione che possono essere utilizzate nel file plugin.xml. Il file plugin.properties per il suddetto plugin.xml apparirà come segue:


# Properties for RulesParser Plugin

pluginName = RulesParser
providerName = MyCompany

# logParser extension point message(s):
STR_MYAPP_PARSER_DESCRIPTION = MyApp rules parser v1.0
STR_MYAPP_TOOLTIP1           = Enter the location of the log file
STR_MYAPP_TOOLTIP2           = Select the version of the log file to import

Creare una classe wrapper per il programma di analisi

Creare una classe wrapper statica che estende org.eclipse.hyades.logging.adapter.config.StaticParserWrapper. Questa classe viene utilizzata per i programmi di analisi statici e basati su regole. Creare la classe nel progetto plugin del programma di analisi del log. È possibile utilizzare la seguente classe di esempio sostituendo RulesParser con il nome del proprio progetto plugin del programma di analisi del log.

/*
 * Created on Apr 12, 2004
 * StaticParserExtension class created to be used in RulesParser Plug-in
 */
package RulesParser;

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

/**
 * @author developer
 * StaticParserExtension class
 */
public class StaticParserExtension extends StaticParserWrapper {
	public StaticParserExtension(){
		super();
		currentPlugin="RulesParser"; 
	}
}

Verificare le impostazioni del programma di analisi del log

Per verificare di aver configurato correttamente il file manifest del plugin, è possibile eseguire il progetto plugin in un nuovo workbench di runtime. Procedere come segue:

  1. Passare alla prospettiva Plugin selezionando Finestra > Apri prospettiva > Altro > Sviluppo plugin.
  2. Dalla prospettiva Sviluppo plugin, selezionare il progetto plugin.
  3. Dalla barra degli strumenti, selezionare Esegui > Esegui come > Workbench di runtime.
  4. Nel nuovo workbench, dal menu, selezionare File > Importa.
  5. Nella procedura guidata di importazione, selezionare File di log e fare clic su Avanti.
  6. Nella pagina File di log, fare clic su Aggiungi per aggiungere un file di log. Nella finestra di dialogo Aggiungi file di log, verificare che il nuovo tipo di file di log sia incluso nell'elenco File di log selezionato.
  7. Selezionare il tipo di file di log. Verificare che tutti i campi e il testo nella scheda Dettagli siano corretti.
  8. Specificare il valore per il percorso del file di log.
  9. Fare clic su OK.
  10. Fare clic su Fine per importare il file di log del nuovo tipo di file di log. Verificare che i record del file di log siano visualizzati nella vista Log.

Creare pacchetti del plugin del programma di analisi del log per la distribuzione

Per distribuire il plugin del programma di analisi del log in un workbench Eclipse, è necessario creare pacchetti dei file plugin esportandoli in un file zip. Procedere come segue:

  1. Aprire il file plugin.xml in un editor di testo.
  2. Verificare che questo comprenda un file jar della libreria di runtime per i file della classe plugin. Ad esempio:
    	<runtime>
    		<library name="parsers.jar">
    			<export name="*"/>
    		</library>
    	</runtime>
    	
  3. Per distribuire il programma di analisi su un host remoto in modo da poter importare i file di log da questo host, è necessario creare un file di configurazione plugin di Agent Controller per il programma di analisi del log. Procedere come segue:
    1. Creare una cartella nel plugin del programma di analisi del log denominata config.
    2. Creare un file denominato pluginconfig.xml nella cartella config. Ad esempio:
      <?xml version="1.0" encoding="UTF-8"?>
      <PluginConfiguration>
      <Application configuration="default" 
          executable="RemoteLogParserLoader" 
          extends="default" 
          location="%RASERVER_HOME%\plugins\RulesParser_1.0.0" 
          path="%JAVA_PATH%">
      <Variable name="CLASSPATH" 
          position="prepend" 
          value="%RASERVER_HOME%\plugins\RulesParser_1.0.0\parsers.jar"/>
      </Application>
      <Option name="RulesParser" type="version" value="1.0.0"/>
      </PluginConfiguration>
      
    3. Sostituire RulesParser con il nome del progetto plugin del programma di analisi del log.
    Nota: Se si estende un programma di analisi esistente, è necessario un parametro aggiuntivo in pluginconfig.xml per specificare la directory principale dei file dell'adattatore principale. Sono necessari i seguenti parametri:
     <Variable name="GLA_CONFIG_PATH" position="append" value="%RASERVER_HOME%\plugins\PARSER_PLUGIN\config"/>
       <Parameter position="append" value="config_path=%GLA_CONFIG_PATH%"/>
     
    dove PARSER_PLUGIN è la directory del programma di analisi che si sta estendendo. Il nuovo elemento <Variable> deve essere aggiunto come il primo nodo secondario dell'elemento <Application> quando il nuovo elemento <Parameter> deve essere aggiunto come ultimo elemento secondario dell'elemento <Application>.
  4. Aprire il file build.properties in un editor di testo.
  5. Aggiungere la cartella in cui sono memorizzati i file di configurazione dell'adattatore e il file plugin.properties all'elenco Generazione binaria. Aggiungere inoltre la cartella config, se la distribuzione verrà eseguita su un host remoto. Di seguito viene riportato un esempio del file build.properties:
    bin.includes = MyAdapters/,\
    
    config/,\
    
    plugin.xml,\
    
    plugin.properties,\
    
    parsers.jar
    source.parsers.jar = src/
    output.parsers.jar = bin/
    
  6. Esportare i file plugin selezionando File > Esporta.
  7. Nella procedura guidata di esportazione, selezionare > Plugin e frammenti distribuibili.
  8. Fare clic su Avanti.
  9. Sulla pagina Plugin e frammenti distribuibili, selezionare il plugin nell'elenco Plugin e frammenti disponibili.
  10. Selezionare Distribuisci come un singolo file ZIP distribuibile nel campo Opzioni di esportazione.
  11. Specificare la destinazione del Nome file per questo file zip.
  12. Scegliere Fine.

Distribuire il programma di analisi del log

È possibile distribuire il plugin del programma di analisi del log decomprimendo il file zip creato nella directory del plugin di un'installazione Eclipse. A questo punto si è pronti a verificare il plugin del programma di analisi del log appena creato utilizzando l'Analizzatore di log e di traccia.

Per distribuire il plugin del programma di analisi del log su un sistema remoto in modo da poter importare un file di log in remoto, decomprimere il file zip creato nella directory di installazione di Agent Controller sul sistema remoto.

 

Argomenti correlati
Specifica del formato di Common Base Event

Attività correlate
Creazione di un programma di analisi del log
Creazione di un adattatore statico
Creazione di un adattatore basato su regole
Verifica di un programma di analisi del log
Impostazione di un progetto plugin per un programma di analisi del log

Riferimenti correlati
Struttura del file di configurazione dell'adattatore
Editor configurazione adattatore
Grammatica espressione regolare