配置配接器來進行即時應用程式監視作業

「通用日誌配接器」提供「輸出器」類別,讓配接器所產生的 Common Base Event 物件可以傳送到「記載代理程式」。 「日誌和追蹤分析器」可用來連接至「記載代理程式」,以即時監視及分析應用程式日誌。

必備條件:

請遵循下列步驟來配置您的配接器,以進行監視作業。

配置輸出器元件

附註:新的配接器配置檔建立好時,依預設,其配置會使用 CBELogOutputter 類別。如果您沒有變更此設定,則可跳過下列程序。

配接器配置檔中的「輸出器」元件需要更新為使用 CBELogOutputter 類別,以將 Common Base Event 物件寫入「記載代理程式」。您可以更新現有的「輸出器」元件,或新增「輸出器」元件。

若要新增「輸出器」元件:

  1. 若要編輯配接器配置檔,請在「導覽器」窗格中選取配接器配置檔。 按一下滑鼠右鍵來選取開啟工具 > 配接器配置編輯器。該檔案就會在編輯器中開啟。
  2. 在「配接器配置編輯器」視窗中,展開配接器 > 配置 > 環境定義實例節點。
  3. 用滑鼠右鍵按一下「環境定義實例」,然後選取新增 > 輸出器。「環境定義實例」中就會建立一個新的「輸出器」。
  4. 輸出器類型欄位中,選取 LoggingAgentOutputter
  5. 按一下 agentName 內容。內容詳細資料會顯示在右窗格中。
  6. 以所需的「記載代理程式」名稱來更新內容值。您將會在「日誌和追蹤分析器」中看到這就是「記載代理程式」所要監視的名稱。
  7. 如果您要「輸出器」先等一段時間,再將 Common Base Event 寫入「記載代理程式」,請新增一個叫做 waitUntilLoggingTime 的內容,並以毫秒為時間單位來設定該內容值。若要新增內容,請用滑鼠右鍵按一下新建的「輸出器」,然後選取新增 > 內容。 在新的「輸出器」節點下,會建立一個新內容。
  8. 若要啟用 CBELogOutputter 類別,您需要在「環境定義基本環境定義實作」中建立相關聯的「輸出器」元件。請開啟環境定義 > 環境定義基本實作環境定義
  9. 用滑鼠右鍵按一下環境定義基本實作環境定義,然後選取新增 > 元件。就會將新元件加入環境定義。
  10. 以下列值來配置新元件:
    名稱: 「輸出器」在環境定義中的名稱。例如:記載代理程式輸出器
    說明: 說明此「輸出器」的工作
    執行類別: org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter
    記載層次:「輸出器」元件應使用的內部記載層次。這個層次是以 CommonBaseEvent 嚴重性值為依據。數字愈大,訊息的嚴重性就愈高。 就「記載」層次而言,所指定的數字會讓「輸出器」元件只記載該嚴重性以上的內部「輸出器」訊息。71(含)以上的值表示「輸出器」將不會記載任何內部「輸出器」訊息。0 值表示 「輸出器」將會記載所有嚴重性的內部「輸出器」訊息。 建議值為 50,表示只會記載「重要」或「嚴重」的內部「輸出器」錯誤訊息。
    角色: 輸出器
    唯一 ID: 必須指向步驟 3 之「環境定義實例」中所定義的「輸出器」。請使用瀏覽按鈕來選取正確的 ID。
  11. 儲存配接器配置檔變更。

配置環境定義實例

如果您要日誌剖析器持續監視日誌檔,則需更新配接器配置檔的環境定義實例內容,以進行持續性的作業。

  1. 若要編輯配接器配置檔,請在「導覽器」視景中選取配接器配置檔。 按一下滑鼠右鍵來選取開啟工具 > 配接器配置編輯器。該檔案就會在編輯器中開啟。
  2. 在編輯器視窗中,選取配接器 > 配置 > 環境定義實例。「環境定義實例」詳細資料會顯示在右窗格中。
  3. 選取連續作業勾選框。
  4. 依需要來配置「閒置時間上限」及「暫停間隔」欄位。
  5. 儲存配接器配置檔變更。

啟動 Java 程序來執行配接器

您可以從 Windows 環境中的批次檔,或是非 Windows 環境中的 Shell Script,在外部執行您所建立的日誌配接器。 以下範例檔案可用來啟動 Java 程序,以執行您的日誌配接器。
附註若要連接及監視「通用日誌配接器」所建立的記載代理程式,必須將 Agent Controller 安裝在「通用日誌配接器」所要執行的系統上,而且必須先啟動 Agent Controller,再啟動「通用日誌配接器」。

Windows 批次檔:

@rem 用法:runregex
@rem 目的:使用範例配接器檔及範例日誌檔來說明「通用日誌配接器」(GLA) 執行時期的功能。
@rem 使用說明:在 GLA 執行環境中執行時,請將 %GLA_HOME% 環境變數的值,變更為解壓縮 GLA 執行時期的絕對路徑。
@rem 附註:在外掛程式(例如:Eclipse)執行環境中執行時,請建立一個暫時工作目錄,並將 %GLA_HOME% 環境變數的值,變更為
@rem       新建之暫時工作目錄的絕對路徑。另外,再建立一個 %GLA_HOME%\config 目錄,並將 org.eclipse.hyades.logging.adapter.config
@rem       外掛程式的內容複製到新建的 %GLA_HOME%\config 目錄。最後,建立一個 %GLA_HOME%\lib 目錄,並將下列 JAR 檔複製到新建的 %GLA_HOME%\lib 目錄:
@rem                    外掛程式                |     JAR
@rem        ---------------------------------------------------
@rem        org.eclipse.hyades.logging.adapter  |  hgla.jar
@rem        org.eclipse.hyades.logging.core     |  hlcbe101.jar
@rem        org.eclipse.hyades.logging.core     |  hlcore.jar
@rem        org.eclipse.hyades.execution.remote |  hexr.jar
@rem        org.eclipse.emf.ecore               |  ecore.jar
@rem        org.eclipse.emf.common              |  common.jar

