【SpingBoot2】LogbackのログをJson形式にする方法【CloudWatch】

ねこじゃすり

ワタオカねこじゃすりライトグレー

created by Rinker

PEPPY(ペピイ)

¥3,850 (2024/04/03 21:33:13時点 Amazon調べ-詳細)

猫を魅了する魔法の装備品！

[ノースフェイス] THE NORTH FACE メンズアウターマウンテンライトジャケット

created by Rinker

THE NORTH FACE(ザノースフェイス)

¥33,430 (2024/04/03 21:42:09時点 Amazon調べ-詳細)

防水暴風で耐久性抜群なので旅行で大活躍です！

ペヤングソースやきそば 120g×18個

created by Rinker

ペヤング

¥2,600 (2024/04/03 21:42:16時点 Amazon調べ-詳細)

とりあえず保存食として買っておけば間違いなし！

モンスターエナジー 355ml×24本 [エナジードリンク]

アサヒ飲料モンスターエナジー 355ml×24本 [エナジードリンク]

created by Rinker

モンスター

¥4,748 (2024/04/03 21:33:15時点 Amazon調べ-詳細)

脳を活性化させるにはこれ！

BANDAI SPIRITS ULTIMAGEAR 遊戯王千年パズル 1/1スケール

created by Rinker

BANDAI SPIRITS(バンダイスピリッツ)

¥7,500 (2024/04/03 21:42:14時点 Amazon調べ-詳細)

もう一人の僕を呼び覚ませ！！

MOFT X 【新型ミニマム版】 iPhone対応スマホスタンド

created by Rinker

MOFT

¥2,880 (2024/04/03 21:42:18時点 Amazon調べ-詳細)

Amazon一番人気のスマホスタンド！カード類も収納出来てかさ張らないのでオススメです！

サンディスク microSD 128GB

サンディスク microSD 128GB UHS-I Class10 Nintendo Switch SanDisk Ultra SDSQUA4-128G-EPK

created by Rinker

SanDisk

¥1,856 (2024/04/03 21:33:16時点 Amazon調べ-詳細)

スマホからSwitchまで使える大容量MicroSDカード！

1 Json形式で見やすくしよう
2 手順
3 終わりに

Json形式で見やすくしよう

Logbackをそのまま利用していると、基本的には一行のテキストで、Formatパターンに沿ったログが出力されると思います。

こんな感じ。

[INFO ] [2019-05-04 12:41:26.322] [o.a.catalina.core.StandardService] - Starting service [Tomcat]

しかし、一行の中に全ての情報が含まれていると、ログ解析時にちょっと見にくかったりとやや問題があります。

そこで、logback-json-classicというライブラリを使う事で、logbackの出力ログをJson形式にする事が可能になりますので、設定方法をご紹介します。

手順

依存関係の追加

build.gradleに以下の2つのライブラリの依存関係を追加します。

buildscript {
...
        implementation "ch.qos.logback.contrib:logback-json-classic:${accountService.logbackJsonVersion}"
        implementation "ch.qos.logback.contrib:logback-jackson:${accountService.logbackJsonVersion}"
...
}

buildscript {

...

implementation "ch.qos.logback.contrib:logback-json-classic:${accountService.logbackJsonVersion}"

implementation "ch.qos.logback.contrib:logback-jackson:${accountService.logbackJsonVersion}"

...

}

ext {
...
    accountService.logbackJsonVersion = '0.1.5'
...
}

ext {

...

accountService.logbackJsonVersion = '0.1.5'

...

}

logback-spring.xmlの修正

次に、logback-spring.xmlを修正していきましょう。

標準出力の場合

標準出力の場合は以下のように修正してください。

<?xml version="1.0" encoding="UTF-8"?>
...
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
			<layout class="ch.qos.logback.contrib.json.classic.JsonLayout">
				<jsonFormatter class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter">
					<prettyPrint>true</prettyPrint>
				</jsonFormatter>
				<timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</timestampFormat>
				<includeContextName>false</includeContextName>
				<appendLineSeparator>true</appendLineSeparator>
			</layout>
			<charset>UTF-8</charset>
		</encoder>
	</appender>
...
</configuration>

<?xml version="1.0" encoding="UTF-8"?>

...

