本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用 CloudWatch 日志监控 Amazon Quick 的使用情况
您可以使用 [Amazon CloudWatch Log](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) s 在 Amazon Quick 中提供聊天对话、用户反馈和 agent/research 工时使用情况，供您分析。这些日志可以传送到多个目的地，例如 CloudWatch Amazon S3 或 Amazon Data Firehose（适用标准费率）。我们建议您在启用 Amazon Quick AI 功能后立即设置销售日志。
以下是您可以使用 Amazon Quick 中的日志完成的任务示例：
+ 通过查看聊天消息内容，找出常见的用户查询和难点。
+ 通过查看 `feedbackReason` 等指标来监控回复的质量。
+ 通过分析反馈数据（包括评论和有用性评级）来了解用户的情绪和满意度。
+ 生成自定义控制面板和报告，以跟踪一段时间内的关键指标和趋势。
+ 识别并分析聊天未返回答案或用户查询被屏蔽的情况
+ 监控代理和研究时间的使用情况
**重要**
源自对话的日志可能包含聊天中传递的敏感信息或个人身份数据。在设置日志订阅时，您可以从日志中筛选出这些信息。或者，您可以使用日志屏蔽策略屏蔽 CloudWatch 日志中的这些数据。有关更多信息，请参阅 [Help protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)。
## 支持的日志目标
Amazon Quick 可以将日志传送到以下目的地：
+ **Amazon CloudWatch 日志**-用于实时监控和分析
+ **Amazon S3**-用于长期存储和批处理
+ **Amazon Data Firehose**-用于流媒体分析和数据转换
## 先决条件
在启用日志记录之前，请确保您已具备以下条件：
+ 具有企业版或专业版订阅的活跃 Amazon Quick 实例
+ 配置日志传输的相应 IAM 权限
+ 为您的日志配置的目的地（日CloudWatch 志、Amazon S3 存储桶或 Firehose）
## 配置 日志记录
要启用 Amazon Quick 聊天和反馈的日志记录，您需要配置 IAM 权限，创建传送源和目标，并验证日志是否已成功传送。
**Topics**
+ [设置 IAM 权限](#quicksuite-chat-feedback-setup-iam-permissions)
+ [配置日志订阅](#quicksuite-chat-feedback-configure-log-subscription)
+ [验证日志传送](#quicksuite-chat-feedback-verify-log-delivery)
### 设置 IAM 权限
要为 Amazon Quick 设置 CloudWatch 日志，请使用以下 IAM 策略示例来授予必要的权限。
```
{
"Version": "2012-10-17" ,
"Statement": [{
"Sid": "QuicksightLogDeliveryPermissions",
"Effect": "Allow",
"Action": "quicksight:AllowVendedLogDeliveryForResource",
"Resource": "arn:aws:quicksight:region:account-id:account/account-id"
}]
}
```
您还必须在客户托管 AWS KMS 密钥策略中允许`delivery.logs.amazonaws.com`服务主体。
```
{
"Effect": "Allow" ,
"Principal": {
"Service": "delivery.logs.amazonaws.com"
},
"Action": [
"kms:GenerateDataKey",
"kms:Decrypt"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"kms:EncryptionContext:SourceArn": "arn:partition:logs:region:account-id:*"
}
}
}
```
### 配置日志订阅
例如，具有特定日志目标所需的所有权限的 IAM 策略，请参阅 A *mazon [Log CloudWatch s 用户指南中的启用 AWS 服务](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html)日志*记录。
使用[PutDeliverySource](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) CloudWatch 日志 API 操作创建传送源。为传输来源命名，然后为 `resourceArn` 指定应用程序的 ARN。对于`logType``CHAT_LOGS`、指定`AGENT_HOURS_LOGS`或 `FEEDBACK_LOGS`
```
{
"logType": "CHAT_LOGS",
"name": "my-quick-suite-delivery-source",
"resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}
```
```
{
"logType": "FEEDBACK_LOGS",
"name": "my-quick-suite-delivery-source",
"resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}
```
```
{
"logType": "AGENT_HOURS_LOGS",
"name": "my-quick-suite-delivery-source",
"resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}
```
要使用 CloudWatch 日志 API 操作启用用户对话日志记录，请调用`PutDeliverySource``PutDeliveryDestination`、和 `CreateDelivery` API 操作。
**注意**
将提供输入中资源 ARN 中提及的区域的日志。`PutDeliverySource`
### 验证日志传送
配置完成后，请验证日志是否已传送到您的目的地：
+ **验证设置：**使用 CloudWatch 日志中的 `DescribeDeliveries` API 验证账户中已创建的交付列表。
+ **CloudWatch 日志**：检查指定的日志组中是否有新的日志流。
+ **Amazon S3**：监控您的存储桶中是否有新的日志文件。
+ **Firehose**：验证数据是否流经您的交付流。
## 日志架构和格式
Amazon Quick 日志遵循结构化架构，所有日志类型共享公共字段，聊天和反馈日志的特定字段。
### 通用字段
所有日志事件都包含以下常用字段：
+ `resource_arn`-您的 Amazon Quick 账户的资源 ARN（例如，）`arn:aws:quicksight:us-east-1:111122223333:account/111122223333:`
+ `event_timestamp`-事件的 ISO 8601 时间戳（例如，）`1763532110061`
+ `logType`-日志类型（例如，`Chat`或`Feedback`）
+ `accountId`- AWS 账户 ID（例如，`123456789012`）
+ `user_arn`-与事件关联的 Amazon Quick 用户 ARN（例如，）`"arn:aws:quicksight:us-west-2:111122223333:user/default/user"`
### 聊天日志
聊天记录会话互动并包含以下字段：
+ `status_code`-聊天请求的状态（例如，`Success, request_blocked, no_answer_found`）
+ `namespace*`-事件的 Amazon Quick 命名空间（例如，`default`）
+ `user_type`-与事件关联的 Amazon Quick 用户类型（例如，`ADMIN_PRO`）
+ `conversation_id`-用户对话的唯一 ID
+ `system_message_id`-系统生成的消息 ID
+ `latency*`-聊天消息延迟（以毫秒为单位）
+ `time_to_first_token*`-第一个响应令牌的时间（以毫秒为单位）
+ `message_scope`-消息的范围（例如，`all_resources, specific_resources, no_resources`）
+ `user_message_id`-用户消息的唯一 ID
+ `user_message`-对话中的用户消息
+ `agent_id`-聊天代理的唯一 ID
+ `flow_id`-Amazon Quick Flow 的唯一 ID
+ `system_text_message`-对话中的系统响应
+ `surface_type*`-正在使用应用程序进行对话
+ `web_search*`-网络搜索是否启用
+ `user_selected_resources`-用户选择的资源列表
+ `action_connectors`-动作连接器列表
+ `cited_resource`-被引资源清单
+ `file_attachment`-用户附加的文件清单
以下是聊天日志的示例：
```
{
"status_code": "success",
"namespace": "default",
"user_type": "ADMIN_PRO",
"conversation_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"system_message_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"latency": "10000",
"time_to_first_token": "10000",
"message_scope": "all_resources",
"user_message_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"user_message": "Hi chat",
"agent_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"flow_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d?",
"system_text_message": "Hello user",
"surface_type": "WEB_EXPERIENCE",
"web_search": "true"
"user_selected_resources": [{"resource_type": "Dashboard","resource_id": "146abs-1222-534894"},{"resource_type": "Space","resource_id": "123abs-1234-534894"}],
"action_connectors": [{"action_connector_id": "quicksight-website"},{"action_connector_id": "123abs-1234-534894"}]
"cited_resource": [{"cited_resource_name": "Dashboard","cited_resource_id": "146abs-1222-534894","cited_resource_name": "ds1"},{"cited_resource_name": "Space","cited_resource_id": "123abs-1234-534894","cited_resource_name": "space1"}],
"file_attachment": [{"file_attachmet_type": "pdf","file_attachment_name": "file1.pdf"},{"file_attachmet_type": "txt","file_attachment_name": "file2.txt"}]
}
```
### 反馈日志
反馈日志记录了用户对聊天的反馈，并包含以下字段：
+ `status_code`-活动交付状态
+ `namespace*`-事件的 Amazon Quick 命名空间（例如，`default`）
+ `user_type`-与事件关联的 Amazon Quick 用户类型（例如，`ADMIN_PRO`）
+ `conversation_id`-对话的唯一 ID
+ `system_message_id`-系统生成的消息 ID
+ `user_message_id`-用户消息的唯一 ID
+ `feedback_type`-反馈类型（例如，`Not Useful, Useful`）
+ `feedback_reason`-用户选择的反馈原因
+ `feedback_details`-（可选）用户提供的其他详细信息
以下是反馈日志的示例：
```
{
"status_code": "success",
"namespace": "default",
"user_type": "ADMIN_PRO",
"conversation_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"system_message_id": "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"user_message_id" : "a11b2bbc-c123-3abc-a12b-12a34b5c678d",
"feedback_type" :"Not Useful / Useful"
"feedback_reason" : "Too wordy,Issue with sources,Other etc."
"feedback_details" : "additional text shared by user"
}
```
## 代理/研究时间日志
此日志类型捕获用于定价的 Quick 账户中不同代理的使用日志：
+ `subscription_type`-企业版或专业版
+ `reporting_service`-与代理对应的服务：研究、流程或自动化
+ `usage_group`-`Included or Extra` 基于迄今为止的订阅类型和使用情况
+ `usage_hours`-表示特定日志实例使用时间的十进制值
+ `service_resource_arn`-相应代理服务的 ARN
以下是座席工作时间日志的示例：
```
{
"subscription_type": "ENTERPRISE",
"reporting_service": "RESEARCH",
"usage_group": "Included",
"usage_hours": 0.3333,
"service_resource_arn": "arn:aws:quicksight:eu-west-1:111222333444:research/a11b2bbc-c123-3abc-a12b-12a34b5c678d"
}
```
**注意**
\$1 默认情况下，标有 “\$1” 的字段不会添加到您的日志订阅中。 CreateDelivery 如果需要，需要在调用时明确指定这些内容。
## 安全注意事项
+ **加密**：对敏感数据使用客户管理的 AWS KMS 密钥
+ **访问控制**：实施最低权限的 IAM 策略
+ **数据保留**：根据您的合规性要求配置适当的保留策略