SET GLA_HOME=d:\GenericLogAdapter
SET MY_DIRECTORY=MyAdapter
SET CONFIG_FILE=%GLA_HOME%\config\%MY_DIRECTORY%\myadapter.adapter
PUSHD %GLA_HOME%\config\%MY_DIRECTORY%\java -DGLA_HOME="%GLA_HOME%" -classpath "%GLA_HOME%\lib\hgla.jar;%GLA_HOME%\lib\hexr.jar;%GLA_HOME%\lib\hlcbe101.jar;%GLA_HOME%\lib\ecore.jar;%GLA_HOME%\lib\common.jar;%GLA_HOME%\lib\hlcore.jar" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%"
POPD

非 Windows 批次檔:
#!/bin/sh
# 用法:runregex_example.sh
# 目的:使用範例配接器檔案及範例日誌檔來說明「通用日誌配接器」(GLA) 執行時期的功能。
# 使用說明:在 GLA 執行環境中執行時,請將 $GLA_HOME 環境變數的值,變更為解壓縮 GLA 執行時期的絕對路徑。
# 附註:在外掛程式(例如:Eclipse)執行環境中執行時,請建立一個暫時工作目錄,並將 $GLA_HOME 環境變數的值,變更為
# 新建之暫時工作目錄的絕對路徑。另外,再建立一個 $GLA_HOME/config 目錄,並將 com.ibm.etools.logging.adapter.config
# 外掛程式的內容複製到新建的 $GLA_HOME/config 目錄。最後,建立一個 $GLA_HOME/lib 目錄,並將下列 JAR 檔複製到新建的 $GLA_HOME/lib 目錄:
# 外掛程式 | JAR
# ---------------------------------------------------
# org.eclipse.hyades.logging.adapter | hgla.jar
# org.eclipse.hyades.logging.core | hlcbe101.jar
# org.eclipse.hyades.logging.core | hlcore.jar
# org.eclipse.hyades.execution.remote | hexr.jar
# org.eclipse.emf.ecore | ecore.jar
# org.eclipse.emf.common | common.jar

GLA_HOME=/home/eclipse/GenericLogAdapter
export GLA_HOME

YOUR_DIRECTORY=MY_DIRECTORY
export MY_DIRECTORY

CONFIG_FILE="$GLA_HOME/config/$MY_DIRECTORY/myadapter.adapter"
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config/$MY_DIRECTORY

java -DGLA_HOME="$GLA_HOME" -classpath "$GLA_HOME/lib/hgla.jar:$GLA_HOME/lib/hexr.jar:$GLA_HOME/lib/hlcbe101.jar:$GLA_HOME/lib/ecore.jar:$GLA_HOME/lib/common.jar:$GLA_HOME/lib/hlcore.jar"org.eclipse.hyades.logging.adapter.Adapter -ac "$CONFIG_FILE" -cc "$CONFIG_FILE"

cd "$CUR_DIR"
依需要來配置檔案,以啟動 Java 程序來執行您的配接器。

監視即時應用程式日誌

現在您已準備好要監視即時應用程式日誌。

  1. 確定喜好設定中已啟用記載功能。
    1. 從主要工具列選取視窗 > 喜好設定。即開啟「喜好設定」精靈。
    2. 從左窗格選取側寫和記載。「側寫和記載」喜好設定會載入在右窗格中。
    3. 在「側寫和記載」選項下選取啟用記載功能

      在「側寫和記載」的喜好設定窗格中選取「啟用記載功能」勾選框

    4. 選取確定,以套用變更。
  2. 在「側寫和記載」視景中,按一下「側寫」側寫工具圖示工具列,並選取側寫。即開啟「側寫」精靈。
  3. 選取連接 - Java 程序,在清單底部按一下新建按鈕。即建立一個新的 Java 程序配置。
  4. 按一下主機標籤,然後選取應用程式日誌所在的主機(使用方向按鈕來將該主機移到選取的代理程式窗格)。
    附註:若要監視即時應用程式日誌,Agent Controller 必須在與應用程式相同的系統上執行。
  5. 按一下代理程式標籤,然後使用方向鍵來選取您所配置的「記載代理程式」。

    在側寫喜好設定精靈中,使用者所建立的記載代理程式位於左窗格中

  6. 按一下套用
  7. 按一下側寫來連接至「記載代理程式」。
  8. 在「側寫和記載」視景的「側寫監視器」視圖中,選取「記載代理程式」
  9. 用滑鼠右鍵按一下「記載代理程式」,然後選取開始監視
  10. 用滑鼠右鍵按一下「記載代理程式」,然後選取開啟工具 > 日誌視圖。應用程式日誌中的日誌事件就會載入至「日誌」視圖中。

 

相關概念
Hyades「通用日誌配接器」的概觀
Common Base Event 格式規格

相關作業
建立日誌剖析器

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