Spring Bootのログ設定を完全ガイド！初心者でもわかるloggingプロパティとLogbackの基本

ログ設定の要点：logging.* と Logback（XML不要で始める）

先生と生徒の会話形式で理解しよう

生徒

「Spring Bootのログ出力って、何も設定しなくても表示されるんですが、あれってどこで制御されてるんですか？」

先生

「Spring Bootでは、デフォルトでLogbackというロガーが組み込まれていて、loggingというプロパティを使って設定できるようになっていますよ。」

生徒

「XMLファイルとか用意しなくてもいいんですか？初心者だとXMLはちょっと難しくて…」

先生

「もちろんです！まずはapplication.propertiesだけで始められる基本設定から覚えていきましょう。」

1. Spring Bootのログ出力の仕組み

Spring Bootのログは、デフォルトでLogbackというロギングフレームワークを使用しています。System.out.println()の代わりにLoggerを使ってログを出力することで、ログレベルの制御やログファイルへの出力が簡単に行えます。

Spring Bootでは、特別な設定をしなくても、ログ出力が標準で有効になっており、ログレベルや出力先をプロパティファイルでカスタマイズできます。

2. ログレベルの基本と設定方法

ログには以下のようなレベルがあり、重要度が高い順に制御できます：

ERROR：致命的なエラー
WARN：警告
INFO：通常の情報（デフォルト）
DEBUG：詳細なデバッグ情報
TRACE：最も詳細なログ

たとえば、すべてのログレベルをDEBUGに設定したい場合は、以下のようにします。


logging.level.root=DEBUG

特定のパッケージだけに設定することもできます。


logging.level.com.example=TRACE

こうすることで、不要なログを減らし、必要な情報だけを見やすく整理できます。

3. ログの出力先を指定する

ログはデフォルトでコンソールに出力されますが、ログファイルにも保存できます。application.propertiesで簡単に設定可能です。


logging.file.name=app.log
logging.file.path=logs

上記の設定では、logs/app.logというファイルにログが出力されます。ファイル名だけ指定した場合は、プロジェクトのルートに作成されます。

4. ログのフォーマットをカスタマイズする

ログの形式（ログフォーマット）もカスタマイズ可能です。たとえば、ログにタイムスタンプやスレッド名を含めたい場合、以下のようにします。


logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n

この例では、日付・スレッド・ログレベル・クラス名・メッセージが出力されるようになります。

5. XMLファイルなしでLogbackを使う方法

通常Logbackの設定はlogback.xmlに記述しますが、Spring BootではXMLを使わなくても設定できます。

プロパティファイルだけで始めたい場合、logging.levelやlogging.patternなどを使えば十分な機能をカバーできます。

ただし、ログのローテーションやアペンダの追加など、より高度な制御が必要な場合はlogback-spring.xmlを使用すると良いでしょう。

6. 標準のログ出力例とLoggerの使い方

Javaコードの中では、LoggerFactoryを使ってロガーを生成し、ログ出力を行います。


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class SampleLogger {

    private static final Logger logger = LoggerFactory.getLogger(SampleLogger.class);

    public void execute() {
        logger.info("INFOログです");
        logger.debug("DEBUGログです");
        logger.warn("WARNログです");
        logger.error("ERRORログです");
    }
}

logger.debug()やlogger.info()などを使い分けることで、ログの詳細度を適切に制御できます。

7. Spring Bootのプロファイルごとにログ設定を変える

開発環境と本番環境では、ログの出力レベルを変えることが一般的です。Spring Bootではプロファイルを使って設定ファイルを切り替えることで、環境別のログ設定が可能です。

たとえば、開発用にはapplication-dev.propertiesを作成して次のように設定します。


logging.level.root=DEBUG

本番用にはapplication-prod.propertiesを作成して、必要最低限のログだけに制限します。


logging.level.root=ERROR

起動時には以下のように指定します。


--spring.profiles.active=dev

プロファイルごとの設定を活用することで、安全で効率的なログ運用ができます。

8. よくあるログのトラブルと対策

ログが出力されない場合や、思ったより大量に出力される場合は、以下をチェックしてみましょう。

ログレベル：想定より低いレベルになっていないか？
パッケージ指定：正しいパッケージ名でレベル設定されているか？
ログ出力先：ファイルに出力される設定になっていないか？

ログはシステムの状態を知るための重要な手がかりです。適切な設定で、トラブルを素早く発見しましょう。

まとめ

Spring Bootログ設定の重要ポイント総整理

本記事ではSpring Bootにおけるログ設定の基本から応用までを幅広く解説してきました。JavaのWebアプリケーション開発においてログは単なる出力ではなくシステムの状態を把握し問題を早期に発見するための重要な情報源です。特にSpring BootではデフォルトでLogbackが組み込まれているため特別な設定をしなくてもすぐにログ出力が利用できる点が初心者にとって大きなメリットとなります。