</jsonFormatter>

<timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</timestampFormat>

<includeContextName>false</includeContextName>

</layout>

</encoder>

</appender>

...

</configuration>

確認

では、サーバーを起動してログを確認してみましょう。

{  
   "timestamp":"2019-05-04T19:47:51.347+09:00",
   "level":"WARN",
   "thread":"http-nio-8080-exec-1",
   "mdc":{  
      "x-request-id":"c3a80300-0953-4635-802f-72abceb67b35"
   },
   "logger":"org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver",
   "message":"Resolved [ResourceNotFoundException(errorType=RESOURCE_NOT_FOUND_COMMON)]"
}

{

"timestamp":"2019-05-04T19:47:51.347+09:00",

"level":"WARN",

"thread":"http-nio-8080-exec-1",

"mdc":{

"x-request-id":"c3a80300-0953-4635-802f-72abceb67b35"

"logger":"org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver",

"message":"Resolved [ResourceNotFoundException(errorType=RESOURCE_NOT_FOUND_COMMON)]"

}

正常にJson形式で出力されています。

見やすいですし、MDCに設定したx-request-idも出力されていますね♪

参考

【SpringBoot2】レスポンスヘッダーに独自の項目を追加する方法【X-Request-ID】

AWS CloudWatchLogsの場合

以前紹介したCloudWatchへの転送時にもJson形式にする事が出来ます。

参考

【運用改善への近道】LogbackでAWSのCloudWatchに転送する方法【com.j256.cloudwatchlogbackappender】

<?xml version="1.0" encoding="UTF-8"?>
...
	<appender name="CLOUDWATCH" class="com.j256.cloudwatchlogbackappender.CloudWatchAppender">
		<region>ap-northeast-1</region>
		<accessKeyId>XXX</accessKeyId>
		<secretKey>YYY</secretKey>
		<logGroup>blogenist-loggroup</logGroup>
		<logStream>${SPRING_PROFILE}.${RUN_TIME}</logStream>
		<layout class="ch.qos.logback.contrib.json.classic.JsonLayout">
			<jsonFormatter class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter">
				<prettyPrint>true</prettyPrint>
			</jsonFormatter>
			<timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</timestampFormat>
			<includeContextName>false</includeContextName>
			<appendLineSeparator>true</appendLineSeparator>
		</layout>
		<maxBatchSize>32</maxBatchSize>
	</appender>
...
</configuration>

<?xml version="1.0" encoding="UTF-8"?>

...

<region>ap-northeast-1</region>

<logGroup>blogenist-loggroup</logGroup>

<logStream>${SPRING_PROFILE}.${RUN_TIME}</logStream>

</jsonFormatter>

<timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</timestampFormat>

<includeContextName>false</includeContextName>

</layout>

</appender>

...

</configuration>

確認

こちらもサーバーを起動してリクエストを投げてみましょう。

こちらも正常にCloudWatchLogs上でJson形式でまとめて見やすくなりました♪

終わりに

以上のように、簡単にJson形式でログを出力出来るようになりました。

Json形式にする事でログ解析作業の効率化に繋がるので、皆さんも参考にしてみてはいかがでしょうか♪

【SpingBoot2】LogbackのログをJson形式にする方法【CloudWatch】

ねこじゃすり

[ノースフェイス] THE NORTH FACE メンズ アウター マウンテンライトジャケット

ペヤング ソースやきそば 120g×18個

モンスターエナジー 355ml×24本 [エナジードリンク]

BANDAI SPIRITS ULTIMAGEAR 遊戯王 千年パズル 1/1スケール

MOFT X 【新型 ミニマム版】 iPhone対応 スマホスタンド

サンディスク microSD 128GB

Json形式で見やすくしよう

手順

依存関係の追加

logback-spring.xmlの修正

標準出力の場合

確認

AWS CloudWatchLogsの場合

確認

終わりに

CATEGORIES & TAGS

[ノースフェイス] THE NORTH FACE メンズアウターマウンテンライトジャケット

ペヤングソースやきそば 120g×18個

BANDAI SPIRITS ULTIMAGEAR 遊戯王千年パズル 1/1スケール

MOFT X 【新型ミニマム版】 iPhone対応スマホスタンド