建立外掛程式專案來包含日誌剖析器的成品之後,您必須配置外掛程式,以便日誌和追蹤分析器能夠使用它。 請遵循下列步驟:
下列外掛程式相依關係必須包括在外掛程式 Manifest 檔中。 在文字編輯器中開啟 plugin.xml 檔。在檔案中尋找必要元素,然後將外掛程式相依關係新增到該元素中。例如:
<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>
附註:上方所述的必要外掛程式必須放置在 Eclipse 外掛程式目錄中,或併入目前的工作區中。
您必須定義延伸點給您要剖析及匯入日誌和追蹤分析器的每個應用程式日誌檔類型。 以下是定義了規則配接器和靜態配接器的 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>
如果要自訂日誌剖析器的延伸點,您必須進行若干更新:
<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 延伸點訊息: STR_MYAPP_PARSER_DESCRIPTION = MyApp 規則剖析器 1.0 版 STR_MYAPP_TOOLTIP1 = 輸入日誌檔的位置 STR_MYAPP_TOOLTIP2 = 選取要匯入的日誌檔版本
提示:視執行應用程式的語言環境而定,應用程式可能會用不同的語言將資料寫入自己的日誌檔中。但會用單一語言寫入靜態剖析器類別或正規表示式規則,以剖析日誌檔。因此,如果要支援可用多種語言寫入的日誌檔類型,則必須用每一種語言來建立個別的靜態剖析器配接器檔案或規則配接器檔案。然後,要在該日誌檔類型的 logParser 延伸點中,為每個配接器檔案新增一個 parserParameter 標示,以在名稱欄位中指定要套用的語言。請務必將 parserParameter 名稱值新增到版本欄位 defaultValue 屬性的清單中。這個動作可讓使用者在匯入日誌檔時,選擇日誌檔的正確語言。
例如,下列剖析器參數可新增至 logParser 延伸點,以支援匯入的英文、法文和德文日誌:
<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"/>
如果您正在建立靜態剖析器,請務必執行這個步驟。
您必須針對靜態剖析器,使用 staticParser 延伸規格,在 plugin.xml 中指定您已建立的靜態剖析器類別。這個延伸點可讓
您在「日誌匯入實務」中使用類別來剖析檔案時,找得到該類別。
新增下列延伸點:
<extension point="org.eclipse.hyades.logging.adapter.config.staticParser"> <parserClassname name="myLogParser33.MyStaticParser"> </parserClassname> </extension>
請建立繼承 org.eclipse.hyades.logging.adapter.config.StaticParserWrapper 的靜態封套類別。 這個類別用於靜態剖析器以及規則型剖析器,其用「通用日誌配接器」執行時期,來執行和使用者在「日誌匯入」精靈中所指定之版本有關的配接器配置檔。
/* * 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 檔,您可以在執行時期工作台中執行您的外掛程式專案。 請遵循下列步驟:
如果要將您的日誌剖析器外掛程式部署在 Eclipse 工作台中,您必須將外掛程式檔匯出到 zip 檔中來套裝它們。 請遵循下列步驟:
<?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>
您可以在 Eclipse 安裝架構的 Eclipse 目錄中,將剛建立的 zip 檔解壓縮,來部署您的日誌剖析器外掛程式。現在,您已準備好利用日誌和追蹤分析器來測試新建立的日誌剖析器外掛程式。
如果要將日誌剖析器外掛程式部署在遠端系統中,使日誌檔能夠進行遠端匯入,請在遠端系統的 Agent Controller 安裝目錄中,unzip 剛建立的 zip 檔。 重新啟動 Agent Controller。
相關概念
相關作業
建立日誌剖析器
建立靜態配接器
建立規則型配接器
測試日誌剖析器
設定日誌剖析器的外掛程式專案
相關參照
配接器配置檔結構
配接器配置編輯器
正規表示式文法
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.