Distribuzione del progetto plugin del programma di analisi di log
Prerequisiti
Una volta creato un progetto plugin per contenere le risorse per un programma di analisi di log, è necessario configurare il plugin in modo da poter essere utilizzato dall'Analizzatore di log e di traccia. Procedere come segue:
- Aggiungere le dipendenze plugin al file manifest del plugin
- Aggiungere un punto di espansione per il programma di analisi di log al file manifest del plugin
- Aggiungere un punto di espansione per i programmi di analisi statici
- Creare una classe del programma di analisi wrapper
- Verificare le impostazioni del plugin del programma di analisi di log
- Creare pacchetti del programma di analisi di log
- Distribuire il programma di analisi di log
1. 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. Individuare l'elemento richiesto nel file e aggiungere ad esso le dipendenze plugin.
Ad esempio:
<import plugin="org.eclipse.core.runtime"/>
<requires>
<import plugin="org.eclipse.hyades.logging.adapter"/>
<import plugin="org.eclipse.hyades.logging.parsers"/>
<import plugin="org.eclipse.hyades.logging.adapter.config"/>
</requires>
Nota: il plugin necessario sopra specificato deve essere posizionato nella directory di plugin eclipse o deve essere incluso nello spazio di lavoro corrente.
2. Aggiungere un punto di espansione del programma di analisi di log
È necessario definire un punto di espansione 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 espansione 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 espansione per il programma di analisi di log, è necessario apportare una serie di aggiornamenti:
- Sostituire RulesParser in questo punto di espansione con il nome del plugin creato per il progetto plugin del programma di analisi di log.
- Sostituire MyAdapter in questo punto di espansione con il nome della cartella nel plugin contenente i file dell'adattatore.
- Il tag <parser> specifica informazioni di alto livello per il programma di analisi ed è un elemento obbligatorio.
Sostituire i seguenti attributi:
- name- il nome di questo programma di analisi (può essere uguale a ui_name)
- description - una descrizione di questo programma di analisi che verrà mostrata nella procedura guidata Importa file di log quando questo programma di analisi viene selezionato
- icon - l'icona che verrà mostrata nella procedura guidata Importa file di log per questo programma di analisi
- class - il nome classe completo della classe wrapper del programma di analisi
- ui_name - il nome di questo programma di analisi che verrà incluso nell'elenco File di log selezionato nella procedura guidata Importa file di log
- id - un identificativo univoco per il punto di espansione di questo programma di analisi
-
Il primo tag <field> definisce il campo UI per la selezione del percorso del file di log. È un elemento obbligatorio. Sostituire i seguenti attributi:
- useBrowse - se un pulsante Sfoglia viene visualizzato per questo campo
- defaultValue - valore predefinito mostrato in questo campo (può essere vuoto)
- name - nome di questo campo mostrato nella procedura guidata Importa file di log
- tooltip - testo di aiuto che verrà mostrato nella procedura guidata Importa file di log quando il cursore si trattiene sul campo
- id - nome di questo campo che verrà trasmesso alla classe wrapper del programma di analisi - non modificare questo nome
- browseType - il tipo di file mostrati nella finestra di dialogo Sfoglia
-
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:
- defaultValue - elenco di tutte le versioni da visualizzare nella casella combinata
- name - nome di questo campo mostrato nella procedura guidata Importa file di log
- tooltip - testo di aiuto che verrà mostrato nella procedura guidata Importa file di log quando il cursore si trattiene sul campo
- id - nome di questo campo che verrà trasmesso alla classe wrapper del programma di analisi - non modificare questo nome
- ui_type - indica che si tratta di un campo combinato
-
Il tag <parserParameter> definisce il file di configurazione dell'adattatore da utilizzare per ciascuna versione del file di log supportata. Sostituire i seguenti attributi:
- name - il nome della versione del log di applicazione che verrà analizzato da questo file di configurazione dell'adattatore. Il nome deve corrispondere in modo esatto a una delle stringhe di versione elencate nell'attributo defaultValue del campo della casella combinata versione UI o può essere il nome "Default". Vedere i suggerimenti riportati di seguito.
- value - directory e nome del file di configurazione dell'adattatore. Il valore può essere specificato come il percorso assoluto del file ma si consiglia di specificare il percorso relativo del file all'interno dell'ubicazione del plugin.
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. Ad esempio:
<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:
È 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
Suggerimento: un'applicazione può scrivere dati nel proprio file di log in diverse lingue, in funzione dell'ambiente in cui viene eseguita. Le classi statiche di programma di analisi o le regole di espressione regolare vengono scritte per analizzare un file di log in una singola lingua. Perciò per supportare un tipo di file di log che può essere scritto in molte lingue, è necessario creare un file di adattatore di programma di analisi statico distinto o un file di adattatore di regole per ogni lingua. Quindi, nel punto di espansione logParser per quel tipo di file di log, è necessario aggiungere un tag parserParameter per ogni file di adattatore, specificando la lingua che applica nel campo del nome. Non dimenticare di aggiungere i valori di nome parserParameter all'elenco nell'attributo defaultValue del campo versione. Ciò consentirà a un utente di scegliere la lingua corretta del file di log quando lo importa.
Ad esempio, i parametri seguenti del programma di analisi possono essere aggiunti al punto di espansione logParser per supportare l'importazione di log inglesi, francesi e tedeschi:
<parserParameter
name="MyApp 1.0(rules) English"
value="./MyAdapter/myadapter_en.adapter"/>
<parserParameter
name="MyApp 1.0(rules) French"
value="./MyAdapter/myadapter_fr.adapter"/>
<parserParameter
name="MyApp 1.0(rules) German"
value="./MyAdapter/myadapter_de.adapter"/>
Questo passo è obbligatorio se si crea un programma di analisi statico.
Per i programmi di analisi statici, la relativa classe creata deve essere specificata in plugin.xml tramite un'estensione staticParser. Questo punto di estensione permetterà di trovare la classe quando viene utilizzato per analizzare un file nello scenario di importazione di log.
Aggiungere il seguente punto di espansione:
<extension
point="org.eclipse.hyades.logging.adapter.config.staticParser">
<parserClassname
name="myLogParser33.MyStaticParser">
</parserClassname>
</extension>
Sostituire myLogParser33.MyStaticParser con il nome della classe di programma di analisi Java.
4. 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, sia statici che basati su regole, allo scopo di eseguire il file di configurazione dell'adattatore associato alla versione selezionata dall'utente nel corso della procedura guidata di importazione del log mediante il run-time dell'adattatore log generico.
/*
* 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";
}
}
5. Verificare le impostazioni del plugin del programma di analisi di 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:
- Passare alla prospettiva Plugin selezionando Finestra > Apri prospettiva > Altro > Sviluppo plugin.
- Dalla prospettiva Sviluppo plugin, selezionare il progetto plugin.
- Dalla barra degli strumenti, selezionare Esegui > Esegui come > Workbench di runtime.
- Nel nuovo workbench, dal menu, selezionare File > Importa.
- Nella procedura guidata di importazione, selezionare File di log e fare clic su Avanti.
- 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.
- Selezionare il tipo di file di log. Verificare che tutti i campi e il testo nella scheda Dettagli siano corretti.
- Specificare il valore per il percorso del file di log.
- Fare clic su OK.
- 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.
Suggerimento: se nella vista log non è visualizzato alcun record del file di log, verificare che il componente programma di creazione output nel file di configurazione dell'adattatore del programma di analisi sia configurato con la classe di esecuzione org.eclipse.hyades.logging.adapter.config.outputters.StaticParserOutputter.
6. Creare pacchetti e distribuire il plugin del programma di analisi dei log
Distribuzione locale
Per distribuire il plugin del programma di analisi di log in un workbench Eclipse, è necessario creare pacchetti dei file plugin esportandoli in un file zip. Procedere come segue:
- Aprire il file plugin.xml nell'editor Manifest plugin.
- Selezionare la scheda Runtime e verificare la presenza di un file jar per le classi plugin nell'elenco Librerie runtime. Se non è elencato alcun file jar, aggiungerne uno facendo clic sul pulsante Nuovo... e specificando un nome appropriato.
- Selezionare la scheda Build e controllare i file e le cartelle appropriati nell'elenco Binary Build, che saranno inclusi nel plugin esportato. Per esempio, verificare i file plugin.xml, plugin.properties e i file di configurazione dell'adattatore del programma di analisi. Salvare le modifiche apportate al file plugin.xml.
- Esportare i file plugin selezionando File > Esporta.
- Nella procedura guidata di esportazione, selezionare > Plugin e frammenti distribuibili.
- Fare clic su Avanti.
- Nella pagina Plugin e frammenti distribuibili, selezionare il plugin nell'elenco Plugin e frammenti disponibili e selezionare la relativa casella di controllo.
- Selezionare Distribuisci come un singolo file ZIP nel campo Opzioni di esportazione.
- Specificare la destinazione del Nome file per questo file zip.
- Fare clic su Fine.
Distribuzione remota
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 di log.
Procedere come segue:
- Aprire il file plugin.xml nell'editor Manifest plugin.
- Selezionare la scheda Runtime e verificare la presenza di un file jar per le classi plugin nell'elenco Librerie runtime. Se non è elencato alcun file jar, aggiungerne uno facendo clic sul pulsante Nuovo... e specificando un nome appropriato.
- Creare una cartella nel plugin del programma di analisi di log denominata config.
- Creare un file denominato pluginconfig.xml nella cartella config.
Ad esempio:
<?xml version="1.0" encoding="UTF-8"?>
<PluginConfiguration requires="org.eclipse.hyades.logging.parsers">
<Application configuration="default"
executable="RemoteLogParserLoader"
extends="default"
location=="%SYS_TEMP_DIR%"
path="%JAVA_PATH%">
<Variable name="CLASSPATH"
position="prepend"
value="%RASERVER_HOME%\plugins\RulesParser_1.0.0\parsers.jar"/>
<Variable name="GLA_CONFIG_PATH" position="prepend" value="%RASERVER_HOME%\plugins\RulesParser_1.0.0"/>
<Parameter position="append" value=""config_path=%GLA_CONFIG_PATH%""/>
</Application>
<Option name="RulesParser" type="version" value="1.0.0"/>
</PluginConfiguration>
- Sostituire RulesParser con il nome del progetto plugin del programma di analisi di log.
- Aprire il file plugin.xml nell'editor Manifest plugin.
- Selezionare la scheda Build e controllare i file e le cartelle appropriati nell'elenco Binary Build, che saranno inclusi nel plugin esportato. Per esempio, verificare i file plugin.xml, plugin.properties, i file di configurazione dell'adattatore del programma di analisi e il file pluginconfig.xml appena creato. Salvare le modifiche apportate al file plugin.xml.
- Esportare i file plugin selezionando File > Esporta.
- Nella procedura guidata di esportazione, selezionare > Plugin e frammenti distribuibili.
- Fare clic su Avanti.
- Nella pagina Plugin e frammenti distribuibili, selezionare il plugin nell'elenco Plugin e frammenti disponibili e selezionare la relativa casella di controllo.
- Selezionare Distribuisci come un singolo file ZIP nel campo Opzioni di esportazione.
- Specificare la destinazione del Nome file per questo file zip.
- Fare clic su Fine.
7. Distribuire il programma di analisi di log
È possibile distribuire il plugin del programma di analisi di log decomprimendo il file zip creato nella directory eclipse e di un'installazione Eclipse. A questo punto si è pronti a verificare il plugin del programma di analisi di log appena creato utilizzando l'Analizzatore di log e di traccia.
Per distribuire il plugin del programma di analisi di 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.
Riavviare Agent Controller.
Argomenti correlati
Specifica del formato di Common Base Event
Attività correlate
Creazione di un programma di analisi di log
Creazione di un adattatore statico
Creazione di un adattatore basato su regole
Verifica di un programma di analisi di log
Impostazione di un progetto plugin per un programma di analisi di log
Riferimenti correlati
Struttura del file di configurazione dell'adattatore
Editor configurazione adattatore
Grammatica espressione regolare
(C) Copyright IBM Corporation 2000, 2005. Tutti i diritti riservati.