3.1. CloudWatchメトリック一覧の確認 (SQS キュー)¶
作業の目的 [why]¶
SQSキュー"handson-cli-cloudwatch-queue"のCloudWatchメトリック一覧を確認します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
SQSキューのCloudWatchメトリック一覧を確認できている。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
SQSキュー"handson-cli-cloudwatch-queue"が存在する。
- 事前条件2
SQSキューのCloudWatchメトリックが存在する。
作業対象 [what]¶
CloudWatchメトリック
標準時間(合計)¶
8分
パラメータ設定¶
- パラメータ設定の標準時間
2分
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: CloudWatch名前空間
確認するCloudWatchメトリックの名前空間です。
今回は"AWS/SQS"とします。
リソース2: CloudWatchディメンション名
確認するCloudWatchメトリックの対象となるディメンション名です。
今回は"QueueName"とします。
リソース3: SQSキュー名
確認するCloudWatchメトリックの対象となるSQSキューの名称です。
今回は"handson-cli-cloudwatch-queue"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. 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
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-cloudwatch" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-cloudwatch-metric_list-read-expand-sqs-queue.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-cloudwatch/2020-01-06-cloudwatch-metric_list-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_DIMENSION_NAME:"QueueName" CLOUDWATCH_DIMENSION_NAME="${CLOUDWATCH_DIMENSION_NAME}" # 0.3. SQS_QUEUE_NAME:"handson-cli-cloudwatch-queue" SQS_QUEUE_NAME="${SQS_QUEUE_NAME}" 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メトリックが存在する。
「SQSキューのCloudWatchメトリックが存在する。」ことを確認します。
2. 主処理¶
CloudWatchメトリック一覧の確認¶
コマンド:
aws cloudwatch list-metrics \ --namespace ${CLOUDWATCH_NAMESPACE} \ --dimensions ${STRING_CLOUDWATCH_DIMENSIONS} \ --query 'Metrics[].MetricName' \ --output text \ | sed "s/\t/\n/g"
結果(例):
ApproximateNumberOfMessagesDelayed NumberOfMessagesDeleted NumberOfMessagesSent NumberOfMessagesReceived NumberOfEmptyReceives ApproximateAgeOfOldestMessage ApproximateNumberOfMessagesVisible ApproximateNumberOfMessagesNotVisible