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

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

必備條件:

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

配置輸出器元件

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

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

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

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

配置環境定義實例

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

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

啟動 Java 程序來執行配接器

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

Windows 批次檔:

@rem 用法:runregex
@rem 目的:說明「通用日誌配接器 (GLA)」的功能
@rem 使用範例配接器檔案和範例日誌檔的執行時期。
@rem 假設:這個批次檔假設 GLA 執行時期和所需的檔案
@rem 皆儲存在下列目錄結構中:
@rem %GLA_HOME%\config - GLA 配接器配置檔
@rem %GLA_HOME%\lib - GLA 執行時期和所需的 JAR
@rem %GLA_HOME%\schema - GLA 配接器配置綱目檔
@rem 指示:
@rem 如果 GLA 執行時期和所需的檔案皆儲存在
@rem 上述假設目錄中,請將 %GLA_HOME%
@rem 環境變數的值變更成儲存 GLA 執行時期
@rem 和所需檔案的絕對路徑。
@rem 如果 GLA 執行時期檔案儲存在外掛程式(如 Eclipse)
@rem 環境中,請執行下列指示:
@rem 1) 建立暫時目錄以儲存 GLA 執行時期和所需的檔案。
@rem 2) 在步驟 1 所建立的暫時目錄中,
@rem 建立 config、lib 和 schema 目錄。
@rem 3) 將 %GLA_HOME% 環境變數的值變更成
@rem 在步驟 1 中所建立之暫時目錄的絕對路徑。
@rem 4) 將欲執行的配接器檔案複製到 %GLA_HOME%\config 目錄中。
@rem 例如,如果您想要執行 Apache 配接器檔案,則要將
@rem org.eclipse.hyades.logging.adapter.config
@rem 外掛程式的 Apache 目錄和其所有內容,複製到 %GLA_HOME%\config 目錄中。
@rem 5) 將 org.eclipse.hyades.logging.adapter
@rem 外掛程式的綱目目錄內容複製到 %GLA_HOME%\schema 目錄中。
@rem 6) 將下列 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 CONFIG_FILE=%GLA_HOME%\config\my.adapter 
@PUSHD %GLA_HOME%\config\ 
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.sh
# 目的:說明「通用日誌配接器 (GLA)」的功能
# 使用範例配接器檔案和範例日誌檔的執行時期。
# 假設:這個 Shell 檔假設 GLA 執行時期和所需的檔案
# 皆儲存在下列目錄結構中:
# %GLA_HOME%/config - GLA 配接器配置檔
# %GLA_HOME%/lib - GLA 執行時期和所需的 JAR
# %GLA_HOME%/schema - GLA 配接器配置綱目檔
# 指示:
# 如果 GLA 執行時期和所需的檔案皆儲存在
# 上述假設目錄中,請將 %GLA_HOME%
# 環境變數的值變更成儲存 GLA 執行時期
# 和所需檔案的絕對路徑。
# 如果 GLA 執行時期檔案儲存在外掛程式(如 Eclipse)
# 環境中,請執行下列指示:
# 1) 建立暫時目錄以儲存 GLA 執行時期和所需的檔案。
# 2) 在步驟 1 所建立的暫時目錄中,
# 建立 config、lib 和 schema 目錄。
# 3) 將 %GLA_HOME% 環境變數的值變更成
# 在步驟 1 中所建立之暫時目錄的絕對路徑。
# 4) 將欲執行的配接器檔案複製到 %GLA_HOME%/config 目錄中。
# 例如,如果您想要執行 Apache 配接器檔案,則要將
# org.eclipse.hyades.logging.adapter.config
# 外掛程式的 Apache 目錄和其所有內容,複製到 %GLA_HOME%/config 目錄中。
# 5) 將 org.eclipse.hyades.logging.adapter
# 外掛程式的綱目目錄內容複製到 %GLA_HOME%/schema 目錄中。
# 6) 將下列 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 

CONFIG_FILE="$GLA_HOME/config/my.adapter" 
export CONFIG_FILE

CUR_DIR=`pwd`
export CUR_DIR

cd "$GLA_HOME/config" 

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. 用滑鼠右鍵按一下代理程式,選取開啟工具 > 日誌視圖。這時會將應用程式日誌的日誌事件載入「日誌」視圖中。
    附註:如果您在「日誌」視圖中沒有看到任何日誌記錄,請按一下「側寫監視器」窗格頂端的重新整理視圖按鈕。

 

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

相關作業
建立日誌剖析器

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