API GatewayのアクセスログをCloudWatchに記録する

Tweet

Amazon API GatewayのアクセスログをCloudWatchに記録できるようになっていたので設定しました。

まず、AWSアカウントのAmazon API Gateway全体にCloudWatchログへの書き込みを有効にする必要があるので、
CloudWatch Logに書き込み権限を持つIAMロールを作成して、
Amazon API Gatewayに設定します。
そして、設定対象のAPI Gatewayでロググループを設定して有効にします。

AWS IAMロールの作成

IAMロールを作成して、サービスで「API Gateway」を選択して、ユースケースでは、「Allows API Gateway to push logs to
CloudWatch Logs.」を選択します。
そのままです。

すでにAmazonAPIGatewayPushToCloudWatchLogs というAWS管理ポリシーがアタッチされています。
ポリシーを見てみます。

CloudWatch Logsに対しての書き込み権限が許可されています。

ロール名を設定してIAMロールを作成します。

作成SいたIAMロールのarnを控えておきます。

アカウントのAmazon API Gateway全体にCloudWatchログへの書き込みの有効設定

API Gatewayの[設定]で、「CloudWatchログのロールARN」にIAMロールのarnを設定します。

arnは
arn:aws:iam::account_id:role/role_name
です。

※account_id と role_nameは書き換えてください。

対象のAPI Gatewayでアクセスログを有効にする

対象のAPI Gatewayのステージを選択して[ログ]タブで「アクセスログの有効化」にチェックを入れます。

CloudWatchグループには、CloudWatchのロググループをarnで指定します。
新規に作成する場合は指定したロググループ名で自動作成されます。

arnは
arn:aws:logs:region:account_id:log-group:group_name
です。

※region と account_id と group_nameは書き換えてください。

ログの形式は変数を書いて指定しますが、「入力の例」でフォーマットのボタンを押せば自動入力してくれます。
今回は[JSON]にしました。

アクセスしてみる

POSTMANでAPIにアクセスしてみます。

ログが記録されています。

失敗したこと

CloudWatchグループのarnを最初、
arn:aws:logs:region:account_id:group_name
で設定しようとしたところ、

「Access log destination must only contain characters a-z, A-Z, 0-9, ‘_’, ‘-‘, ‘/’, ‘.’: ‘group_name’」

のメッセージが出て保存出来ませんでした。

そのあと、
arn:aws:logs:region:account_id:log-group:group_name
に直して、保存したのですが、上のメッセージを消さないままで[保存]ボタンを押してたので、
保存出来ているのに、保存出来ていないように思ってしまいました。

メッセージは確認した後、次のアクションまでに消しておかなければ。
ややこしや。

@yamamanx

開発ベンダー5年、ユーザ企業システム部門通算9年、ITトレーナー2年目のSoftware Engineerです。
質問はコメントかSNSなどからお気軽にどうぞ。
出来る限りなるべく答えます。

このブログの内容/発言の一切は個人の見解であり、所属する組織とは関係ありません。

また、勉強会やイベントのレポートは自分が気になったことをメモしたり、聞いて思ったことを書いていますので、登壇者の意見や発表内容ではありません。