配置監視即時應用程式的配接器

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

必備條件:

請遵循下列步驟來配置配接器,以便進行監視。

更新輸出器元件

附註:當建立新的配接器配置檔時,依預設,它會配置成使用 CBELogOutputter 類別。 如果您沒有變更這項設定,您可以略過這個程序。

您必須更新配接器配置檔中的輸出器元件,才能使用將 Common Base Event 物件寫入記載代理程式的 CBELogOutputter 類別。 您可以更新現有的輸出器元件或新增一個新的輸出器元件。

如果要新增輸出器元件,請執行下列動作:

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

更新環境定義實例

如果您要日誌剖析器連續監視日誌檔,您必須更新連續作業之配接器配置檔的環境定義實例內容。

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

啟動 Java 程序來執行配接器

您可以在外部從 Windows 環境的批次檔或從非 Windows 環境的 Shell Script 執行您建立的日誌配接器。 以下是可用來啟動將執行日誌配接器之 Java 程序的範例檔。
附註:如果要在系統中執行通用日誌配接器,這個系統必須安裝 Hyades。

Windows 批次檔:

@rem 用法:runregex
@rem 請變更下列各行來指向執行時期的解壓縮目錄
@rem 以及日誌配接器所在的目錄
SET HYADES_HOME=d:\hyadesDC
SET YOUR_ADAPTER_DIRECTORY=MyAdapterDirectory
SET CONFIG_FILE=%HYADES_HOME%\%YOUR_ADAPTER_DIRECTORY%\myadapter.adapter
PUSHD %HYADES_HOME%\%YOUR_ADAPTER_DIRECTORY%
java -classpath "%HYADES_HOME%\lib\glaconfigs.jar;%HYADES_HOME%\lib\hexr.jar;%HYADES_HOME%\lib\hgla.jar;%HYADES_HOME%\lib\hglaconfig.jar;%HYADES_HOME%\lib\hlcore.jar;%HYADES_HOME%\lib\hlevents.jar;%HYADES_HOME%\lib\hparse.jar;;%HYADES_HOME%\lib\logparsers.jar;%HYADES_HOME%\lib\xalan.jar;" org.eclipse.hyades.logging.adapter.Adapter -ac "%CONFIG_FILE%" -cc "%CONFIG_FILE%"
POPD

非 Windows 批次檔:
#!/bin/sh
# 用法:runregex_example.sh
# 請變更下面這行來指向執行時期的解壓縮目錄
HYADES_HOME=/home/hyadesDC
export HYADES_HOME
YOUR_DIRECTORY=/yourdirectory
export YOUR_DIRECTORY

CONFIG_FILE=$HYADES_HOME/$YOUR_DIRECTORY/myadapter.adapter
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd $HYADES_HOME/$YOUR_DIRECTORY

java -classpath "$HYADES_HOME\lib\glaconfigs.jar;$HYADES_HOME\lib\hexr.jar;$HYADES_HOME\lib\hgla.jar;$HYADES_HOME\lib\hglaconfig.jar;$HYADES_HOME\lib\hlcore.jar;$HYADES_HOME\lib\hlevents.jar;$HYADES_HOME\lib\hparse.jar;;$HYADES_HOME\lib\logparsers.jar;$HYADES_HOME\lib\xalan.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. 按一下主機標籤,選取應用程式日誌所在的主機。
    附註:如果要監視即時應用程式日誌,在應用程式的相同系統中,Hyades 資料收集引擎必須在執行中。
  5. 按一下代理程式標籤,利用方向鍵來選取您配置的記載代理程式。

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

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

 

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

相關作業
建立日誌剖析器

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