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

【最新機種】GoPro hero11 Black

【日本国内正規品】 GoPro hero11 Black

created by Rinker

GoPro(ゴープロ)

¥62,000 (2024/04/03 21:42:08時点 Amazon調べ-詳細)

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

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

created by Rinker

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

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

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

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

created by Rinker

Red Bull(レッドブル)

¥4,000 (2024/04/03 21:42:12時点 Amazon調べ-詳細)

翼を授けよう！

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

created by Rinker

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

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

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

Bauhutte ( バウヒュッテ ) 昇降式 L字デスクブラック BHD-670H-BK

created by Rinker

Bauhutte(バウヒュッテ)

¥14,935 (2024/04/03 21:42:10時点 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一番人気のスマホスタンド！カード類も収納出来てかさ張らないのでオススメです！

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】

【最新機種】GoPro hero11 Black

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

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

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

Bauhutte ( バウヒュッテ ) 昇降式 L字デスク ブラック BHD-670H-BK

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

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

CloudWatchにログを転送しよう

手順

前提

依存関係の追加

logbackの設定を修正

確認

終わりに

CATEGORIES & TAGS

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

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

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

Bauhutte ( バウヒュッテ ) 昇降式 L字デスクブラック BHD-670H-BK

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

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