部署日志解析器插件项目

在创建了插件项目以包含日志解析器的构件之后，需要配置插件以便“日志和跟踪分析器”可以使用它。遵循下列步骤：

1. 将插件依赖项添加至插件的清单文件
2. 将日志解析器的扩展点添加至插件的清单文件
3. 创建静态包装器解析器类
4. 验证日志解析器插件设置
5. 打包日志解析器插件以进行部署
6. 部署日志解析器

添加插件依赖项

下列插件依赖项必须包括在插件清单文件中。在文本编辑器中打开 plugin.xml 文件并在运行时元素后面添加下列行：

   
<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>

添加日志解析器扩展点

必须为想要解析并导入到“日志和跟踪分析器”中的每种类型的应用程序日志文件定义扩展点。以下是 MyApp 应用程序的定义了规则适配器和静态适配器的样本扩展点：

 <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>

要定制日志解析器的扩展点，必须进行更新：

1. 用为日志解析器插件项目创建的插件的名称替换此扩展点中的 RulesParser。
2. 用插件中包含适配器文件的文件夹名称替换此扩展点中的 MyAdapter。
3. <parser> 标记指定有关解析器的高级信息，它是必需的元素。替换下列属性：
   • name － 此解析器的名称（可与 ui_name 相同）
   • description － 此解析器的描述，当选择此解析器时，将显示在“导入日志文件”向导中
   • icon － 此解析器的将显示在“导入日志文件”向导中的图标
   • class － 解析器包装器类的完整类名
   • ui_name － 此解析器的将包括在“导入日志文件”向导的“选择的日志文件”列表中的名称
   • id － 此解析器扩展点的唯一标识
4. 第一个 <field> 标记定义用于选择日志文件位置的用户界面字段。它是必需的元素。替换下列属性：
   • useBrowse － 是否对此字段显示浏览按钮
   • defaultValue － 显示在此字段中的缺省值
   • name － 此字段的显示在“导入日志文件”向导中的名称
   • tooltip － 在“导入日志文件”向导中当光标悬浮在字段上方时将显示的帮助文本
   • id － 此字段的将被传递至解析器包装器类的名称 － 不要更改此名称
   • browseType － 显示在浏览对话框中的文件的类型
5. 第二个 <field> 标记定义用于选择要导入的日志文件版本的用户界面组合框。它是必需的元素。替换下列属性：
   • defaultValue － 列示想要显示在组合框列表中的所有版本
   • name － 此字段的显示在“导入日志文件”向导中的名称
   • tooltip － 在“导入日志文件”向导中当光标悬浮在字段上方时将显示的帮助文本
   • id － 此字段的将被传递至解析器包装器类的名称 － 不要更改此名称
   • ui_type － 指示这是一个组合框字段
6. <parserParameter> 标记定义要将哪个适配器配置文件用于受支持的每个版本的日志文件。替换下列属性：
   • name － 适配器配置文件名必须与列示在用户界面组合框 defaultValue 属性中的版本字符串精确匹配
   • value － 适配器配置文件的目录和名称

         <parserParameter
   name="Default"
               value="./MyAdapter/myadapter.adapter">
         </parserParameter>

上面指定的字段将在“导入日志”向导中为 MyApp myapp.log 创建选项，如下所示：

可以使用 plugin.properties 文件来定义 plugin.xml 文件中的某些属性，这些属性可能需要具有不同的版本。例如，如果存在一些将被包括在“导入日志文件”向导上的文本字符串，这些文本字符串需要翻译为不同的语言，则可以在 plugin.properties 文件中定义它们，您可以包括想要支持的各种语言的不同属性文件。在 plugin.properties 文件中定义可在 plugin.xml 文件中使用的替换变量。上面 plugin.xml 的 plugin.properties 文件看起来将类似如下：

# 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

为解析器创建包装器类

创建继承 org.eclipse.hyades.logging.adapter.config.StaticParserWrapper 的静态包装器类。此类既用于静态解析器又用于基于规则的解析器。在日志解析器插件项目中创建类。可以通过用日志解析器插件项目的名称替换 RulesParser 来使用下面的示例类。

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

