AWS Auto Scaling GroupのBlue/Greenデプロイにおける Amazon CloudWatch Alarm自動更新の実装

cdk --version 
2.1004.0 (build f0ad96e)

node -v
v20.16.0

# リポジトリをクローン
git clone https://github.com/yuu551/asg-alarm-auto-update

# ディレクトリ移動
cd asg-alarm-auto-update

# 依存モジュールをインストール
npm install

# デプロイ実行
cdk deploy

import { CloudWatch } from '@aws-sdk/client-cloudwatch';
import { ALARM_CONFIGS } from './alarmConfigs.js';

const cloudwatch = new CloudWatch({ region: 'ap-northeast-1' });

// 再帰的にアラームを取得する関数
async function getAllAlarms(params, allAlarms = []) {
    const response = await cloudwatch.describeAlarms(params);

    const updatedAlarms = response.MetricAlarms
        ? [...allAlarms, ...response.MetricAlarms]
        : allAlarms;

    if (response.NextToken) {
        return getAllAlarms(
            { ...params, NextToken: response.NextToken },
            updatedAlarms
        );
    }

    return updatedAlarms;
}

// アラームを作成する関数
async function createMetricAlarm(metricType, deploymentId, autoScalingGroupName) {
    if (!ALARM_CONFIGS[metricType]) {
        throw new Error(`未定義のメトリクスタイプ: ${metricType}`);
    }

    const config = ALARM_CONFIGS[metricType];

    const params = {
        AlarmName: `${config.prefix}-${deploymentId}`,
        AlarmDescription: config.description, 
        MetricName: config.metricName,
        Namespace: config.namespace,
        Statistic: config.statistic,
        Period: config.period,
        Threshold: config.threshold,
        ComparisonOperator: config.comparisonOperator,
        EvaluationPeriods: config.evaluationPeriods,
        Dimensions: [{
            Name: 'AutoScalingGroupName',
            Value: autoScalingGroupName
        }],
        // 直接記載するのではなく、環境変数などから取得するほうがベター
        AlarmActions: ['arn:aws:sns:ap-northeast-1:xxx:anomaly_detection']
    };

    return cloudwatch.putMetricAlarm(params);
}

// 既存のアラームを削除する関数
async function deleteExistingAlarms(metricType, deploymentId) {
    if (!ALARM_CONFIGS[metricType]) {
        throw new Error(`未定義のメトリクスタイプ: ${metricType}`);
    }

    const config = ALARM_CONFIGS[metricType];
    const prefix = `${config.prefix}-`;

    try {
        const listAlarmsParams = {
            AlarmNamePrefix: prefix,
            MaxRecords: 100
        };

        const allAlarms = await getAllAlarms(listAlarmsParams);

        // 削除対象のアラーム名をフィルタリング
        const alarmsToDelete = allAlarms
            .filter(alarm =>
                alarm.AlarmName.startsWith(prefix) &&
                alarm.Dimensions.some(dim =>
                    dim.Name === 'AutoScalingGroupName'
                )
            )
            .map(alarm => alarm.AlarmName);

        if (alarmsToDelete.length > 0) {
            await cloudwatch.deleteAlarms({
                AlarmNames: alarmsToDelete
            });
            console.log(`削除された既存の${metricType}アラーム:`, alarmsToDelete);
        } else {
            console.log(`削除対象の既存${metricType}アラームは見つかりませんでした。`);
        }
    } catch (deleteError) {
        // エラーが発生しても処理を継続できるように警告ログを出力
        console.warn(`既存の${metricType}アラーム削除中のエラー:`, deleteError);
    }
}

