3.2. CloudWatchメトリックの確認 (カスタム: Invocations)

作業の目的 [why]

カスタムメトリック"Invocations"を確認します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1

カスタムメトリック"Invocations"を確認できている。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1

カスタムメトリック"Invocations"が存在する。

作業対象 [what]

  • CloudWatchメトリック

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間

2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: CloudWatch名前空間

  • 確認するCloudWatchメトリックの名前空間です。

  • 今回は"HandsonCliApplication"とします。

リソース2: CloudWatchメトリック名

  • 確認するCloudWatchメトリック名です。

  • 今回は"Invocations"とします。

リソース3: CloudWatchディメンション名

  • 確認するCloudWatchメトリックの対象となるディメンション名です。

  • 今回は"HandsonCliFunction"とします。

リソース4: カスタムリソース名

  • 確認するCloudWatchメトリックの対象となるカスタムリソースの名称です。

リソース5: 統計周期

  • 確認するCloudWatchメトリックの統計周期です。

  • 今回は"300"とします。

リソース6: 統計

  • 確認するCloudWatchメトリックの統計です。

  • 今回は"Sum"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CloudWatch名前空間の指定

CloudWatch名前空間を指定します。

変数の設定:

CLOUDWATCH_NAMESPACE="HandsonCliApplication"

0.2. CloudWatchメトリック名の指定

CloudWatchディメンション名を指定します。

変数の設定:

CLOUDWATCH_METRIC_NAME="Invocations"

0.3. CloudWatchディメンション名の指定

CloudWatchディメンション名を指定します。

変数の設定:

CLOUDWATCH_DIMENSION_NAME="HandsonCliFunction"

0.4. カスタムリソース名の指定

課題

カスタムメトリクス

0.5. 統計周期の指定

統計周期を指定します。

変数の設定:

CLOUDWATCH_METRIC_PERIOD="300"

0.6. 統計の指定

統計を指定します。

変数の設定:

CLOUDWATCH_METRIC_STATISTICS="Sum"

0.7. 統計期間の終了時刻の指定

統計期間の終了時刻を指定します。

変数の設定:

TIME_CURRENT_ISO860_UTC=$( \
  date -u '+%FT%TZ' \
) \
  && echo ${TIME_CURRENT_ISO860_UTC}

結果(例):

YYYY-mm-ddTHH:MM:SSZ

変数の設定:

CLOUDWATCH_END_TIME="${TIME_CURRENT_ISO860_UTC}" \
  && echo ${CLOUDWATCH_END_TIME}

結果(例):

YYYY-mm-ddTHH:MM:SSZ

0.8. 統計期間の開始時刻の指定

統計期間の開始時刻を指定します。

今回は、終了時間から特定の時間(分)を遡って開始時間を決定します。

変数の設定:

TIME_OFFSET_PAST_MIN='30'

変数の設定:

TIME_PAST_ISO860_UTC=$( \
  date -u -d "${TIME_OFFSET_PAST_MIN} mins ago" '+%FT%TZ' \
) \
  && echo ${TIME_PAST_ISO860_UTC}

結果(例):

YYYY-mm-ddTHH:MM:SSZ

変数の設定:

CLOUDWATCH_START_TIME="${TIME_PAST_ISO860_UTC}" \
  && echo ${CLOUDWATCH_START_TIME}

結果(例):