验证日志解析器插件设置

要验证是否正确配置了插件清单文件，可在新的运行时工作台中运行插件项目。遵循下列步骤：

1. 通过选择窗口 > 打开透视图 > 其它 > 插件开发切换至“插件”透视图。
2. 从“插件开发”透视图中选择插件项目。
3. 从工具栏中选择运行 > 运行方式 > 运行时工作台。
4. 在新的工作台中，从菜单中选择文件 > 导入。
5. 在“导入”向导中选择日志文件，然后单击下一步。
6. 在“日志文件”页上单击添加以添加日志文件。在“添加日志文件”窗口中，验证新的日志文件类型是否包括在选择的日志文件列表中。
7. 选择日志文件类型。验证详细信息选项卡上的所有字段和文本是否都正确。
8. 指定日志文件位置的值。
9. 单击确定。
10. 单击完成以导入具有新的日志文件类型的日志文件。验证日志文件记录是否显示在“日志视图”中。

打包日志解析器插件以进行部署

要将日志解析器插件部署到 eclipse 工作台，需要通过将插件文件导出为压缩文件来打包它们。遵循下列步骤：

1. 在文本编辑器中打开 plugin.xml 文件。
2. 验证它是否包括插件类文件的运行时库 jar 文件。例如：

   	<runtime>
   		<library name="parsers.jar">
   			<export name="*"/>
   		</library>
   	</runtime>
   	

3. 要将日志解析器部署到远程主机以便您可以从该远程主机导入日志文件，必须为日志解析器创建“代理控制器”插件配置文件。遵循下列步骤：
   1. 在日志解析器插件中创建名为 config 的文件夹。
   2. 在 config 文件夹中创建名为 pluginconfig.xml 的文件。例如：

      <?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. 用日志解析器插件项目的名称替换 RulesParser。
   注意：如果要扩展现有解析器，需要 pluginconfig.xml 中的其它参数来指定父适配器文件的根目录。下列参数是必需的：

    <Variable name="GLA_CONFIG_PATH" position="append" value="%RASERVER_HOME%\plugins\PARSER_PLUGIN\config"/>
      <Parameter position="append" value="config_path=%GLA_CONFIG_PATH%"/>
    

   其中 PARSER_PLUGIN 是要扩展的日志解析器的目录。新的 <Variable> 元素必须添加为 <Application> 元素的第一个子节点，而新的 <Parameter> 元素必须添加为 <Application> 元素的最后一个子代。
4. 在文本编辑器中打开 build.properties 文件。
5. 将存储适配器配置文件的文件夹和 plugin.properties 文件添加至“二进制构建”列表。另外，如果将在远程主机上进行部署，则还应添加 config 文件夹。例如，以下是一个示例 build.properties 文件：

   bin.includes = MyAdapters/,\
   
   config/,\
   
   plugin.xml,\
   
   plugin.properties,\
   
   parsers.jar
   source.parsers.jar = src/
   output.parsers.jar = bin/
   

6. 通过选择文件 > 导出导出插件文件。
7. 在“导出”向导中选择“> 可部署的插件和段”。
8. 单击下一步。
9. 在“导出插件和段”页上，在可用的插件和段列表中选择插件。
10. 在“导出选项”字段中选择部署为单个可部署的压缩文件。
11. 指定压缩文件的目标文件名。
12. 单击完成。

部署日志解析器

可以通过解压缩刚刚在 eclipse 安装的插件目录中创建的压缩文件来部署日志解析器插件。现在就可以通过使用“日志和跟踪分析器”来测试新创建的日志解析器插件了。

要在远程系统上部署日志解析器插件以便可以远程方式导入日志文件，在远程系统上“代理控制器”安装目录中解压缩刚刚创建的压缩文件。

相关任务
创建日志解析器
创建静态适配器
创建基于规则的适配器
测试日志解析器
为日志解析器建立插件项目

相关参考
适配器配置文件结构
适配器配置编辑器
正则表达式语法

(C) Copyright IBM Corporation 2000, 2004. All Rights Reserved.