Amazon EC2 Auto Scallingのスケールイン時にインスタンスメタデータを利用してEC2インスタンス内のログを退避させる

とばち

2022.03.28

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

コンサル部のとばち（@toda_kk）です。

先日、EC2 Auto Scalingのライフサイクル状態をインスタンスメタデータから取得から取得できるようになるアップデートがありました。

ライフサイクルの遷移をトリガーにして特定の処理を実行したい場合、従来はライフサイクルフックとEventBridgeを組み合わせるなどの方法を取る必要がありました。

例えば下記ページのように、Auto Scalingグループで管理するEC2インスタンスがスケールインによって終了する際に、ローカルのログをS3バケットに転送するといった処理を実現できます。

そこで、今回はインスタンスメタデータを利用して上記の内容と同等の処理を実現させてみたいと思います。

仕組みとしては、AWS公式で用意されているチュートリアルのドキュメントと同じように、インスタンスメタデータサービス（IMDS）をポーリングするユーザーデータを設定し、ライフサイクルの状態が Terminated になった際にローカルのログをS3バケットに転送するようなスクリプトを実行します。

必要な手順

ユーザーデータを設定した起動テンプレートを作成する
作成した起動テンプレートを使用したAuto Scalingグループを作成する
Auto Scalingグループにライフサイクルを追加する

なお、ログの転送先となるS3バケットや、EC2に必要な権限（S3へのPutObjectや、ライフサイクルアクション完了のコールバック送信）を付与したIAMロールおよびインスタンスプロファイルについては、既に作成済みの前提とします。

ユーザーデータを設定した起動テンプレートを作成する

まず、Auto Scalingグループで指定する起動テンプレートを作成します。起動テンプレートには、下記のようにスクリプトを実行するユーザーデータを設定します。

下記の変数については、適宜変更してください。

S3バケット名: bucket
ライフサイクルフック名: lifecycle_hook_name
Auto Scalingグループ名: group_name
転送したいログのパス: log_path

ユーザーデータ

#!/bin/bash

function get_target_state {
    echo $(curl -s http://169.254.169.254/latest/meta-data/autoscaling/target-lifecycle-state)
}

function get_instance_id {
    echo $(curl -s http://169.254.169.254/latest/meta-data/instance-id)
}

function get_region {
    echo $(curl -s http://169.254.169.254/latest/meta-data/placement/region)
}

function export_logs {
    instance_id=$(get_instance_id)
    region=$(get_region)
    bucket='auto-scaling-terminated-log-bucket'
    lifecycle_hook_name='terminated-hook'
    group_name='test-auto-scaling-group'
    log_path='/var/log/cloud-init-output.log'
 
    echo $instance_id
    echo $region

    # export logs
    sudo aws s3 cp $log_path s3://$bucket/$group_name-$instance_id/

    # send callback
    echo $(aws autoscaling complete-lifecycle-action \
      --lifecycle-hook-name $lifecycle_hook_name \
      --auto-scaling-group-name $group_name \
      --lifecycle-action-result CONTINUE \
      --instance-id $instance_id \
      --region $region)
}

function main {
    while true
    do
        target_state=$(get_target_state)
        echo $target_state
        if [ \"$target_state\" = \"Terminated\" ]; then
            export_logs
        fi
        echo $target_state
        sleep 5
    done
}

main

起動テンプレートをマネジメントコンソールから作成する場合は、「EC2 Auto Scaling で使用できるテンプレートをセットアップする際に役立つガイダンスを提供」にチェックを入れると必須や推奨の項目が表示されるので便利です。