在 Amazon Q 开发者版中记录用户的提示 - Amazon Q 开发者版

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

在 Amazon Q 开发者版中记录用户的提示

管理员可以对用户在其集成式开发环境(IDE)中与 Amazon Q 进行的所有内联建议聊天对话启用日志记录。这些日志可以帮助审计、调试、分析和确保合规性。

当开发者使用内联建议时,Amazon Q 将记录已接受和主动拒绝的建议。当开发者与 Amazon Q 聊天时,Amazon Q 将记录开发者的提示和 Amazon Q 的回复。当开发者使用 /dev 命令与 Amazon Q 代理程序探讨软件开发时,Amazon Q 只会记录提示。

Amazon Q 将日志存储在由您创建的 Amazon S3 存储桶中,路径如下:

bucketName/prefix/AWSLogs/accountId/QDeveloperLogs/log-type/region/year/month/day/utc-hour/zipFile.gz/logFile.json

在前面的路径中,log-type 是以下各项之一:

  • GenerateAssistantResponse:保存聊天记录

  • GenerateCompletions:保存内联完成日志

  • StartTaskAssistCodeGeneration:保存 /dev 日志

有关日志文件内容的示例和说明,请参阅 Amazon Q 开发者版中的提示日志示例

除了用于保存日志的 Amazon S3 存储桶的存储费用以及用于加密存储桶的可选 KMS 密钥的少量费用外,提示日志记录功能不收取任何其它费用。

按照以下说明操作来启用提示日志记录。

先决条件

  • 确保用户是使用独立账户订阅的,或者如果您使用 AWS Organizations,则为管理账户。当前,Q 开发者版不支持记录在 AWS Organizations中使用成员账户订阅的用户的提示。

  • 创建一个 Amazon S3 存储桶来存放提示日志。该存储桶必须满足以下要求:

    • 请位于安装了 Amazon Q 开发者配置文件的地 AWS 区。此配置文件是在您首次为用户订阅 Amazon Q 开发者版专业套餐时安装的。有关此配置文件及支持它的区域的更多信息,请参阅什么是 Amazon Q 开发者版配置文件?Q 开发者版控制台与 Q 开发者版配置文件支持的区域

    • 在用户订阅的 AWS 账户中。

    • 具备如下存储桶策略。用您自己的信息替换bucketNameregionaccountId、、和prefix

      JSON
      { "Version":"2012-10-17", "Statement": [ { "Sid": "QDeveloperLogsWrite", "Effect": "Allow", "Principal": { "Service": "q.amazonaws.com" }, "Action": [ "s3:PutObject" ], "Resource": [ "arn:aws:s3:::bucketName/prefix/*" ], "Condition": { "StringEquals": { "aws:SourceAccount": "111122223333" }, "ArnLike": { "aws:SourceArn": "arn:aws:codewhisperer:us-east-1:111122223333:*" } } } ] }

      如果在存储桶上配置 SSE-KMS,请在 KMS 密钥上添加以下策略:

      { "Effect": "Allow", "Principal": { "Service": "q.amazonaws.com" }, "Action": "kms:GenerateDataKey", "Resource": "*", "Condition": { "StringEquals": { "aws:SourceAccount": "accountId" }, "ArnLike": { "aws:SourceArn": "arn:aws:codewhisperer:region:accountId:*" } } }

      要了解如何保护 Amazon S3 存储桶中的数据,请参阅《Amazon Simple Storage Service 用户指南》中的利用加密来保护数据

启用提示日志记录
  1. 打开 Amazon Q 开发者版控制台。

    要使用 Amazon Q 开发者版控制台,您必须具备支持管理员使用 Amazon Q 开发者版控制台中定义的权限。

    注意

    您必须以独立账户管理员或管理账户管理员的身份登录。成员账户管理员无法启用提示日志记录,因为以成员账户订阅的用户不支持提示日志记录。

  2. 选择设置

  3. 首选项下,选择编辑

  4. 在“编辑偏好设置”窗口中,切换 Q 开发者版提示日志记录

  5. 在 Amazon S3 位置下,输入您将用于接收日志的 Amazon S3 URI。示例:s3://amzn-s3-demo-bucket/qdev-prompt-logs/