IBM® Enterprise Records 應用程式包括可供您配置的範例 log4j.properties 檔。
log4j.properties 檔位於 ier_install_path\RecordsManagerSweep 資料夾中,您可以在檔案中指定下列項目的值,以配置記載行為:
log4j.properties 檔中的每一個日誌程式都指派了一個層次。如果您沒有對日誌程式指派層次,log4j 會自動指派母項日誌程式層次給未指派的日誌程式。依預設,會將 WARN 層次指派給日誌程式。
您可以使用日誌程式、附加程式及佈置的不同設定來配置 log4j.properties 檔。 在執行時期,類別路徑中的 log4j.properties 檔必須可供應用程式使用。您可以在陳述式前加上井字號 (#),以註銷範例檔中的項目;在執行時期將不會執行標示井字號 (#) 的項目。
如果要開啟 log4j.properties 檔,請導覽至 ier_install_path\RecordsManagerSweep 資料夾,然後使用文字編輯器開啟檔案。
您必須先設定日誌程式。您可以利用一些日誌程式將應用程式所需要的記載類型加以分類。如果要對 com.filenet.rm 的所有類別及其子套件啟用記載功能,請依照下列陳述式所示來指定日誌程式:
log4j.logger.com.filenet.rmor
您可以為日誌程式指定任何名稱。例如,您可以依照下列陳述式所示,將日誌程式命名為 APILOG:
log4j.logger.com.filenet.rm=warn, APILOG
您必須設定記載層次,以建立 log4j 在執行時期所記錄之訊息的詳細層次。log4j 支援五個一般記載層次,如下表所示。
層次 | 說明 |
---|---|
DEBUG | 指定對於除錯應用程式最有用的精細參考事件。 |
INFO | 指定以粗略層次強調顯示應用程式進度的參考訊息。 |
WARN | 指定可能有害的狀況。 |
ERROR | 指定可能仍然允許應用程式繼續執行的錯誤事件。 |
FATAL | 指定可能導致應用程式中斷的重大錯誤事件。 |
如需特殊和自訂記載層次的相關資訊,請參閱 Apache 網站上的 log4j 說明文件。依預設,應用程式會在 WARN 層次啟動。 在執行時期可修改為 DEBUG、INFO、ERROR、WARN 或 FATAL 層次。您也可以併入數個日誌程式陳述式,分別代表不同層次的相同日誌程式(例如 DEBUG 代表一個,WARN 代表另一個)。您可以在陳述式前加上井字號 (#),以註銷範例檔中的其中一個項目,也可視需要在 DEBUG 和 WARN 層次之間切換。在執行時期將不會執行標示井字號 (#) 的項目。 沒有層次的日誌程式會自動繼承其母項日誌程式的層次。依預設,會將 WARN 層次指派給 IBM Enterprise Records 中的 RM API 日誌程式。
為了讓日誌訊息能夠寫入輸出媒體,日誌程式會與一或多個附加程式相關聯。您可以在 log4j.properties 檔中設定用於將日誌資訊傳送到指定輸出位置的各種附加程式。 下表提供 log4j.properties 檔中使用的所有附加程式清單,及其簡要說明和相關選項。
附加程式 | 說明和程式碼片段 |
---|---|
NTEventLogAppender | 附加至 Microsoft Windows NT 事件日誌。這個附加程式只能在 Windows 系統上安裝及使用。 log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender |
ConsoleAppender | 利用使用者指定的佈置,將日誌訊息附加至 System.out(預設值)或 System.err 串流。 log4j.appender.APILOG=org.apache.log4j.ConsoleAppender 選項:
|
FileAppender | 會將日誌訊息附加至檔案。 log4j.appender.APILOG=org.apache.log4j.FileAppender 選項:
|
RollingFileAppender | 延伸 FileAppender,以在日誌檔到達特定大小時加以備份。 log4j.appender.APILOG=org.apache.log4j.RollingFileAppender 選項:
|
您可以在指定日誌訊息格式的 log4j.properties 檔中設定不同的佈置。 您可以指定日誌訊息要包括日期、時間、模組名稱、執行緒名稱等。在執行時期記載訊息時會使用這些配置設定。
下表提供 IBM Enterprise Records log4j.properties 檔中使用的所有佈置清單,及其簡要說明和選項。
佈置 | 說明和程式碼片段 |
---|---|
SimpleLayout | 會列印「層次」,然後是橫線 (-),後面接著日誌訊息文字。 org.apache.log4j.SimpleLayout |
PatternLayout | 會根據指定的轉換型樣來格式化記載事件。轉換型樣由字面文字和轉換指定元所組成。 字面文字會依現狀輸出。轉換指定元由 % 字元後接選用格式修飾元和必要轉換字元所組成。 例如,%-5p [%t]:%m%n 是一個轉換型樣,由優先順序(也稱為層次)轉換指定元,後面接著字面文字 " [",再接著執行緒轉換指定元,再接著字面文字 "]: ",最後接著訊息轉換指定元和系統相依行分隔字元所組成。 org.apache.log4j.PatternLayout 選項:
|
HTMLLayout | 會將輸出格式化成 HTML 表格。 org.apache.log4j.HTMLLayout 選項:
|
將輸出格式化成 XML。 org.apache.log4j.xml.XMLLayout 選項:
|
IBM Enterprise Records 所提供的 log4j.properties 檔,會將 PatternLayout 用於日誌訊息格式。 下表提供可在配置檔中宣告的轉換型樣清單及其簡要說明:
型樣 | 說明 |
---|---|
%t | 提出日誌要求的執行緒名稱 |
%c | 與日誌要求相關聯的日誌程式名稱 |
%-60c | 在 60 個空格內,向左對齊日誌程式名稱 |
%r | 自啟動應用程式後所經歷的毫秒數 |
%p | 日誌陳述式的層次 |
%m | 訊息 |
%Time | 發生記載的時間 |
%d | 記載事件的日期 |
%n | 換行 |
下列程式碼陳述式顯示如何啟用 PatternLayout 及指定簡單轉換型樣:
log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n
例如:
WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 102042, [setLoggerMessage] WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 102342, [setLoggerMessage]