3.2. CloudWatchメトリックの確認 (SQS キュー: ApproximateNumberOfMessagesVisible)¶
作業の目的 [why]¶
SQSキュー"handson-cli-cloudwatch-queue"のCloudWatchメトリック"ApproximateNumberOfMessagesVisible"を確認します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
SQSキューのCloudWatchメトリック"ApproximateNumberOfMessagesVisible"を確認できている。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
SQSキュー"handson-cli-cloudwatch-queue"が存在する。
- 事前条件2
SQSキューのCloudWatchメトリック"ApproximateNumberOfMessagesVisible"が存在する。
作業対象 [what]¶
CloudWatchメトリック
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CloudWatch名前空間
確認するCloudWatchメトリックの名前空間です。
今回は"AWS/SQS"とします。
リソース2: CloudWatchメトリック名
確認するCloudWatchメトリック名です。
今回は"ApproximateNumberOfMessagesVisible"とします。
リソース3: CloudWatchディメンション名
確認するCloudWatchメトリックの対象となるディメンション名です。
今回は"QueueName"とします。
リソース4: SQSキュー名
確認するCloudWatchメトリックの対象となるSQSキューの名称です。
今回は"handson-cli-cloudwatch-queue"とします。
リソース5: 統計周期
確認するCloudWatchメトリックの統計周期です。
今回は"300"とします。
リソース6: 統計
確認するCloudWatchメトリックの統計です。
今回は"Average"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. CloudWatchメトリック名の指定¶
CloudWatchディメンション名を指定します。
変数の設定:
CLOUDWATCH_METRIC_NAME="ApproximateNumberOfMessagesVisible"
0.3. CloudWatchディメンション名の指定¶
CloudWatchディメンション名を指定します。
変数の設定:
CLOUDWATCH_DIMENSION_NAME="QueueName"注釈
AWS/SQSで使用可能なディメンションは、'QueueName'のみです。
使用可能なAmazon SQSのCloudWatchメトリクス: https://docs.aws.amazon.com/ja_jp/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-available-cloudwatch-metrics.html
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" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudwatch-metric-read-expand-sqs-queue.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-cloudwatch/2020-01-06-cloudwatch-metric-read-expand-sqs-queue.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. CLOUDWATCH_NAMESPACE:"AWS/SQS" CLOUDWATCH_NAMESPACE="${CLOUDWATCH_NAMESPACE}" # 0.2. CLOUDWATCH_METRIC_NAME:"ApproximateNumberOfMessagesVisible" CLOUDWATCH_METRIC_NAME="${CLOUDWATCH_METRIC_NAME}" # 0.3. CLOUDWATCH_DIMENSION_NAME:"QueueName" CLOUDWATCH_DIMENSION_NAME="${CLOUDWATCH_DIMENSION_NAME}" # 0.4. SQS_QUEUE_NAME:"handson-cli-cloudwatch-queue" SQS_QUEUE_NAME="${SQS_QUEUE_NAME}" # 0.5. CLOUDWATCH_METRIC_PERIOD:"300" CLOUDWATCH_METRIC_PERIOD="${CLOUDWATCH_METRIC_PERIOD}" # 0.6. CLOUDWATCH_METRIC_STATISTICS:"Average" 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=${CLOUDWATCH_DIMENSION_NAME},Value=${SQS_QUEUE_NAME}" \ && echo ${STRING_CLOUDWATCH_DIMENSIONS}
結果(例):
Name=QueueName,Value=handson-cli-cloudwatch-queue
1.2. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: SQSキュー"handson-cli-cloudwatch-queue"が存在する。
「SQSキュー"handson-cli-cloudwatch-queue"が存在する。」ことを確認します。
コマンド:
aws sqs list-queues \ --queue-name-prefix ${SQS_QUEUE_NAME} \ --query "QueueUrls[?contains(@, \`${SQS_QUEUE_NAME}\`)]" \ --output text
結果(例):
https://ap-northeast-1.queue.amazonaws.com/XXXXXXXXXXXX/handson-cli-cloudwatch-queue
事前条件2: SQSキューのCloudWatchメトリック"ApproximateNumberOfMessagesVisible"が存在する。
「SQSキューのCloudWatchメトリック"ApproximateNumberOfMessagesVisible"が存在する。」ことを確認します。
コマンド:
aws cloudwatch list-metrics \ --namespace ${CLOUDWATCH_NAMESPACE} \ --dimensions ${STRING_CLOUDWATCH_DIMENSIONS} \ --query "Metrics[?MetricName == \`${CLOUDWATCH_METRIC_NAME}\`].MetricName" \ --output text
結果(例):
ApproximateNumberOfMessagesVisible
1.3. 主処理に必要な情報の取得¶
sample
2. 主処理¶
CloudWatchメトリックの取得¶
変数の確認:
cat << ETX # CLOUDWATCH_NAMESPACE:"AWS/SQS" CLOUDWATCH_NAMESPACE="${CLOUDWATCH_NAMESPACE}" # CLOUDWATCH_METRIC_NAME:"ApproximateNumberOfMessagesVisible" CLOUDWATCH_METRIC_NAME="${CLOUDWATCH_METRIC_NAME}" # STRING_CLOUDWATCH_DIMENSIONS:"Name=QueueName,Value=handson-cli-cloudwatch-queue" 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:"Average" 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-01-06T05:45:00Z Count 0.0 2020-01-06T05:40:00Z Count