Java のログライブラリ選び:API、実装、ブリッジ
Java のログライブラリ 7 種を比較。実行時の依存関係を確認し、同じ SLF4J のログが Logback と Log4j 2 でどう変わるかを見ます。
依存関係を更新したあとも、決済エラーは標準出力に出ている。それなのにアラートが反応しない。調べると、新しいエンコーダーでログレベルの位置が変わり、別の依存関係から二つ目のログプロバイダーも入っていました。まず実行時にどの実装が出力しているかを確かめます。そのうえで、出力した項目とコレクターが保存した項目を見比べます。
ログを呼び出す API と出力する実装を分ける
| 選択肢 | Java アプリでの役割 | 実行時に確認する点 |
|---|---|---|
| SLF4J | ログ API のファサード | SLF4J 2 は対応プロバイダーを探します。見つからなければ警告を出し、ログ処理は何もしません。 |
| Logback | Logback Classic が実装を提供 | 出力先は appender、形式は組み込みの JsonEncoder などのエンコーダーで設定します。 |
| Log4j 2 | API と Log4j Core が別モジュール | Core が appender や非同期ロガーを提供します。JSON Template Layout は別モジュールです。 |
| java.util.logging(JUL) | JDK に含まれる API と実装 | 外部実装を追加せず、ハンドラーとフォーマッターでコンソールやファイルに出力できます。 |
| Apache Commons Logging(JCL) | 既存の依存ライブラリで見かけるファサード | メンテナンス版が出ています。実行時の実装やブリッジを確認します。 |
| tinylog 2 | API と実装 | 二つのアーティファクトでコンソール出力を始められます。ローテーションするファイルや JSON ファイルの writer もあります。 |
| Flogger | 複数のバックエンドに対応する Fluent API | 単体アプリで使う場合は、実行時バックエンドを別途組み込みます。 |
ライブラリを配布するなら、SLF4J API に依存し、実装の選択はアプリ側に委ねられます。Spring Boot の既定 starter で動いているサービスなら、まず Logback を使い続ける理由があります。JSON のテンプレートや Disruptor を使う非同期ロガーが必要なら Log4j Core を検討します。JDK だけで完結する小さなツールなら JUL、出力先に合わせて writer を選ぶなら tinylog も候補です。Flogger は呼び出し箇所で出力頻度を制御したい場合に検討できます。SLF4J マニュアル · Spring Boot のログ設定 · tinylog の設定 · Flogger
クラスパス上のブリッジの向きを確認する
mvn dependency:tree -Dscope=runtime を見たうえで、最終的な配布物に含まれるアーティファクトも確認します。SLF4J 2 のプロバイダーと、旧版の 1.7 バインディングは別物です。同じクラスパスには互換性のあるプロバイダーを一つだけ残します。同じログが二行出た場合は、ロガーと親ロガー両方の appender に伝播していないかも確認します。
log4j-slf4j2-impl は SLF4J の呼び出しを Log4j 2 に渡し、log4j-to-slf4j は Log4j API の呼び出しを SLF4J に渡します。両方向を同じ実行環境に入れると循環するおそれがあります。JUL でも同じです。jul-to-slf4j のハンドラーを登録したら、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 プロバイダーを一つだけ入れ、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 は別々に扱います。ファイルからコンテナの標準出力へ移すときや JSON のレイアウトを変更するときは、受信先で時刻、レベル、メッセージ、例外、関連付けの項目を確認します。DataKit がファイルやコンテナ出力を収集しているなら、解析と項目の対応をそろえてから既存の検索やアラートを試します。組み込みの構造化ログに対応する Spring Boot では logging.structured.format.console で形式を選べます。独自の encoder や layout を使う場合は、その形式に対応するよう設定します。DataKit のログ収集 · Logback のエンコーダー · Log4j JSON Template Layout
キューを追加する前に出力先を測る
キューは一時的な急増を吸収できますが、書き込み先が長時間追いつかなければ埋まります。実際の appender とレイアウトで、リクエスト遅延とログ出力の処理量を測ります。キューが満杯のときに破棄するのか、待つのか、同期処理に切り替えるのかも確認します。プロセスが異常終了すると、未処理のログが失われることがあります。監査ログは経路全体で永続性と完全性を確かめます。appender の同期設定だけでは判断できません。Log4j の非同期ロガー · Logback AsyncAppender
