Java 日誌函式庫怎麼選:API、實作與橋接

比較七種 Java 日誌方案,追查執行時依賴,並看 Logback 與 Log4j 2 如何輸出同一筆 SLF4J 事件。

最佳實務
日誌事件與資料分析插圖

升級依賴之後,結帳錯誤還是會出現在 stdout,告警卻沒響。新的編碼器換了等級欄位的位置,另一個依賴又帶進第二個日誌 provider。這兩件事要分開查。先確認執行時由哪個實作輸出,再看它寫出的內容,以及收集器最後存下哪些欄位。

先區分日誌 API 和實際寫出記錄的元件

方案 在 Java 應用程式中的角色 執行時要確認什麼
SLF4J 日誌門面 SLF4J 2 會尋找相容的 provider。找不到時會警告,之後不輸出日誌。
Logback 由 Logback Classic 提供實作 Appender 決定輸出去向,內建 JsonEncoder 等編碼器決定格式。
Log4j 2 API 與 Core 實作分開 Core 提供 appender 與非同步 Logger;JSON Template Layout 是獨立模組。
java.util.logging(JUL) JDK 內建的 API 與實作 Handler 搭配格式化器即可輸出到主控台或檔案。
Apache Commons Logging(JCL) 常見於既有依賴的門面 仍有維護版本,須確認實際載入的實作或橋接元件。
tinylog 2 API 與實作 兩個套件都在類別路徑時,預設輸出到主控台,也能用 writer 寫入輪替檔案或 JSON 檔。
Flogger 可搭配不同後端的流暢式 API 獨立應用程式須另帶執行時後端。

發佈程式庫時,可以只依賴 SLF4J API,把 provider 留給應用程式選。Spring Boot 服務若已使用預設 starter,可先沿用 Logback。確實需要 JSON 模板或 Disruptor 非同步 Logger 時,再評估 Log4j Core。只想用 JDK 寫個小工具,JUL 就能直接輸出。需要不同 writer 時可以看 tinylog;如果想在呼叫處控制輸出頻率,Flogger 是另一種 API 選擇。SLF4J 手冊 · Spring Boot 日誌 · tinylog 設定 · Flogger

確認類別路徑上的橋接方向

先看 mvn dependency:tree -Dscope=runtime,再核對最後打包進應用程式的檔案。SLF4J 2 的 provider 和舊版 1.7 的繫結方式不同,同一個類別路徑應保留一個相容的 provider。若同一筆日誌出現兩次,也可能是 Logger 和上層 Logger 的 appender 都處理了同一事件。

log4j-slf4j2-impl 把 SLF4J 呼叫送到 Log4j 2,log4j-to-slf4j 則把 Log4j API 呼叫送回 SLF4J。兩個方向放在一起可能造成循環。JUL 也一樣,安裝 jul-to-slf4j 的橋接 Handler 後,別再透過 slf4j-jdk14 把事件送回 JUL。Spring Framework 5、6 有自己的 spring-jcl,會依類別路徑上可用的 API 選路,也可能回退到 JUL。加橋接元件前,先確認現有路由。Log4j 安裝說明 · SLF4J 橋接 · Spring Framework 6.2 日誌 · JCL 發佈記錄

還有 Log4j 1.x 時,可用 log4j-1.2-api 轉接部分舊 API 呼叫。舊設定和自訂 appender 要另外盤點,橋接後仍須核對行為。Apache 遷移文件

保留既有查詢用到的欄位

下面的程式輸出一筆帶有請求 ID 的合成錯誤,清理 MDC 後再輸出一筆。每次只用一個 SLF4J 2 provider 執行,並把對應的實作設定為 JSON 輸出。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public final class LoggingSample {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(LoggingSample.class);
        MDC.put("request_id", "fixture-42");
        try {
            logger.error("checkout failed",
                    new IllegalStateException("synthetic failure"));
        } finally {
            MDC.remove("request_id");
        }
        logger.info("fixture complete");
    }
}

用 Java 21 與 SLF4J 2.0.20 在本機驗證時,Logback 1.6.6 的 JsonEncoder 寫出 level 與 mdc.request_id。Log4j 2.26.1 的預設 JSON Template Layout 則直接以 log.level、request_id 作為欄位名稱。兩者的時間與例外格式也不同,第二筆都沒有請求 ID。這次驗證只涵蓋兩套設定的輸出格式和 MDC 清理。

服務的請求 ID 和實際追蹤的 trace ID 要分開。從檔案搬到容器 stdout,或換一種 JSON 版面配置時,要確認下游收到的時間、等級、訊息、例外堆疊與關聯欄位。用 DataKit 讀取檔案或容器輸出時,先把解析及欄位對應調整好,再驗證原本的查詢和告警。支援結構化日誌的 Spring Boot 版本可透過 logging.structured.format.console 選擇 JSON 格式;自訂 encoder 或 layout 時,仍需確認它支援該格式。DataKit 日誌收集(簡中) · Logback 編碼器(英文) · Log4j JSON Template Layout(英文)

加入佇列前先量輸出端

佇列可以緩衝短暫尖峰,輸出端長期跟不上時仍會塞滿。用實際 appender 和格式量測請求延遲與日誌輸出量,並確認滿載後會丟棄、阻塞或轉為同步。程序意外結束也可能遺失尚未處理的記錄。稽核日誌要另外驗證整條路徑的持久性與完整性,光靠同步 appender 無法證明兩者。Log4j 非同步 Logger(英文) · Logback AsyncAppender(英文)

Logback 設定(英文) · Log4j 2 設定(英文) · Java 日誌實務(英文)

取得專屬方案

聯絡我們

加入社群

微信扫码
加入官方交流群

立即體驗

在线开通,按量计费,真正的云服务!

立即開始

选择观测云版本

代码托管平台