CloudTrail を使用して IDE または CLI が出力する Amazon Q Developer イベントをログに記録する方法を教えてください。

簡単な説明

IDE または CLI から取得できるイベントは、CloudTrail データイベントです。デフォルトでは、CloudTrail はデータイベントをログに記録しないため、CloudTrail イベント履歴でイベントを確認することはできません。IDE または CLI が出力した Amazon Q Developer イベントを CloudTrail に記録するには、データイベントを記録するカスタム証跡を作成します。

注: 次の解決策を実施するには、Amazon Q Developer Pro のサブスクリプションが必要です。認証には AWS アカウントではなく AWS Builder ID を使用するため、無料利用枠を使用してイベントを記録することはできません。

解決策

Amazon Q Developer データイベントの証跡を作成するには、次の手順を実行します。

1. CloudTrail コンソールを開きます。
2. ナビゲーションペインで [証跡] を選択します。
3. [証跡の作成] を選択します。
4. 次の証跡属性を入力します。
   証跡名
   ログを保存する Amazon Simple Storage Service (Amazon S3) バケット
   (オプション) カスタマーマネージド AWS Key Management Service (AWS KMS) キー
   注: すべての AWS Organizations アカウント用に証跡を作成するには、組織証跡を有効にします。適切なアクセス許可を持つユーザーまたはロールで、管理アカウントまたは委任管理者アカウントにサインインする必要があります。
5. [次へ] を選択します。
6. [ログイベントの選択] ページで [データイベント] を選択します。
7. [CodeWhisperer] を選択します。
8. [証跡の作成] を選択します。

新しい証跡は、CloudTrail コンソールの [証跡] ページで確認できます。5 分経過後に、CloudTrail はアカウントの AWS API コールを示すログファイルを発行します。指定した S3 バケットのログファイルが表示されます。

CloudTrail を設定することで、ログファイルを Amazon CloudWatch Logs に送信することもできます。

IDE が出力するイベントには、userIdentity および userAgent に関する詳細が含まれます。

IDE イベントの例:

"userIdentity": {
            "type": "IdentityCenterUser",
            "accountId": "111122223333",
            "onBehalfOf": {
                "userId": "123456789-123456789-123456789-123456789-123456789",
                "identityStoreArn": "arn:aws:identitystore::111122223333:identitystore/d-123456789"
            }
        },
"userAgent": "aws-sdk-js/0.0.1 ua/2.0 os/win32# lang/js md/nodejs#18.15.0 api/codewhispererstreaming#0.0.1 AmazonQ-For-VSCode/1.23.0",

CLI が出力するイベントには、userAgent および userContext に関する詳細が含まれます。

CLI イベントの例:

"userAgent": "aws-sdk-rust/1.3.3 api/codewhispererruntime/0.1.1100 os/macos lang/rust/1.80.1 app/AmazonQ-For-CLI",
"userContext": {
    "ideCategory": "CLI",
    "operatingSystem": "MAC",
    "product": "CodeWhisperer",
    "ideVersion": "1.3.0"
}

注: インラインまたはチャットプロンプトの詳細は CloudTrail には表示されません。プロンプトの詳細をキャプチャするには、Amazon Q Developer コンソールを使用してプロンプト記録機能を有効にします。

関連情報

Amazon CodeWhisperer 用のユーザーアクティビティダッシュボードを作成する

Amazon Q Developer でテレメトリイベントを調査する

Amazon Q Developer でユーザーアクティビティレポートを有効化する