安全な Canary 更新の実行

CloudWatch Synthetics の安全な Canary 更新機能を使用すると、既存の Canary の更新をテストしたうえで変更を適用できます。この機能は新しいランタイムと Canary の互換性の検証や、コードやメモリの変更のような設定変更を確認するのに役立ちます。これにより、更新内容の誤りが原因でモニタリングの中断が発生するのを最小限に抑えることができます。

Canary の安全な更新機能を使用してランタイムのバージョン更新や設定変更、コードスクリプトの修正を行うことで、リスクを緩和し、無停止でモニタリングを継続し、コミットや更新前に変更内容を検証し、ダウンタイムを抑えるなど、さまざまなメリットを得られます。

前提条件

前提条件を満たしていることを確認してください。

ベストプラクティス

Canary を実行する際のベストプラクティスには、次のものがあります。

ドライランを使用した Canary のテスト

Canary の更新のテストでは、次のオプションを使用できます。

AWS Management Console の編集ワークフローの使用

AWS Management Console を使用して Canary を一括で更新する

AWS CLI または SDK を使用する

API は指定した Canary 名 MyCanary のドライランを開始し、ランタイムバージョンを syn-nodejs-puppeteer-10.0 に更新します。

aws synthetics start-canary-dry-run \
    --name MyCanary \
    --runtime-version syn-nodejs-puppeteer-10.0
      
      // Or if you wanted to update other configurations:

aws synthetics start-canary-dry-run \
    --name MyCanary \
    --execution-role-arn arn:aws:iam::123456789012:role/NewRole

API は DryRunId 内で DryRunConfigOutput を返します。

得られた DryRunId を指定して GetCanary を呼び出し、Canary のドライラン設定と追加フィールド DryRunConfig を受け取ります。このフィールドには LastDryRunExecutionStatus としてリストされているドライランのステータスが含まれます。

aws synthetics get-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

詳細については、得られた DryRunId を指定して GetCanaryRuns を使用し、該当の実行と追加情報を取得してください。

aws synthetics get-canary-runs \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

ドライランが正常に終了したら、得られた DryRunId を指定して UpdateCanary を使用し、変更をコミットできます。

aws synthetics update-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

何らかの理由で失敗した場合 (GetCanaryRuns の結果に詳細が表示されます)、GetCanaryRuns の結果には、デバッグ用のログを含むアーティファクトの場所が出力されます。ログがない場合は、ドライランの作成に失敗しています。GetCanary を使用すれば実行を検証できます。

aws synthetics get-canary \
    --name MyCanary \
    --dry-run-id XXXX-XXXX-XXXX-XXXX

State、StateReason、StateReasonCode にドライランのステータスが表示されます。

AWS CloudFormation の使用

Synthetics Canary のテンプレートに、ブール値 true または false を受け取る DryRunAndUpdate フィールドを追加します。

値が true の場合、更新の際に Canary を自動で更新せずに、まずドライランを実行して変更内容を検証します。ドライランが失敗した場合は Canary は更新されず、対象のデプロイと AWS CloudFormation のデプロイは正当な理由により失敗となります。この問題をデバッグするには、AWS Synthetics コンソールを使用するか、API を利用している場合は GetCanaryRuns API を使用して ArtifactS3Location を取得し、*-log.txt ファイルをダウンロードして Canary ログから実行エラーを確認します。検証が終わったら AWS CloudFormation テンプレートを修正してもう一度デプロイを試すか、上記の API を使用して検証を行います。

値が false の場合、Synthetics はドライランを実行して変更を検証せず、更新内容を直接コミットします。

失敗した Canary のトラブルシューティングについては、「失敗した Canary のトラブルシューティング」を参照してください。

テンプレートの例

SyntheticsCanary:
    Type: 'AWS::Synthetics::Canary'
    Properties:
      Name: MyCanary
      RuntimeVersion: syn-nodejs-puppeteer-10.0
      Schedule: {Expression: 'rate(5 minutes)', DurationInSeconds: 3600}
      ...
      DryRunAndUpdate: true

制限