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

ねこじゃすり

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

created by Rinker

PEPPY(ペピイ)

¥3,850 (2025/01/05 12:56:12時点 Amazon調べ-詳細)

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

Anker PowerCor

Anker PowerCore モバイルバッテリー 20000mAh iPhone iPad Android

created by Rinker

Anker

¥3,990 (2025/01/05 12:09:11時点 Amazon調べ-詳細)

旅行には必須の大容量モバイルバッテリー！

【最新機種】GoPro hero11 Black

【最新機種】GoPro HERO13 Black【完全防水】

created by Rinker

¥61,300 (2025/01/05 20:59:47時点楽天市場調べ-詳細)

最新機種でVlogの思い出を撮影しよう！

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

created by Rinker

ペヤング

¥3,280 (2025/01/05 12:33:38時点 Amazon調べ-詳細)

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

レッドブルエナジードリンク 250ml×24本

created by Rinker

Red Bull(レッドブル)

¥4,000 (2025/01/05 12:33:39時点 Amazon調べ-詳細)

翼を授けよう！

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

created by Rinker

スクウェア・エニックス(SQUARE ENIX)

¥3,940 (2025/01/05 12:41:47時点 Amazon調べ-詳細)

みんな大好き経験値の塊をデスクに常備しておこう！

サンディスク microSD 128GB

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

created by Rinker

SanDisk

¥3,279 (2025/01/05 12:33:41時点 Amazon調べ-詳細)

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

1 CloudWatchにログを転送しよう
2 手順
3 終わりに

CloudWatchにログを転送しよう

近年のサーバーシステムは、オンプレでサーバー構築をする事はほとんど無くなりました。

そして、クラウドシステムとしてはAWSかGCPの二択になると思います。

今回はcloudwatch-logback-appenderを利用して、AWSのCloudWatchにシステムログを転送する方法をご紹介します。

CloudWatchを利用する事で、ログ解析が格段に行いやすくなるのでオススメです♪

手順

前提

まずはAWSでCloudWatchへの権限があるIAMを用意しておいてください。

そのユーザーのアクセスキーとシークレットキーを利用します。

依存関係の追加

まずはgradleの依存関係を追加しましょう。

ext {
...    
    accountService.awsSdkVersion = '1.11.483'
    accountService.cloudWatchLogbackAppenderVersion = '1.11'
...
}

ext {

...

accountService.awsSdkVersion = '1.11.483'

accountService.cloudWatchLogbackAppenderVersion = '1.11'

...

}

buildscript {
....
        compile "com.amazonaws:aws-java-sdk:${accountService.awsSdkVersion}"
        compile "com.j256.cloudwatchlogbackappender:cloudwatchlogbackappender:${accountService.cloudWatchLogbackAppenderVersion}"
...
}

buildscript {

....

compile "com.amazonaws:aws-java-sdk:${accountService.awsSdkVersion}"

compile "com.j256.cloudwatchlogbackappender:cloudwatchlogbackappender:${accountService.cloudWatchLogbackAppenderVersion}"

...

}

logbackの設定を修正

次にlogback-spring.xmlにCloudWatch用の設定を追加します。

<?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>blogenist-logstream</logStream>
        <layout>
            <pattern>${FORMAT}</pattern>
        </layout>
        <maxBatchSize>32</maxBatchSize>
	</appender>

	<root level="DEBUG">
		<appender-ref ref="STDOUT" />
		<appender-ref ref="FILE" />
		<appender-ref ref="CLOUDWATCH" /><!-- 追加 -->
	</root>
	
</configuration>

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

...

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

<logGroup>blogenist-loggroup</logGroup>

<logStream>blogenist-logstream</logStream>

<pattern>${FORMAT}</pattern>

</layout>

</appender>

<appender-ref ref="STDOUT" />

<appender-ref ref="FILE" />

<appender-ref ref="CLOUDWATCH" />

</root>

</configuration>

確認

設定はこれだけです。

では実際に、サーバーを起動してリクエストを投げてみましょう。

# レスポンスヘッダー
< HTTP/1.1 200
< x-request-id: 0523847d-68dc-4db8-8de0-00f65592f43a
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Sat, 04 May 2019 04:23:23 GMT

# レスポンスヘッダー

< HTTP/1.1 200

< x-request-id: 0523847d-68dc-4db8-8de0-00f65592f43a

< Content-Type: application/json;charset=UTF-8

< Transfer-Encoding: chunked

< Date: Sat, 04 May 2019 04:23:23 GMT

正常にCloudWatchに転送されていますね。

また、以前埋め込んだX-Request-Idも正常に出力されているので、レスポンスヘッダーに含まれているx-request-idで絞り込む事で対象のログを絞り込めるのでとても調査がしやすいです！

終わりに

以上のように、ライブラリを追加してちょっとした設定を追加するだけでとても簡単にCloudWatchにログを転送する事が出来ました。

AWS環境でシステムを運用する場合は運用がとても便利になるので、是非試してみてください♪

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

ねこじゃすり

Anker PowerCor

【最新機種】GoPro hero11 Black

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

レッドブル エナジードリンク 250ml×24本

ドラゴンクエスト メタリックモンスターズギャラリー メタルキング

サンディスク microSD 128GB

CloudWatchにログを転送しよう

手順

前提

依存関係の追加

logbackの設定を修正

確認

終わりに

CATEGORIES & TAGS

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

レッドブルエナジードリンク 250ml×24本

ドラゴンクエストメタリックモンスターズギャラリーメタルキング