loggingプロパティを活用することでログレベルの制御ログ出力先の指定ログフォーマットのカスタマイズなどを簡単に行うことができます。application.propertiesやapplication.ymlに設定を記述するだけで柔軟なログ管理が可能になるため複雑な設定ファイルを用意しなくても十分な機能を実現できます。

またログレベルの理解も非常に重要です。ERRORやWARNは重要な問題を示しINFOは通常の動作DEBUGやTRACEは詳細な調査に役立ちます。これらを適切に使い分けることで不要なログを減らし必要な情報だけを効率よく確認することができます。

実務で役立つログ設計の考え方

実務においてログ設定を行う際には環境ごとに設定を切り替えることが重要です。開発環境ではDEBUGレベルを有効にして詳細な情報を確認し本番環境ではERRORやWARNに絞ることでパフォーマンスと可読性を確保します。Spring Bootのプロファイル機能を活用することでこれらの設定を簡単に切り替えることができます。

さらにログの出力先をファイルに設定することで過去のログを蓄積しトラブル発生時の調査に活用することができます。ログファイルは運用の中で重要な役割を果たし障害対応や監査の場面でも必要不可欠な情報となります。

ログフォーマットのカスタマイズも実務では重要なポイントです。日時スレッド名ログレベルクラス名メッセージを適切に組み合わせることでログの可読性が大きく向上します。見やすいログは開発効率の向上にも直結します。

サンプルコードで振り返るログ出力

ここでSpring Bootにおける基本的なログ出力のコードを改めて確認してみましょう。Loggerを使った標準的なログ出力の例です。


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

public class LogSummaryExample {

    private static final Logger logger = LoggerFactory.getLogger(LogSummaryExample.class);

    public static void main(String[] args) {

        logger.info("アプリケーション開始");
        logger.debug("デバッグ情報の出力");
        logger.warn("警告メッセージ");
        logger.error("エラーメッセージ");

        logger.info("アプリケーション終了");
    }
}

実行結果イメージ


INFO アプリケーション開始
WARN 警告メッセージ
ERROR エラーメッセージ
INFO アプリケーション終了

このようにログレベルによって出力される内容が変わるため必要な情報だけを適切に表示することができます。開発中はDEBUGも表示し本番ではINFO以上に制限するなど環境に応じた設定が重要です。

応用的な活用と注意点

Spring Bootのログ設定は単純な出力にとどまらずシステム全体の監視や分析にも活用されます。例えばアクセスログの分析パフォーマンスの測定エラー発生時の原因特定など多くの用途があります。そのためログの内容はできるだけ具体的かつ分かりやすく記述することが重要です。

一方でログを出しすぎるとファイルサイズが肥大化しパフォーマンスに影響を与える可能性があります。必要な情報を見極めて適切なログレベルで出力することが求められます。また個人情報や機密情報をログに出力しないように注意することも重要です。

JavaとSpring Bootを使った開発ではログ設定の理解は必須スキルです。今回学んだloggingプロパティやLogbackの基本をしっかり押さえることでより安定したシステム開発が可能になります。初心者の方はまず基本設定から始めて徐々に高度なカスタマイズへとステップアップしていきましょう。

先生と生徒の振り返り会話

生徒

Spring Bootのログ設定がここまで簡単にできるとは思いませんでした。loggingプロパティだけでも十分便利ですね。

先生

そうですね。最初はプロパティ設定だけで十分ですが必要に応じてLogbackの詳細設定にも進むと良いでしょう。

生徒

ログレベルの使い分けが重要というのがよく分かりました。

先生

はい。適切なログレベルを設定することで必要な情報だけを効率よく確認できます。

生徒

本番環境と開発環境で設定を変えるというのも実務的ですね。

先生

その通りです。プロファイル機能を活用すれば安全で効率的なログ運用が可能になります。

生徒

ログはただの出力ではなく重要な情報源ということが理解できました。

先生

良い理解です。今回学んだ内容を活かして見やすく役立つログを設計していきましょう。

生成AIを基礎から学びたい方へ

ChatGPTなどの生成AIをこれから学びたい方に向けて、AIスキルアカデミーの口コミ・評判、料金、無料セミナーの内容を詳しくまとめています。

AIスキルアカデミーの口コミ・評判を詳しく見る

スタースクール：社会人向け実務教育プロジェクト

【職業訓練講師が直接指導】

社会人向けSpring Boot実務セミナー｜職業訓練講師が教えるWebシステム構築の極意

Java入門からSpring Boot実務まで。現場で絶賛される「設計の型」を最短距離で習得。

技術記事の内容を、自分の「スキル」へ変える。

職業訓練講師が最短攻略！社会人向けSpring Bootによる「商用Webシステム構築」の実践。

モダンJava開発の事実上の標準Spring Boot。本セミナーでは、その圧倒的利便性の核にある「DI（依存性の注入）」を完全解剖。「設定より規約」を体現した効率的なアーキテクチャ設計を学び、ThymeleafやSpring Data JPAを組み合わせた、現場で必須となるWebシステムの作り方を60分で濃縮体験します。