Déploiement du projet de plug-in du programme d'analyse syntaxique de journal

Conditions prérequises :

Après avoir créé un projet de plug-in destiné à contenir les artefacts d'un programme d'analyse syntaxique de journal, vous devez configurer le plug-in de telle sorte qu'il puisse être utilisé par l'analyseur de trace et de journaux. Procédez aux opérations ci-dessous.

  1. Ajoutez les dépendances de plug-in au fichier manifeste du plug-in.
  2. Ajoutez un point d'extension du programme d'analyse syntaxique de journal au fichier manifeste du plug-in.
  3. Créez une classe de programme d'analyse syntaxique d'encapsuleur statique.
  4. Vérifiez les paramètres de plug-in du programme d'analyse syntaxique de journal
  5. Mettez en forme le plug-in du programme d'analyse syntaxique de journal pour le déploiement
  6. Déployez votre programme d'analyse syntaxique de journal

Ajout des dépendances de plug-in

Vous devez inclure les dépendances de plug-in suivantes dans le fichier manifeste. Ouvrez le fichier plugin.xml dans un éditeur de texte et ajoutez les lignes suivantes après l'élément 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>

Ajout d'un point d'extension du programme d'analyse syntaxique de journal

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 journal, vous devez effectuer les mises à jour ci-dessous.

  1. Remplacez la chaîne RulesParser figurant dans ce point d'extension par le nom du plug-in que vous avez créé pour le projet de plug-in du programme d'analyse syntaxique de journal.
  2. Remplacez la chaîne MyAdapter figurant dans ce point d'extension par le nom du dossier de votre plug-in qui contient vos fichiers d'adaptateur.
  3. La balise <parser> indique un niveau d'information élevé pour l'analyseur et est requise. Remplacez les attributs suivants :
  4. La première balise <field> définit la zone de l'interface de sélection de l'emplacement du fichier journal. Il s'agit d'un élément requis. Remplacez les attributs suivants :
  5. La deuxième balise <field> définit la zone de liste de l'interface de sélection de la version du fichier journal à importer. Il s'agit d'un élément requis. Remplacez les attributs suivants :
  6. La balise <parserParameter> indique le fichier de configuration de l'adaptateur à utiliser pour chaque version de fichier journal prise en charge. Remplacez les attributs suivants :
Astuce : Définissez une valeur Default au cas où une correspondance pour la version est introuvable. Si vous disposez d'un seul fichier de configuration pour l'adaptateur, seul le paramètre Default parserParameter est nécessaire :
<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 :

Assistant d'importation de fichier journal indiquant myapp myapp.log comme une option à importer

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

Création d'une classe de programme d'analyse syntaxique d'encapsuleur statique

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 à la fois pour les programmes d'analyse syntaxique statiques et fondés sur des règles. Créez la classe dans le projet de plug-in du programme d'analyse syntaxique de journal. Vous pouvez utiliser l'exemple de classe ci-dessous en remplaçant la chaîne RulesParser par le nom du projet de plug-in de votre programme d'analyse syntaxique de journal.

