部署日誌剖析器外掛程式專案

建立外掛程式專案來包含日誌剖析器的成品之後，您必須配置外掛程式，以便日誌和追蹤分析器能夠使用它。 請遵循下列步驟：

1. 將外掛程式相依性加入外掛程式的 Manifest 檔中
2. 將日誌剖析器延伸點外掛程式的 Manifest 檔中
3. 建立靜態封套剖析器類別
4. 驗證日誌剖析器外掛程式設定
5. 套裝日誌剖析器外掛程式以進行部署
6. 部署日誌剖析器

新增外掛程式相依關係

下列外掛程式相依關係必須包括在外掛程式 Manifest 檔中。 請在文字編輯器中開啟 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 - 剖析器 Wrapper 類別的完整類別名稱
   • ui_name - 將併入「匯入日誌檔」精靈的「所選日誌檔」清單中的這個剖析器的名稱
   • id - 這個剖析器延伸點的唯一 ID
4. 第一個 <field> 標示定義用來選取日誌檔位置的 UI 欄位。 它是一個必要元素。 請取代下列屬性：
   • useBrowse - 是否顯示這個欄位的瀏覽按鈕
   • defaultValue - 這個欄位所顯示的預設值
   • name - 「匯入日誌檔」精靈中所顯示的這個欄位的名稱
   • tooltip - 當游標停在欄位上時，「匯入日誌檔」精靈將顯示的說明文字
   • id - 將傳給剖析器 Wrapper 類別的這個欄位的名稱 - 請勿變更這個名稱
   • browseType - 瀏覽對話框中所顯示的檔案類型
5. 第二個 <field> 標示定義用來選取要匯入的日誌檔版本的 UI 組合框。 它是一個必要元素。 請取代下列屬性：
   • defaultValue - 在組合框中列出您要顯示的所有版本
   • name - 「匯入日誌檔」精靈中所顯示的這個欄位的名稱
   • tooltip - 當游標停在欄位上時，「匯入日誌檔」精靈將顯示的說明文字
   • id - 將傳給剖析器 Wrapper 類別的這個欄位的名稱 - 請勿變更這個名稱
   • ui_type - 指示這是一個組合框欄位
6. <parserParameter> 標示定義每個支援的日誌檔版本要用哪個配接器配置檔。請取代下列屬性：
   • name - 配接器配置檔名稱必須完全符合 UI 組合框 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 檔看起來如下：

# RulesParser 外掛程式的內容

pluginName = RulesParser
providerName = MyCompany

# logParser extension point message(s):
STR_MYAPP_PARSER_DESCRIPTION = MyApp 規則剖析器 1.0 版
STR_MYAPP_TOOLTIP1           = 輸入日誌檔的位置
STR_MYAPP_TOOLTIP2           = 選取要匯入的日誌檔版本

建立剖析器的封套類別

請建立繼承 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"; 
	}
}

驗證日誌剖析器外掛程式設定

如果要確認您已正確配置外掛程式 Manifest 檔，您可以在執行時期工作台中執行您的外掛程式專案。 請遵循下列步驟：

1. 選取視窗 > 開啟視景 > 其他 > 外掛程式開發來切換到「外掛程式」視景。
2. 從「外掛程式開發」視景中，選取您的外掛程式專案。
3. 從工具列中，選取執行 > 執行身分 > 執行時期工作台。
4. 在新工作台中，從功能表中，選取檔案 > 匯入。
5. 在「匯入」精靈中，選取日誌檔，再按下一步。
6. 在「日誌檔」頁面中，按一下新增來新增日誌檔。在「新增日誌檔」視窗中， 確認您的新日誌檔類型已併入所選日誌檔清單中。
7. 選取您的日誌檔類型。請確認詳細資料標籤中的所有欄位和文字都正確。
8. 指定日誌檔位置的值。
9. 按一下確定。
10. 按一下完成來匯入新日誌檔類型的日誌檔。請確認日誌檔記錄已顯示在「日誌」視圖中。

套裝日誌剖析器外掛程式以進行部署

如果要將您的日誌剖析器外掛程式部署在 Eclipse 工作台中，您必須將外掛程式檔匯出到 zip 檔中來套裝它們。 請遵循下列步驟：

1. 在文字編輯器中開啟 plugin.xml 檔。
2. 確認它包括外掛程式類別檔的執行時期程式庫 JAR 檔。 例如：

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

3. 如果要將日誌剖析器部署在遠端主機中，以便能夠從這個遠端主機匯入日誌檔，您必須建立日誌剖析器的 Agent Controller 外掛程式配置檔。 請遵循下列步驟：
   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. 在「匯出選項」欄位中，選擇部署為單一可部署的 ZIP 檔。
11. 指定 zip 檔的目的地檔名。
12. 按一下完成。

部署日誌剖析器

您可以在 Eclipse 安裝架構旳 plugin 目錄中，將剛建立的 zip 檔解壓縮，來部署您的日誌剖析器外掛程式。 現在，您已準備好利用日誌和追蹤分析器來測試新建立的日誌剖析器外掛程式。

如果要將日誌剖析器外掛程式部署在遠端系統中，使日誌檔能夠進行遠端匯入，請在遠端系統的 Agent Controller 安裝目錄中，unzip 剛建立的 zip 檔。

相關作業
建立日誌剖析器
建立靜態配接器
建立規則型配接器
測試日誌剖析器
設定日誌剖析器的外掛程式專案

相關參照
配接器配置檔結構
配接器配置編輯器
正規表示式文法

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