5.4. CloudWatch Logsグループの保持期間設定 (handson-rds/var/log/secure)

作業の目的 [why]

CloudWatch Logsグループ"handson-rds/var/log/secure"に保持期間の設定を追加します。

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

完了条件 [after]

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

完了条件1
CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在する。

事前条件 [before]

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

事前条件1
CloudWatchLogsグループ"handson-rds/var/log/secure"が存在する。
事前条件2
CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在しない。

作業対象 [what]

  • CloudWatchサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: CloudWatch Logグループ名

  • 保持期間を設定するCloudWatch Logグループの名称です。
  • 今回は"handson-rds/var/log/secure"とします。

リソース2: 保持期間

  • 作成するCloudWatch Logグループの名称です。
  • 今回は"1"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CloudWatch Logsグループ名の指定

CloudWatch Logsグループ名を指定します。

変数の設定:

LOGS_GROUP_NAME='handson-rds/var/log/secure'

0.2. 保持日数の指定

CloudWatch Logsグループ名を指定します。

変数の設定:

LOGS_RETENTION_DAYS='1'

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-rds"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-logs-retention_policy-create.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-rds/2019-06-10-logs-retention_policy-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

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

  # 0.1. LOGS_GROUP_NAME:"handson-rds/var/log/secure"
         LOGS_GROUP_NAME="${LOGS_GROUP_NAME}"
  # 0.2. LOGS_RETENTION_DAYS:"1"
         LOGS_RETENTION_DAYS="${LOGS_RETENTION_DAYS}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: CloudWatchLogsグループ"handson-rds/var/log/secure"が存在する。

「CloudWatchLogsグループ"handson-rds/var/log/secure"が存在する。」ことを確認します。

コマンド:

aws logs describe-log-groups \
  --log-group-name-prefix ${LOGS_GROUP_NAME} \
  --query 'logGroups[].logGroupName' \
  --output text

結果(例):

handson-rds/var/log/secure

事前条件2: CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在しない。

「CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在しない。」ことを確認します。

コマンド:

aws logs describe-log-groups \
  --log-group-name-prefix ${LOGS_GROUP_NAME} \
  --query 'logGroups[].retentionInDays' \
  --output text

結果(例):

(出力なし)

2. 主処理

保持期間の設定

変数の確認:

cat << ETX

  # LOGS_GROUP_NAME:"handson-rds/var/log/secure"
    LOGS_GROUP_NAME="${LOGS_GROUP_NAME}"
  # LOGS_RETENTION_DAYS:"1"
    LOGS_RETENTION_DAYS="${LOGS_RETENTION_DAYS}"

ETX

コマンド:

aws logs put-retention-policy \
  --log-group-name ${LOGS_GROUP_NAME} \
  --retention-in-days ${LOGS_RETENTION_DAYS}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在する。

「CloudWatchLogsグループ"handson-rds/var/log/secure"に保持期間の設定が存在する。」ことを確認します。

コマンド:

aws logs describe-log-groups \
  --log-group-name-prefix ${LOGS_GROUP_NAME} \
  --query 'logGroups[].retentionInDays' \
  --output text

結果(例):

1

完了