/*
 * 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"; 
	}
}

Vérification des paramètres de plug-in du programme d'analyse syntaxique de journal

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 aux opérations ci-dessous.

  1. Passez dans la perspective Plug-in en sélectionnant Fenêtre > Ouvrir la perspective > Autre > Développement de plug-in.
  2. Dans la perspective Développement de plug-in, sélectionnez votre projet de plug-in.
  3. Dans la barre d'outils, sélectionnez Exécuter > Exécuter en tant que > Plan de travail d'exécution.
  4. Dans le nouveau plan de travail, à partir du menu, sélectionnez Fichier > Importer.
  5. Dans l'assistant d'importation, sélectionnez Fichier journal et cliquez sur Suivant.
  6. Dans la page Fichiers journaux, cliquez sur Ajouter pour ajouter un fichier journal. Dans la fenêtre d'ajout d'un fichier journal, vérifiez que le type de votre nouveau fichier journal figure dans la liste Fichiers journaux sélectionnés.
  7. Sélectionnez le type de votre fichier journal. Vérifiez que toutes les zones et que le texte figurant dans l'onglet Détails sont corrects.
  8. Spécifiez l'emplacement du fichier journal.
  9. Cliquez sur OK.
  10. Cliquez sur Fin pour importer le fichier journal de type nouveau. Vérifiez que les enregistrements du fichier journal apparaissent dans la vue Journal.

Mise en forme du plug-in de votre programme d'analyse syntaxique de journal pour le déploiement

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 aux opérations ci-dessous.

  1. Ouvrez le fichier plugin.xml dans un éditeur de texte.
  2. Vérifiez qu'il contient un fichier jar de bibliothèque d'exécution pour les fichiers de classe de votre plug-in. Par exemple :
    	<runtime>
    		<library name="parsers.jar">
    			<export name="*"/>
    		</library>
    	</runtime>
    	
  3. Pour déployer votre programme d'analyse syntaxique de journal sur un hôte distant en vue d'importer des fichiers journaux à partir de cet hôte distant, créez un fichier de configuration de plug-in Agent Controller pour votre analyseur de journaux. Procédez aux opérations ci-dessous.
    1. Créez un dossier dans le plug-in de votre programme d'analyse syntaxique de journal appelé config.
    2. Créez un fichier appelé pluginconfig.xml dans le dossier config. Exemple :
      <?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. Remplacez la chaîne RulesParser par le nom du projet de plug-in de votre programme d'analyse syntaxique de journal.
    Remarque : si vous développez un analyseur existant, vous devez définir un paramètre supplémentaire dans le fichier pluginconfig.xml pour spécifier le répertoire racine des fichiers de l'adaptateur parent. Les paramètres suivants sont requis :
     <Variable name="GLA_CONFIG_PATH" position="append" value="%RASERVER_HOME%\plugins\PARSER_PLUGIN\config"/>
       <Parameter position="append" value="config_path=%GLA_CONFIG_PATH%"/>
     
    où PARSER_PLUGIN est le répertoire du programme d'analyse syntaxique de journal que vous développez. Le nouvel élément <Variable> doit être ajouté comme premier noeud enfant de l'élément <Application> alors que le nouvel élément <Parameter> doit être ajouté comme dernier enfant de l'élément <Application>.
  4. Ouvrez le fichier build.properties dans un éditeur de texte.
  5. Ajoutez le dossier dans lequel sont stockés les fichiers de configuration de l'adaptateur et le fichier plugin.properties à la liste Génération binaire. Ajoutez également le dossier config si vous voulez procéder au déploiement sur un hôte distant. Exemple de fichier build.properties :
    bin.includes = MyAdapters/,\
    
    config/,\
    
    plugin.xml,\
    
    plugin.properties,\
    
    parsers.jar
    source.parsers.jar = src/
    output.parsers.jar = bin/
    
  6. Exportez les fichiers de plug-in en sélectionnant Fichier > Exporter.
  7. Dans l'assistant d'exportation, sélectionnez >Plug-ins et fragments déployables.
  8. Cliquez sur Suivant.
  9. Sur la page Exportation de plug-ins et de fragments, sélectionnez votre plug-in dans la liste Plug-ins et fragments disponibles.
  10. Sélectionnez l'option de déploiement un fichier zip déployable unique dans la zone Options d'exportation.
  11. Indiquez le nom du fichier de destination du fichier zip.
  12. Cliquez sur Fin.

Déploiement de votre programme d'analyse syntaxique de journal

Vous pouvez déployer le plug-in de votre programme d'analyse syntaxique de journal en dézippant le fichier zip que vous venez de créer dans le répertoire plugin d'une installation eclipse. Vous pouvez maintenant tester le nouveau plug-in du programme d'analyse syntaxique de journal à l'aide de l'analyseur de trace et de journaux.

Pour déployer le plug-in de votre programme d'analyse syntaxique de journal 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.

 

Concepts connexes
Spécification du format Common Base Event

Tâches connexes
Création d'un programme d'analyse syntaxique de journal
Création d'un adaptateur statique
Création d'un adaptateur fondé sur des règles
Test d'un programme d'analyse syntaxique de journal
Configuration d'un projet de plug-in pour un programme d'analyse syntaxique de journal

Références connexes
Structure du fichier de configuration d'adaptateur
Editeur de configuration d'adaptateur
Syntaxe d'une expression régulière