YYYY-mm-ddTHH:MM:SSZ

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-cloudwatch-custom"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudwatch-metric-read-expand-custom.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-cloudwatch-custom/2020-03-02-cloudwatch-metric-read-expand-custom.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0.  AWS_DEFAULT_REGION:"ap-northeast-1"
          AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1.  CLOUDWATCH_NAMESPACE:"HandsonCliApplication"
          CLOUDWATCH_NAMESPACE="${CLOUDWATCH_NAMESPACE}"
  # 0.2.  CLOUDWATCH_METRIC_NAME:"Invocations"
          CLOUDWATCH_METRIC_NAME="${CLOUDWATCH_METRIC_NAME}"
  # 0.3.  CLOUDWATCH_DIMENSION_NAME:"HandsonCliFunction"
          CLOUDWATCH_DIMENSION_NAME="${CLOUDWATCH_DIMENSION_NAME}"
  # 0.4.

  # 0.5.  CLOUDWATCH_METRIC_PERIOD:"300"
          CLOUDWATCH_METRIC_PERIOD="${CLOUDWATCH_METRIC_PERIOD}"
  # 0.6.  CLOUDWATCH_METRIC_STATISTICS:"Sum"
          CLOUDWATCH_METRIC_STATISTICS="${CLOUDWATCH_METRIC_STATISTICS}"
  # 0.7.  CLOUDWATCH_END_TIME:"YYYY-mm-ddTHH:MM:SSZ"
          CLOUDWATCH_END_TIME="${CLOUDWATCH_END_TIME}"
  # 0.8.  CLOUDWATCH_START_TIME:"YYYY-mm-ddTHH:MM:SSZ"
          CLOUDWATCH_START_TIME="${CLOUDWATCH_START_TIME}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間

6分

1. 前処理

1.1. 状態確認に必要な情報の取得

ディメンション文字列の生成

変数の設定:

STRING_CLOUDWATCH_DIMENSIONS="Name=FunctionName,Value="HandsonCliFunction \
  && echo ${STRING_CLOUDWATCH_DIMENSIONS}

結果(例):

Name=FunctionName,Value=HandsonCliFunction

1.2. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: カスタムメトリック"Invocations"が存在する。

「カスタムメトリック"Invocations"が存在する。」ことを確認します。

コマンド:

aws cloudwatch list-metrics \
  --namespace ${CLOUDWATCH_NAMESPACE} \
  --dimensions ${STRING_CLOUDWATCH_DIMENSIONS} \
  --query "Metrics[?MetricName == \`${CLOUDWATCH_METRIC_NAME}\`].MetricName" \
  --output text

結果(例):

Invocations

2. 主処理

CloudWatchメトリックの取得

変数の確認:

cat << ETX

  # CLOUDWATCH_NAMESPACE:"HandsonCliApplication"
    CLOUDWATCH_NAMESPACE="${CLOUDWATCH_NAMESPACE}"
  # CLOUDWATCH_METRIC_NAME:"Invocations"
    CLOUDWATCH_METRIC_NAME="${CLOUDWATCH_METRIC_NAME}"
  # STRING_CLOUDWATCH_DIMENSIONS:"Name=FunctionName,Value=HandsonCliFunction"
    STRING_CLOUDWATCH_DIMENSIONS="${STRING_CLOUDWATCH_DIMENSIONS}"
  # CLOUDWATCH_START_TIME:"YYYY-mm-ddTHH:MM:SSZ"
    CLOUDWATCH_START_TIME="${CLOUDWATCH_START_TIME}"
  # CLOUDWATCH_END_TIME:"YYYY-mm-ddTHH:MM:SSZ"
    CLOUDWATCH_END_TIME="${CLOUDWATCH_END_TIME}"
  # CLOUDWATCH_METRIC_PERIOD:"300"
    CLOUDWATCH_METRIC_PERIOD="${CLOUDWATCH_METRIC_PERIOD}"
  # CLOUDWATCH_METRIC_STATISTICS:"Sum"
    CLOUDWATCH_METRIC_STATISTICS="${CLOUDWATCH_METRIC_STATISTICS}"

ETX

コマンド:

aws cloudwatch get-metric-statistics \
  --namespace ${CLOUDWATCH_NAMESPACE} \
  --metric-name ${CLOUDWATCH_METRIC_NAME} \
  --dimensions ${STRING_CLOUDWATCH_DIMENSIONS} \
  --start-time ${CLOUDWATCH_START_TIME} \
  --end-time ${CLOUDWATCH_END_TIME} \
  --period ${CLOUDWATCH_METRIC_PERIOD} \
  --statistics ${CLOUDWATCH_METRIC_STATISTICS} \
  --query 'Datapoints' \
  --output text \
| sort -k3

結果(例):

0.0     2020-03-02T05:45:00Z    Count
0.0     2020-03-02T05:40:00Z    Count

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: カスタムメトリック"Invocations"を確認できている。

「カスタムメトリック"Invocations"を確認できている。」ことを確認します。

完了