Après avoir créé un projet de plug-in destiné à contenir les artefacts d'un programme d'analyse syntaxique de journaux, vous devez configurer le plug-in de telle sorte qu'il puisse être utilisé par l'analyseur de trace et de journaux. Procédez comme suit :
Vous devez inclure les dépendances de plug-in suivantes dans le fichier manifeste. Ouvrez le fichier plugin.xml dans un éditeur de texte. Localisez l'élément souhaité dans le fichier et ajoutez-lui les dépendances de plug-in. Par exemple :
<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>
Remarque : les plug-ins souhaités spécifiés ci-avant doivent soit être localisés dans le répertoire des plug-ins Eclipse soit être inclus dans l'espace de travail courant.
Vous devez définir un point d'extension pour chaque type de fichier journal d'application à analyser et à importer dans l'analyseur de trace et de journaux. Vous trouverez ci-après un exemple de point d'extension pour l'application MyApp comportant un adaptateur de règles ainsi qu'un adaptateur statique.
<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>
Si vous voulez personnaliser le point d'extension pour votre programme d'analyse syntaxique de journaux, vous devez effectuer les mises à jour ci-dessous.
<parserParameter name="Default" value="./MyAdapter/myadapter.adapter"> </parserParameter>
Les zones spécifiées ci-dessus créent une option pour MyApp
myapp.log dans l'assistant d'importation de fichier journal, comme
indiqué ci-après :
Vous pouvez utiliser un fichier plugin.properties pour définir dans le fichier plugin.xml certaines propriétés qui pourraient nécessiter des versions différentes. Par exemple, s'il est nécessaire de traduire dans différentes langues des chaînes de texte qui figureront dans l'assistant Importation du fichier journal, vous pouvez les définir dans le fichier plugin.properties et inclure plusieurs fichiers de propriétés pour les langues à prendre en charge. Dans le fichier plugin.properties, vous définissez les variables de substitution pouvant être utilisées dans le fichier plugin.xml. Le fichier plugin.properties associé au fichier plugin.xml décrit plus haut doit ressembler à l'exemple suivant :
# Properties for RulesParser Plugin pluginName = RulesParser providerName = MyCompany # logParser extension point message(s): STR_MYAPP_PARSER_DESCRIPTION = Programme d'analyse syntaxique des règles MyApp v1.0 STR_MYAPP_TOOLTIP1 = Entrez l'emplacement du fichier journal STR_MYAPP_TOOLTIP2 = Sélectionnez la version du fichier journal à importer
Conseil : une application peut écrire des données dans son fichier journal dans différentes langues, en fonction de l'environnement local dans lequel elle est exécutée. Les classes d'analyseur syntaxique statique ou les règles d'expression régulière sont écrites pour analyser un fichier journal dans une seule langue. Dès lors, pour prendre en charge un type de fichier journal qui peut être écrit dans plusieurs langues, il faut créer pour chaque langue un fichier d'adaptation d'analyseur syntaxique statique ou un fichier d'adaptation de règles distinct. Ensuite, dans le point d'extension logParser pour ce type de fichier journal, il faut ajouter une balise parserParameter pour chaque fichier d'adaptation afin de spécifier la langue à laquelle elle s'applique dans la zone pour le nom. N'oubliez pas d'ajouter les valeurs de nom parserParameter à la liste dans l'attribut defaultValue pour la zone pour la version. Ceci permettra à l'utilisateur de choisir la langue du fichier journal lors de l'importation de ce dernier.
Par exemple, vous pouvez ajouter les paramètres d'analyseur syntaxique suivants au point d'extension logParser pour prendre en charge l'importation de journaux en anglais, en français et en allemand :
<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"/>
Cette étape est obligatoire si vous créez un analyseur syntaxique statique.
Pour les analyseurs syntaxiques statiques, la classe d'analyseur syntaxique statique que vous avez créée doit être spécifiée dans le fichier plugin.xml à l'aide d'une extension staticParser. Ce point d'extension permettra de trouver la classe lorsqu'elle est utilisée pour analyser un fichier dans le scénario Importation de journal.
Ajoutez le point d'extension suivant :
<extension
point="org.eclipse.hyades.logging.adapter.config.staticParser">
<parserClassname
name="myLogParser33.MyStaticParser">
</parserClassname>
</extension>
Créez une classe de programme d'analyse syntaxique d'encapsuleur statique qui étend org.eclipse.hyades.logging.adapter.config.StaticParserWrapper. Cette classe est utilisée tant pour les analyseurs syntaxiques statiques que pour les analyseurs syntaxiques fondés sur des règles, afin d'exécuter le fichier de configuration d'adaptateur associé à la version sélectionnée par l'utilisateur dans l'assistant Importation de journal à l'aide du moteur d'exécution d'adaptateur de journal générique.
/*
* 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";
}
}
Pour vérifier que vous avez correctement configuré le fichier manifeste du plug-in, vous pouvez exécuter votre projet de plug-in dans un nouveau plan de travail d'exécution. Procédez comme suit :
Pour déployer le plug-in de votre analyseur de journaux dans un plan de travail eclipse, vous devez mettre en forme les fichiers de plug-in en les exportant dans un fichier zip. Procédez comme suit :
<?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>
Vous pouvez déployer le plug-in de votre programme d'analyse syntaxique de journaux en dézippant le fichier zip que vous venez de créer dans le répertoire eclipse d'une installation eclipse. Vous pouvez maintenant tester le nouveau plug-in du programme d'analyse syntaxique de journaux à l'aide de l'analyseur de trace et de journaux.
Pour déployer le plug-in de votre programme d'analyse syntaxique de journaux sur un système distant afin qu'un fichier journal puisse être importé à distance, dézippez le fichier zip que vous venez de créer dans le répertoire d'installation d'Agent Controller sur le système distant. Redémarrez Agent Controller.
Concepts connexes
Tâches connexes
Création d'un programme d'analyse syntaxique de journaux
Création d'un adaptateur statique
Création d'un adaptateur fondé sur des règles
Test d'un programme d'analyse syntaxique de journaux
Configuration d'un projet de plug-in pour un programme d'analyse syntaxique de journaux
Références associées
Structure du fichier de configuration d'adaptateur
Editeur de configuration d'adaptateur
Syntaxe d'une expression régulière
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.