配置記載

記載可用來監視及除錯 CM Server 和 CM API 型應用程式。

記載功能會追蹤一般 CM Server 和 CM API 使用者作業, 以及 CM Server 或 CM API 型的應用程式執行時所發生的任何錯誤。日誌項目會以機器的預設語言環境產生; 如果機器的語言環境不受支援,則以美國英文產生。

依預設,CM Server 的記載功能會設為 INFO 層次。您應該將 CM API 型的應用程式記載功能啟用為 INFO 層次。

您可以配置 CM API、WebSphere® Application Server 和 TSlogger 記載資料包。

CM API 記載

CM API 記載是利用 logging.properties 檔來控制, 該檔案位於要用來執行應用程式之 JRE 的 JDK 目錄結構中。請在 JDK 的 jre\lib 目錄下尋找 logging.properties 檔(例如:C:\Program Files\IBM\WebSphere\AST\eclipse\jre\libC:\jdk_5.0\jre\libC:\Program Files\Java\jre1.5.0_06\lib)

預設值是停用記載;您應該將它啟用為 INFO 層次。

以下範例 logging.properties 檔包含的項目會顯示如何配置 CM API 型應用程式的記載與追蹤設定:
############################################################
#      廣域內容
############################################################
#
# "handlers" 會指定日誌 Handler 類別的清單
# (以逗點區隔)。這些處理程式會在 VM 啟動期間安裝。
# 請注意,這些類別必須位於系統類別路徑。
# 依預設,我們只會配置 ConsoleHandler,其只會
# 顯示 INFO 以上層次的訊息。
handlers = java.util.logging.ConsoleHandler

# 如果也要新增 FileHandler,請改用下面這一行。
#handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler

# 預設廣域記載層次。
# 這會指定所有日誌程式要記載哪些類型
# 的事件。針對任何給定的機能,這個廣域層次
# 可以被機能專屬的層次置換
# 請注意,ConsoleHandler 也有另一個層次
# 設定,來限制列印至主控台的訊息。
# 下一行會使記載(針對所有日誌程式物件)發生於 INFO 層次
.level=INFO

############################################################
# Handler 專屬內容。
# 說明 Handler 的專屬配置資訊。
############################################################

# CMLogger - 應該一律啟用於 INFO 層次。
#
# 使用 CM API 的應用程式不需要停止再重新啟動;已配置之

# logging.properties 檔的變更會在 10 秒內自動通知並採用。
#
# 下面這幾行會指派 CMLogger 物件的記載功能發生於 INFO 層次,
# 且日誌輸出檔的名稱會是 CMLogger[#].log,並位於已登入之
# 使用者的起始目錄下;日誌輸出檔會在 40 個檔案當中進行輪換,每一個檔案
# 限制在 40000000 個位元組。日誌項目會附加到輪換的現行
# 日誌輸出檔中,且會使用簡單的格式寫入。
#
com.ibm.rational.stp.common.internal.util.CMLogger.level = INFO
com.ibm.rational.stp.common.internal.util.LogHandler.pattern = %h/CMLogger%g.log
com.ibm.rational.stp.common.internal.util.LogHandler.limit = 40000000
com.ibm.rational.stp.common.internal.util.LogHandler.count = 40
com.ibm.rational.stp.common.internal.util.LogHandler.append = true
com.ibm.rational.stp.common.internal.util.LogHandler.formatter = java.util.logging.SimpleFormatter

