使用 Log4J 記載範例

這個範例示範 TPTP 如何支援以 Apache Log4J 記載 API 來記載 Common Base Events。 使用者會體驗到如何將 Common Base Event 記載到主控台和日誌記載代理程式。

如果您尚未執行這個動作,請利用檔案 > 新建 > 範例... > Apache Log4J 記載範例來建立範例。

範例的內容包含將 Common Base Events 記載至 Apache Log4J 日誌程式所需的 Java 原始程式碼、相依關係及配置檔。

編譯和執行這個範例需要 Apache Log4J 1.2.8(含)以上的版本。

假設

  1. 從工作台的「側寫和記載視景」中啟動這個應用程式時,應用程式啟動配置或 Agent Controller 應用程式或服務類別路徑包含 Apache Log4J 1.2.8 或更新版本。
  2. 'log4j.configuration' 環境變數設為 Apache Log4J 記載配置檔 (HyadesLoggingLog4JSample.xml) 的絕對路徑和名稱,採用 URL 格式。例如,file:/<workspace>/HyadesLoggingLog4JProject/cfg/HyadesLoggingLog4JSample.xml。
  3. <Apache Log4J logging JAR>/org/apache/log4j/xml/log4j.dtd 所定義的「Apache Log4J 文件類型定義」(DTD) 會複製到 <workspace>/HyadesLoggingLog4JProject/cfg/ 目錄中,供 Apache Log4J 記載配置檔 (file:/<workspace>/HyadesLoggingLog4JProject/cfg/HyadesLoggingLog4JSample.xml) 使用。
如果要執行這個範例及自動連接到「日誌記載代理程式」,請遵循下列步驟:
  1. 確認所有的編譯錯誤都已修正。
  2. 如果您使用獨立安裝的 Agent Controller(AC),請確定它已啟動(非必要)。 另外,您也可以使用直接連線,也就是工作台所併入的一組有限數量的 AC 服務。
  3. 開啟「側寫和記載視景」(視窗 > 開啟視景 > 其他... > 側寫和記載)。
  4. 從「側寫和記載視景」中執行範例類別(執行 > 設定檔... > 建立「Java 應用程式」類型的新啟動配置 > 將專案名稱設為範例的專案名稱 > 將 Main 類別設為 'HyadesLoggingLog4JSample' > 切換至「引數」標籤並指定下列 JVM 內容:-Dlog4j.configuration="file:/<workspace>/HyadesLoggingLog4JProject/cfg/HyadesLoggingLog4JSample.xml" >切換至「監視器」標籤 > 取消選取「Java 側寫」並選取「代理程式探索器」 > 設定檔)。
  5. 過了幾秒之後,應該會自動分離和連接日誌記載代理程式。 請選取探索到的日誌記載代理程式,在「側寫和記載視景」中開啟「日誌視圖」來檢視所記載的 Common Base Event 日誌記錄(視窗 > 顯示視圖 > 其他... > 側寫和記載 > 日誌視圖 > 確定)。
  6. 自動更新「側寫和記載視景」中的「日誌視圖」(<用滑鼠右鍵按一下 'HyadesLoggingLog4JSample' 日誌記載代理程式> > 自動更新)。

另外,如果要執行這個範例和手動連接到「日誌記載代理程式」,請遵循下列步驟:

  1. 確認所有的編譯錯誤都已修正。
  2. 如果您使用獨立安裝的 Agent Controller(AC),請確定它已啟動(非必要)。 另外,您也可以使用直接連線,也就是工作台所併入的一組有限數量的 AC 服務。
  3. 從「Java 視景」中執行範例類別(執行 > 執行... > 建立「Java 應用程式」類型的新啟動配置 > Main 類別 > 搜尋... > HyadesLoggingLog4JSample > 確定 >切換至「引數」標籤並指定下列 JVM 內容: -Dlog4j.configuration="file:/<workspace>/HyadesLoggingLog4JProject/cfg/HyadesLoggingLog4JSample.xml" > 執行)。
  4. 開啟「側寫和記載」視景(Window > 開啟視景 > 其他... > 側寫和記載)。
  5. 在「側寫和記載視景」中連接至 'HyadesLoggingLog4JSample' 日誌記載代理程式(執行 > 側寫... > 連接 - Java 程序 > 新建 > 「主機」標籤 > 如果您並未使用獨立安裝的 Agent Controller,請使用「本端直接連接」。 否則,請使用有效的主機名稱和埠。> 「代理程式」標籤 > 按兩下 HyadesLoggingLog4JSample 代理程式 > 選取「目的地」標籤 > 側寫專案 > 瀏覽... > 'HyadesLoggingLog4JProject' > 確定 > 側寫)。
  6. 開始監督 'HyadesLoggingLog4JSample'「日誌記載代理程式」(<用滑鼠右鍵按一下'HyadesLoggingLog4JSample'「日誌記載代理程式」> > 開始監督)。
  7. 在「側寫和記載視景」開啟「日誌視圖」以檢視已記載的 Common Base Event 日誌記錄(Window > 顯示視圖 > 其他... > 側寫和記載 > 日誌視圖 > 確定)。
  8. 在「側寫和記載」視景自動更新「日誌視圖」(<用滑鼠右鍵按一下 'HyadesLoggingLog4JSample' 日誌記載代理程式> > 自動更新)。