export const handler = async (event) => {
    try {
        console.log('受信イベント:', JSON.stringify(event, null, 2));

        // SNSメッセージからデプロイメント情報を取得
        const snsMessage = JSON.parse(event.Records[0].Sns.Message);

        // デプロイメント情報を取得
        const deploymentId = snsMessage.deploymentId;
        const applicationName = snsMessage.applicationName;
        const deploymentGroupName = snsMessage.deploymentGroupName;

        // 新しいAuto Scaling Group名を構築 (CodeDeployの命名規則に依存)
        const autoScalingGroupName = `CodeDeploy_${deploymentGroupName}_${deploymentId}`;

        // 処理対象のメトリクスタイプを設定
        const metricTypes = ['CPU', 'StatusCheck', 'Memory'];

        const results = {};

        // 各メトリクスタイプに対してアラームを更新
        for (const metricType of metricTypes) {
            // 既存のアラームを削除 (新しいデプロイIDに紐づかない古いアラームを削除)
            // 注意: deploymentIdは毎回変わるため、プレフィックスのみで検索し、ASGディメンションを持つものを削除
            await deleteExistingAlarms(metricType, deploymentId); // deploymentIdは新しいアラーム名生成に使うが、削除ロジックではプレフィックスで検索

            // 新しいアラームを作成
            const result = await createMetricAlarm(metricType, deploymentId, autoScalingGroupName);
            console.log(`新しい${metricType}アラームが正常に作成されました:`, result);

            results[metricType] = {
                alarmName: `${ALARM_CONFIGS[metricType].prefix}-${deploymentId}`,
                status: 'created'
            };
        }

        return {
            statusCode: 200,
            body: JSON.stringify({
                message: 'CloudWatch アラームが正常に作成/更新されました',
                autoScalingGroupName: autoScalingGroupName,
                alarms: results
            })
        };

    } catch (error) {
        console.error('エラー:', error);
        // エラー発生時もLambda実行自体は成功として扱うか、エラーを返すかは要件による
        // ここではエラーをスローしてLambda実行失敗とする
        throw error;
    }
};

// アラーム設定を定義
export const ALARM_CONFIGS = {
    CPU: {
        prefix: 'ASG-HighCPUUtilization',
        description: 'アラーム：CPU使用率が70%を超過した場合', // 日本語に統一
        metricName: 'CPUUtilization',
        namespace: 'AWS/EC2',
        statistic: 'Average',
        period: 300,
        threshold: 70,
        comparisonOperator: 'GreaterThanThreshold',
        evaluationPeriods: 2
    },
    StatusCheck: {
        prefix: 'ASG-StatusCheckFailed',
        description: 'アラーム：ステータスチェック失敗（インスタンス）', // 日本語に統一
        metricName: 'StatusCheckFailed_Instance', // EC2インスタンスのステータスチェックを想定
        namespace: 'AWS/EC2',
        statistic: 'Maximum',
        period: 300,
        threshold: 1, // 1回でも失敗したらアラーム
        comparisonOperator: 'GreaterThanOrEqualToThreshold',
        evaluationPeriods: 1 // 1期間で評価
    },
    Memory: {
        prefix: 'ASG-HighMemoryUtilization',
        description: 'アラーム：メモリ使用率が70%を超過した場合', // 日本語に統一
        metricName: 'mem_used_percent',
        namespace: 'CWAgent', // CloudWatch Agentで収集するメトリクスを想定
        statistic: 'Average',
        period: 300,
        threshold: 70,
        comparisonOperator: 'GreaterThanThreshold',
        evaluationPeriods: 2
    }
};

{
  "metrics": {
    "namespace": "CustomApplicationMetrics", // 任意の名前空間
    "append_dimensions": {
      "ApplicationName": "my-web-app", // アプリケーションを識別する固定のディメンション
      "Environment": "production",     // 環境を識別する固定のディメンション
      "AutoScalingGroupName": "${aws:AutoScalingGroupName}", // 参考情報としてASG名も追加可能
      "InstanceId": "${aws:InstanceId}"
    },
    "metrics_collected": {
      "mem": {
        "measurement": [
          {"name": "mem_used_percent", "unit": "Percent"}
        ],
        "metrics_collection_interval": 60
      },
      "cpu": { // 標準メトリクスもAgent経由で収集する場合
        "measurement": [
          {"name": "cpu_usage_idle", "unit": "Percent"},
          {"name": "cpu_usage_iowait", "unit": "Percent"},
          {"name": "cpu_usage_user", "unit": "Percent"},
          {"name": "cpu_usage_system", "unit": "Percent"}
        ],
        "totalcpu": true, // 全CPUコアの平均値
        "metrics_collection_interval": 60
      }
      // 必要に応じてディスクやネットワークなどのメトリクスも追加
    }
  }
}

// AWS CLIでの作成例
aws cloudwatch put-metric-alarm \
    --alarm-name "High-CPU-Usage-MyApp-Production" \
    --alarm-description "Alarm" \
    --metric-name "cpu_usage_system" \
    --namespace "CustomApplicationMetrics" \
    --statistic Average \
    --period 300 \
    --threshold 70 \
    --comparison-operator GreaterThanThreshold \
    --dimensions Name=ApplicationName,Value=my-web-app Name=Environment,Value=production \
    --evaluation-periods 2 \
    --alarm-actions arn:aws:sns:ap-northeast-1:ACCOUNT_ID:your-sns-topic