# CMTracer - 僅啟用(解除註解)以下項目供暫時使用,因為追蹤
# 需要大量資源。
#
# 使用 CM API 的應用程式不需要停止再重新啟動;已配置之
# logging.properties 檔的變更會在 10 秒內自動通知並採用。
#
# 下面這幾行會指派 CMTracer 物件的追蹤功能發生於 FINER 層次,
# 且追蹤輸出檔的名稱會是 CMTracer[#].log,並位於已登入之
# 使用者的起始目錄下;追蹤輸出檔會輪換 40 個檔案,每一個檔案
# 限制在 40000000 個位元組。追蹤項目會附加到輪換的現行
# 追蹤輸出檔中,且會使用簡單的格式寫入。
#
#com.ibm.rational.stp.common.internal.util.CMTracer.level = FINER
#com.ibm.rational.stp.common.internal.util.TraceHandler.pattern = %h/CMTracer%g.log
#com.ibm.rational.stp.common.internal.util.TraceHandler.limit = 40000000
#com.ibm.rational.stp.common.internal.util.TraceHandler.count = 40
#com.ibm.rational.stp.common.internal.util.TraceHandler.append = true
#com.ibm.rational.stp.common.internal.util.TraceHandler.formatter = java.util.logging.SimpleFormatter

這些設定會產生名稱為 CMLogger[#].log 的日誌檔(如果 CMTracer 項目已解除註解的話,還會產生名稱為 CMTracer[#].log 的追蹤輸出檔)。每一個檔案都位於已登入使用者的起始目錄中(其中 [#] 指出檔案的輪換號碼), 當每一個檔案已滿時,輸出即會在檔案之間輪換。

使用上述 logging.properties 項目表示記載記錄應該附加到適用檔案的尾端,且每一個項目都是以簡單的格式儲存。CM API 型的應用程式會在大約 10 秒內自動通知並採用 logging.properties 檔的變更; 應用程式不需要停止再重新啟動。

當日誌輸出檔已滿(為 40 MB)時, 即會建立新的檔案並重新命名之前的檔案,來包含發生檔案輪換時的日期和時間戳記。 每一個檔案都保留 40 MB 的資料,新的項目會附加到現有的項目之後(包括應用程式重新啟動期間)。當日誌檔的數目到達 40 時, 會輪換到新的檔案並自動刪除最舊的檔案。

如需如何配置 Java 記載功能的相關資訊, 請參閱 JDK java.util.logging.Logger 和 java.util.logging.FileHandler Javadoc。

如果您要建立自訂的記載內容檔,則必須指定 -D 引數,來指定要在何處尋找 JVM 的這個檔案。例如:
java -Djava.util.logging.config.file=C:\myLogPropsFile.properties your_client_java_program_that_uses_CM-API

配置 WebSphere Application Server 記載與追蹤

您可以利用 WebSphere Application Server「管理主控台」來設定及配置 WebSphere Application Server 記載與追蹤。您可以使用這個 URL 來存取 WebSphere Application Server「管理主控台」:
http://<server-name>:<admin-console-port-number>/ibm/console
其中 <server-name> 是 CM Server 系統的名稱,而 <admin-console-port> 是「管理主控台」埠號(CM Server 的預設值是 12060,其他 WebSphere Application Server 版本則是 9060)。
註: 對於 WebSphere Application Server 中執行的任何元件(包括 CM Server 元件在內)進行任何層次的追蹤(FINE、FINER 或 FINEST),對效能會有負面影響。

根據用於 CM Server 系統的 Websphere Application Server 類型,您可以即時變更而不需停止再重新啟動 CM Server。大部分的「管理主控台」記載設定頁面都有兩個標籤:配置標籤和執行時期標籤。

從「管理主控台」中,按一下疑難排解 -> 記載與追蹤,然後從伺服器的清單中選取要配置的伺服器。 選取變更日誌明細層次,然後按一下執行時期標籤。執行時期標籤的變更會在儲存變更時立即生效; 而配置標籤的變更必須等到重新啟動伺服器才會生效。如果您要持續保存變更,請勾選同時儲存配置的執行時期變更勾選框。選取元件鏈結。請注意 *=info 會列在方框中。請開啟 com.ibm.rational.* 選項 並選取 com.ibm.rational.stp.*。按一下訊息與追蹤層次選項來選取層次。按一下確定,然後在開啟的頁面頂端的訊息區域中按一下儲存鏈結。您不需重新啟動伺服器,變更即會生效。

如果 CM Server 系統上的 WebSphere Application Server 版本或類別未提供「執行時期」標籤來啟用即時配置變更, 請使用「配置」標籤,然後重新啟動伺服器來使儲存的變更生效。

日誌檔大小和要輪換的日誌檔數目的現成預設值可能需要增加。您應該將要輪換的日誌檔數目至少設為 40, 並將日誌檔大小至少設為 40 MB。如果要在 Websphere Application Server「管理主控台」中變更「JVM 日誌」的檔案大小和檔案輪換設定,請遵循下列步驟:
  1. 選擇疑難排解 -> 記載與追蹤
  2. 從要配置的伺服器清單中選取相關的伺服器。
  3. 選取 JVM 日誌,然後按一下配置標籤(執行時期標籤可用於檢視現行的 SystemOut.log 和 SystemErr.log 檔案內容)。
  4. 變更 SystemOut 和 SystemErr 位置、檔案大小(最少應為 40 MB), 以及要維持的歷程檔案數量(最少應為 40 MB)。
  5. 按一下確定,然後在開啟的頁面頂端的訊息區域中按一下儲存鏈結。
WebSphere Application 日誌檔的位置如下:
  • UNIX®:/opt/IBM/RationalSDLC/common/CM/profiles/cmprofile/logs/server1/
  • Linux®:/opt/ibm/RationalSDLC/common/CM/profiles/cmprofile/logs/server1/
  • Windows®:\Program Files\IBM\RationalSDLC\common\CM\profiles\cmprofile\logs\server1\

TSlogger

TSLogger 適用於記載後端 ONCRPC 伺服器處理程序。 您可藉由編輯以下的 tslogger.properties 檔來配置此公用程式:
  • Windows:\Program Files\IBM\RationalSDLC\common\CM\bin\tslogger.properties
  • UNIX:/opt/IBM/RationalSDLC/common/CM/bin/tslogger.properties
  • Linux:/opt/ibm/RationalSDLC/common/CM/bin/tslogger.properties
日誌和追蹤檔案位於下列位置:
  • Windows:\Program Files\IBM\RationalSDLC\common\CM\logs\server1\ccrpc [and \cqrpc]
  • UNIX:/opt/IBM/RationalSDLC/common/CM/logs/server1/ccrpc [and /cqrpc]
  • Linux:/opt/ibm/RationalSDLC/common/CM/logs/server1/ccrpc [and /cqrpc]
日誌和追蹤檔包括:
  • SystemOut.log - 一般日誌輸出,預設值為啟用於 INFO 層次記載。
  • SystemErr.log - 錯誤/異常狀況輸出,預設值為啟用。
  • trace.log - 追蹤輸出,預設值為停用。

tslogger.properties 檔會標示可變更的區域, 以及可接受的值範圍為何。預設值為在 INFO 層次啟用記載。所有的 INFO、WARNING 和 SEVERE 訊息都會記錄在日誌檔中。您可以編輯 tslogger.properties 檔來配置日誌檔,不過,該檔案會在安裝時適當地配置,因此不需要變更。

tslogger.properties 檔中的預設值會設為應該不需要任何修改的值。當輸出檔填滿時,輸出即會輪換至下一個檔案。一旦到達輪換的檔案數上限,即會移除最舊的檔案, 以挪出空間供下一個輪換的檔案使用。

從最高到最低層次的記載層次摘要:
  • OFF:停用所有的記載與追蹤。
  • ERROR:對應於 JSR47 中的 SEVERE。
  • WARNING:對應於 JSR47 中的 WARNING。
  • INFO:對應於 JSR47 中的 INFO。
  • DEBUG_MIN:對應於 JSR47 中的 FINE。
  • DEBUG_MID;對應於 JSR47 中的 FINER。
  • DEBUG_MAX:對應於 JSR47 中的 FINEST。
  • ALL:啟用所有記載與追蹤層次。
相關概念
ClearQuest 日誌檔及日誌內容檔

意見