これは AWS CDK v2 デベロッパーガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AWS CDK CLI テレメトリを設定する
CDK CLI テレメトリとは
重要
AWS CDK CLI テレメトリは、 AWS CDK CLI バージョン 2.1100.0 以降でのみ収集されます。
AWS Cloud Development Kit (AWS CDK) は、CLI の使用に関するテレメトリデータを収集して、CDK CLI ユーザーベースに影響する広範な問題を特定するのに役立つ、全体的な使用パターンとエラー頻度を提供します。
顧客はデフォルトで CLI テレメトリデータ収集にオプトインされます。以下に示す方法を使用して、CDK CLI テレメトリをオプトアウトできます。
AWS CDK は、厳密なデータ最小化を念頭に置いてテレメトリデータを収集し、特定のユーザー、アカウント、または組織の特定や帰属を防止します。デフォルトで収集されるメトリクスの完全なリストを、動機とともに以下に示します。このリストは時間の経過とともに変更される可能性があります。変更には常に動機が伴い、匿名性とデータ最小化の原則が尊重されます。
現在、完全なエラーメッセージ、スタックトレース、ログは収集されていません。このデータが将来の CDK CLI バージョンで収集された場合、常に明示的なオプトイン状態になります。これらのメトリクスの詳細については、表を参照してください。
収集されるデータは次のとおりです。
| メトリクス | 説明 | Reason | 例 |
|---|---|---|---|
|
CDK CLI バージョン |
CLI バージョン (x.y.z) |
これを収集すると、データをバージョン別に分割し、問題のあるバージョンを特定するのに役立ちます。 |
"2.1100.0" |
|
インストール ID |
CLI コマンドを実行するローカルマシンに保存されているランダム UUID |
これにより、エラーの影響を受ける個別のユーザーの数を見積もることができます。各一意のマシンには、UUID V4 を介してランダムに生成される独自のインストール ID があります。 |
"881d3281-2811-4c86-b7b6-4a8a621cf6f2" |
|
セッション ID |
各 CLI コマンド呼び出しで生成されるランダム UUID |
これにより、同じコマンドから発生するすべてのイベントを識別できます。 |
"c47e3d55-bc20-406b-a02a-e0285dd63230" |
|
Event ID |
セッション ID とカウンター |
これにより、セッション内のイベントごとに一意の識別子が作成されます。 |
"c47e3d55-bc20-406b-a02a-e0285dd63230:0" |
|
リージョン |
AWS リージョン |
これは、データをリージョン固有の問題と区別するのに役立ちます。 |
"us-east-1" |
|
タイムスタンプ |
データがテレメトリエンドポイントに送信された (クライアントによって生成された) 時間 |
これにより、時系列グラフを生成できます。 |
"2025-12-12T00:00:00.000Z" |
|
イベントの状態 |
イベントの「結果」。指定できる値は「成功」、「失敗」、「中止」です |
これにより、各 CLI コマンドのエラー率を追跡し、顧客から報告される前に潜在的なリグレッションを警告できます。 |
"SUCCESS" |
|
イベントタイプ |
データを生成するイベントタイプの識別子 |
これは、コマンド実行で複数のイベントが発生する可能性があるために発生したイベントの種類を識別する列挙型です。 |
"SYNTH" |
|
コマンドパス |
CLI に入力され、フリーテキストが編集されたコマンドとプロパティ |
コマンドパラメータに加えて、この情報は、発生したイベントの動作を判断するのに役立ちます。これにより、爆発半径と発生した問題の原因を特定できます。 |
["cdk", "deploy", "$STACK1"] |
|
コマンドのパラメーター |
CLI に入力され、フリーテキストが編集されたオプションのパラメータ |
コマンドパスに加えて、この情報は、発生したイベントの動作を決定するのに役立ちます。これにより、爆発半径と、 によって発生する問題の原因を特定できます。 |
{
all: true,
concurrency: 4
}
|
|
設定 |
CLI コマンドに影響する可能性のある追加のパラメータ (例: cdk.context.json または |
これにより、 CLI の動作に影響を与える可能性のあるすべてのパラメータを包括的に把握できるため、デバッグが容易になります。 |
{ context: { "@aws-cdk/core:explicitStackTags": true } } |
|
オペレーティングシステム |
使用されているオペレーティングシステム |
これにより、特定のオペレーティングシステムにのみ影響する問題をデバッグできます。 |
{
platform: "linux",
release: "5.15.0-1019-aws",
}
|
|
Language |
アプリケーションが使用している CDK 実装言語での推測。 |
これにより、合成時間の遅延や言語別のエラー率の増加などの問題をセグメント化し、それらを視覚化して対処するのに役立ちます。 |
"python" |
|
CI/CD |
CLI コマンドが CI/CD 環境から呼び出されているかどうか |
これにより、CI/CD 環境に固有の問題を特定できます。 |
false |
|
[エージェント] |
AI エージェントがコマンドを実行しているかどうかを最もよく推測する |
これにより、AI エージェントに影響する問題をデバッグできます。 |
true |
|
ノードバージョン |
環境で使用されているノードバージョン |
これにより、発生したノード固有の問題をデバッグできます。 |
"v22.0.0" |
|
時間 |
ミリ秒単位のイベントの長さ |
これにより、特定のイベントにかかる時間のパターンに気づくことができます。 |
{ total: 300 }
|
|
カウンタ |
CDK アプリと CLI 実行から派生したさまざまなカウンターメトリクス |
CFN リソース数などの (ただしこれらに限定されない) 統計のカウントがデプロイ期間にどのように影響するかをモニタリングします。 |
{
resourceCount: 25,
errorCount: 0,
warningCount: 2,
}
|
|
依存関係 |
関連する AWS の依存関係とそのバージョン |
aws-cdk-lib、jsii、projen など、CLI の結果に影響を与える可能性のある AWS の依存関係を追跡する予定です。特定の AWS 所有のライブラリへの依存関係のみを収集します。 |
[{ "aws-cdk-lib": "2.232.0"}]
|
|
エラー名 |
エラーが発生した場合のエラーの名前またはコード。 |
管理しているエラー名とエラーコードのみを記録します。これを使用して、繰り返し発生するエラータイプを識別します。 |
"ToolkitError" |
|
以下のメトリクスには明示的なオプトインが必要であり、現在収集されていません。 |
|||
|
エラーメッセージ |
エラーが発生した場合に返されるエラーメッセージ。フリーフォームテキストを編集しました。 |
[オプトインが必要] エラーメッセージをキャプチャすると、個々のユースケースで何が失敗したかをデバッグするのに役立ちます。 |
現在収集されていません |
|
エラースタックトレース |
エラーが発生した場合のエラーメッセージのスタックトレース。フリーフォームテキストを編集しました。 |
[オプトインが必要] スタックトレースは、個々のデバッグ目的に役立ち、発生する可能性のある問題を再現するために必要です。 |
現在収集されていません |
|
エラーログ |
エラーが発生した場合に失敗した CLI コマンドのログ。フリーフォームテキストを編集しました。 |
[オプトインが必要] エラーログは、 CLI に表示される問題のデバッグと再現にも役立ちます。 |
現在収集されていません |
CDK CLI テレメトリからオプトアウトする方法
コンテキスト値と環境変数に基づいて現在のテレメトリステータスを表示するには、次のコマンドを実行します。
cdk cli-telemetry --status
コンテキスト値を使用してオプトアウトする
さまざまなソースのコンテキスト値に競合がある場合、CDK は次の優先順位を使用します。
-
--contextオプションで CDK CLI のコマンドを使用して指定されたコンテキスト値 -
cdk.json のコンテキスト値
-
cdk.context.json のコンテキスト値
-
~/.cdk.json のコンテキスト値
CDK CLI のコマンドを使用してオプトアウトするには
次の CDK CLI のコマンドを実行してテレメトリを無効にします。
cdk cli-telemetry --disable
このコマンドを実行すると、アクションがローカル cdk.context.json ファイルに記録され、現在の CDK アプリケーションのみに適用されます。
アプリケーション設定ファイルを使用してオプトアウトするには
アプリケーションの cdk.json ファイルで cli-telemetry: false を設定します。これにより、アプリケーションのテレメトリが無効になります。
グローバル設定ファイルを使用してオプトアウトするには
同じコンピュータ上のすべての CDK アプリケーションのテレメトリを無効にするには、~/.cdk.json ファイルで cli-telemetry: false を設定します。この設定は、次のようにコンテキスト要素内で指定する必要があります。
{ "context": { "cli-telemetry": false } }
環境変数を使用してオプトアウトする
CDK_DISABLE_CLI_TELEMETRY 環境変数を true に設定して、その環境で CLI テレメトリを無効にします。
CDK_DISABLE_CLI_TELEMETRY=true
この環境変数の値は、設定されたコンテキスト値よりも優先されます。
ヒント
この環境変数を .bashrc などのシェルスタートアップファイルに追加して、ターミナルウィンドウを開くたびにテレメトリを無効にします。
DNS フィルタリングを使用してオプトアウトする
テレメトリエンドポイントは ですcdk-cli-telemetry.us-east-1.api.aws/metrics。ファイアウォールでこのドメイン名をブロックすると、CLI テレメトリが無効になり、CDK CLI の機能には影響しません。
すべての使用状況データのレポート作成からオプトアウトする
1 つのコマンドのすべての使用状況データのレポート作成からオプトアウトするには、--no-version-reporting グローバル CLI オプションを使用します。このオプションは、アプリケーション使用状況データ収集と CDK CLI テレメトリの両方をオフにします。
--no-version-reporting オプションを使用して現在アプリケーション使用状況データ収集からオプトアウトしている場合、コンテキスト値に関係なく、その特定のコマンド実行の CDK CLI テレメトリから自動的にオプトアウトされます。
注記
スタックレベルで analyticsReporting を設定する場合、アプリケーション使用状況データ収集のみの --no-version-reporting オプションよりも優先されます。
テレメトリデータをローカルファイルに送信する
CDK CLI テレメトリにオプトインしたままにすることを選択した場合は、テレメトリデータをローカルファイルに送信することを選択できます。その後、ファイルを確認して、収集されているテレメトリデータを監査できます。
CDK CLI コマンドで次のオプションを使用して、テレメトリデータをローカルファイルに送信します。
注記
2.1100.0 より前の AWS CDK CLI バージョンを使用している場合は、 --unstable=telemetryとともに を指定する必要があります--telemetry-file。
--telemetry-file='path/to/local/file'
たとえば、このdeployコマンドはテレメトリデータをローカルファイルに送信します。
cdk deploy --telemetry-file='path/to/local/file'
ページ履歴
| 日付 | 説明 |
|---|---|
|
2026 年 3 月 2 日 |
パフォーマンス番号をセグメント化するために、収集されたフィールドのセットに「言語」と「エージェント」を追加します。 |
