Tomcat日志機制

Tomcat日志機制簡介

Tomcat 的內部日志使用 JULI 組件，這是一個 Apache Commons 日志的重命名的打包分支，默認被硬編碼，使用 java.util.logging 架構。這能保證 Tomcat 內部日志與 Web 應用的日志保持獨立，即使 Web 應用使用的是 Apache Commons Logging。

假如想用另外的日志框架來替換 Tomcat 的內部日志系統，那么就必須采用一種能夠保持完整的 Commons 日志機制的 JULI 實現，用它來替換通過硬編碼使用 java.util.logging 的 JULI 實現。通常這種替代實現都是以額外組件的形式出現的。利用 Log4j 框架用于 Tomcat 內部日志的配置如下文所示。

在 Apache Tomcat 上運行的 Web 應用可以使用：

• 任何自選的日志框架。
• 系統日志 API，java.util.logging。
• Java Servlets 規范所提供的日志 API，javax.servlet.ServletContext.log(...)。

各個應用可以使用不同的日志框架，詳情參見類加載器。java.util.logging 則是例外。如果日志庫直接或間接地用到了這一 API，那么 Web 應用就能共享使用它的元素，因為該 API 是由系統類加載器所加載的。

Java 日志 API——java.util.logging

Apache Tomcat 本身已經實現了 java.util.logging API 的幾個關鍵元素。這種實現就是 JULI。其中的關鍵組件是一個自定義的 LogManager 實現，它能分辨運行在 Tomcat 上的不同 Web 應用（以及它們所用的不同的類加載器），還能針對每一應用進行私有的日志配置。另外，當 Web 應用沒能從內存中加載時，Tomcat 會給予它相應通知，從而清除相應的引用類，防止內存泄露。

在啟動 Java 時，通過提供特定的系統屬性，可以啟用 java.util.logging 實現。Apache Tomcat 啟動腳本可以實現這個操作，但如果使用不同工具來運行 Tomcat（比如 jsvc，或者從某個 IDE 中運行 Tomcat），就必須自己來啟用實現。

關于 java.util.logging 實現的詳細情況可以查閱 JDK 文檔，具體位于 java.util.logging 包的相關 javadoc 頁面中。

關于 Tomcat JULI 的詳細介紹見下文。

Servlets logging API

Tomcat 內部日志能夠處理對 javax.servlet.ServletContext.log(...) 的調用，從而寫入日志消息。這種消息都被記錄到一種特定類別中，命名方式如下：

org.apache.catalina.core.ContainerBase.[${engine}].[${host}].[${context}]

這種日志是依照 Tomcat 日志配置而執行的，無法在 Web 應用中重寫。

Servlets logging API 的問世要先于 Java 所提供的 java.util.logging API，所以，它無法提供太多的選項，比如無法用它來控制日志級別。然而需要注意的是，在 Tomcat 實現中， 對 ServletContext.log(String) 和 GenericServlet.log(String) 的調用都被記錄在 INFO 級別。對 ServletContext.log(String, Throwable) 或 GenericServlet.log(String, Throwable) 的調用都被記錄在 ERROR 級別。

Console

在 UNIX 系統下運行 Tomcat 時，控制臺輸出經常會重定向到 catalina.out 的文件中。通過一個環境變量，可以配置該文件（參見啟動腳本）。

寫入 System.err/out 的任何內容都會被 catalina.out 文件所捕獲。這些內容可能包括：

• 由 java.lang.ThreadGroup.uncaughtException(..) 所輸出的未捕獲異常。
• 線程轉儲，如果通過系統信號來請求它們。

在 Windows 上以服務形式運行時，控制臺輸出也會被捕獲及重定向，但文件名有所不同。

Tomcat 默認的日志配置會將同樣的消息寫入控制臺和一個日志文件中。這一特點非常有利于使用 Tomcat 進行開發，但往往并不適用于生產環境。

老的應用可能還在使用 System.out 或 System.err，可以通過在 Context 元素上設置 swallowOutput 屬性來調整。如該屬性設為 true，那么在請求階段對 System.out/err 的調用就會被攔截，它們的輸出也會通過 javax.servlet.ServletContext.log(...) 調用反饋給日志系統。

注意：swallowOutput 雖然是一個小技巧，但還是有局限性的：它需要直接調用 System.out/err，并且要在請求處理周期內完成。而且，它可能還并不適用于應用所創建的其他線程。不能將其用于攔截本身寫入系統流的日志框架（它們可能早先已經啟動，并且在重定向發生前就已經獲取了對流的直接引用）。

Acces 日志

Access 日志功能相近，但還是有所不同。它是一個 Valve，使用自包含的邏輯來編寫日志文件。訪問日志的基本需求是以較低開銷處理大型連續數據流，所以只能使用 Commomns Logging 來處理自身的調試消息。這種實現方法避免了額外的開銷，并且可能具有較復雜的配置。請參考 Valves 文檔了解更多配置詳情，其中包含了各種報告格式。