本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 使用 CloudWatch Logs 監控 Amazon Quick 用量 您可以使用 [Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) 在 Amazon Quick 中提供聊天對話、使用者意見回饋、客服人員/研究時數用量和索引儲存用量，供您分析。這些日誌可以傳送到多個目的地，例如 CloudWatch、Amazon S3 或 Amazon Data Firehose （適用標準費率）。建議您在啟用 Amazon Quick AI 功能後不久設定自動傳送的日誌。 以下是您可以使用 Amazon Quick 的日誌完成的任務範例： + 檢閱聊天訊息內容來識別常見的使用者查詢和困擾。 + 查看 `feedbackReason` 等指標來監控回應品質。 + 分析意見回饋資料來瞭解使用者情緒和滿意度，包括評論和實用性評分。 + 產生自訂儀表板和報告，以追蹤長期的關鍵指標和趨勢。 + 識別和分析聊天未傳回答案或使用者查詢遭到封鎖的案例 + 監控客服人員和研究時數用量 + 跨知識庫和空間追蹤索引儲存用量 + 追蹤知識庫同步操作，並識別文件編目或索引失敗 **重要** 對話日誌可能包含聊天中傳遞的敏感或個人身分識別資料。設定日誌訂閱時，您可以從日誌中篩選掉此資訊。或者您可以使用 CloudWatch Logs 遮罩政策在日誌上遮罩此資料。如需詳細資訊，請參閱[使用遮罩功能協助保護敏感日誌資料](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)。 ## 支援的日誌目的地 Amazon Quick 可以將日誌交付至下列目的地： + **Amazon CloudWatch Logs** - 用於即時監控和分析 + **Amazon S3** - 用於長期儲存和批次處理 + **Amazon Data Firehose** - 用於串流分析和資料轉換 ## 先決條件 在啟用記錄之前，請確定您有： + 具備企業或專業訂閱的作用中 Amazon Quick 執行個體 + 設定日誌交付的適當 IAM 許可 + 為您的日誌設定的目的地 (CloudWatch Logs、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 Logs，請使用下列 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 政策，請參閱《*Amazon CloudWatch Logs 使用者指南*》中的[從 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 Logs API 操作建立交付來源。為交付來源指定名稱，並為 `resourceArn` 指定應用程式 ARN。針對 `logType`，指定 `CHAT_LOGS`、`AGENT_HOURS_LOGS`、`INDEX_USAGE_LOGS`、 `FEEDBACK_LOGS`或 `KB_FILE_SYNC_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" } ``` ``` { "logType": "INDEX_USAGE_LOGS", "name": "my-quick-index-usage-delivery-source", "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id" } ``` ``` { "logType": "KB_FILE_SYNC_LOGS", "name": "my-quick-kb-file-sync-delivery-source", "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id" } ``` 若要使用 CloudWatch Logs API 操作啟用使用者對話記錄，您可以呼叫 `PutDeliverySource`、 `PutDeliveryDestination`和 `CreateDelivery` API 操作。 **注意** 日誌可供`PutDeliverySource`輸入中資源 ARN 中提到的區域使用。 ### 驗證日誌交付 設定完成後，請確認日誌已交付至您的目的地： + **驗證設定：**使用 CloudWatch Logs 中的 `DescribeDeliveries` API 驗證已在帳戶中建立的交付清單。 + **CloudWatch Logs**：檢查指定的日誌群組是否有新的日誌串流。 + **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*` - 是否啟用 Web 搜尋 + `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` - ENTERPRISE 或 PROFESSIONAL + `reporting_service` - 對應至代理程式的服務：RESEARCH、FLOWS 或 AUTOMATIONS + `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" } ``` ## 索引用量日誌 索引用量日誌會擷取知識庫和空間的每個來源儲存指標。每當發生變更 （建立、更新、同步或刪除） 時，就會發佈事件。 + `consumed_index_size` – 整個索引消耗的總大小 （以位元組為單位）。這是授權總數，而不是透過加總個別來源來計算。 + `source_type` – 來源類型： `SPACE`或 `KB`。 + `source_name` – 顯示空間或知識庫的名稱。 + `source_arn` – 來源的完整 ARN。 + `consumed_source_size` – 此個別來源消耗的大小 （以位元組為單位）。 + `consumed_source_doc_count` – 此來源中的文件數量。 以下是索引用量日誌的範例： ``` { "account_id": "111122223333", "event_timestamp": 1774911984257, "log_type": "INDEX_USAGE_LOGS", "user_arn": "arn:aws:quicksight::111122223333:user/default/user", "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333", "consumed_index_size": 500000, "source_type": "SPACE", "source_name": "my-space", "source_arn": "arn:aws:quicksight:us-west-2:111122223333:space/2744af89-31b2-423b-93a2-69b0cd0d7fa1", "consumed_source_size": 244436, "consumed_source_doc_count": 2 } ``` **注意** 事件會在變更時依來源發佈。並非所有來源都會每天發出事件。若要重建目前狀態，請使用每個 的最新事件`source_arn`。 如需有關建置儀表板和針對索引用量日誌執行查詢的資訊，請參閱 [監控索引儲存體用量](index-usage-monitoring.md)。 ## 知識庫檔案同步日誌 知識庫檔案同步日誌會擷取每個文件同步狀態事件。每次同步執行每個文件會發出一個日誌記錄。 + `document_id` – 原始文件識別符，例如 URL 或檔案路徑。 + `document_title` – 文件標題。 + `document_status` – 終端機文件狀態。值：`ADDED`、`MODIFIED`、`UNMODIFIED`、`DELETED`、`SKIPPED`、`FAILED`。 + `sync_result` – 高階可用性結果。值： `AVAILABLE`或 `UNAVAILABLE`。 + `sync_id` – 同步任務執行 ID。 + `data_source_id` – 知識庫所連線之資料來源的識別符。 + `source_uri` – 文件的來源 URL。 + `error_message` – 狀態為 `FAILED`或 時的錯誤描述`SKIPPED`。 + `error_mitigation` – 解決錯誤的可行指引。 + `error_type` – 狀態為 `FAILED`或 時的錯誤碼`SKIPPED`。 + `knowledge_base_id` – 產生日誌之知識庫的 UUID。 下表說明`document_status`值及其對應的 `sync_result`。 | document\_status | sync\_result | 意義 | | --- | --- | --- | | ADDED | AVAILABLE | 新文件已成功編製索引 | | MODIFIED | AVAILABLE | 以變更重新編製索引的現有文件 | | UNMODIFIED | AVAILABLE | 文件內容不變，不需要重新編製索引 | | DELETED | UNAVAILABLE | 從索引移除的文件 | | SKIPPED | UNAVAILABLE | 爬蟲期間篩選的文件，例如 robots.txt 或大小限制 | | FAILED | UNAVAILABLE | 文件在編目或編製索引期間失敗 | 下列範例顯示成功的知識庫檔案同步日誌，其中文件已新增至知識庫： ``` { "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333", "event_timestamp": 1781296858575, "log_type": "KB_FILE_SYNC_LOGS", "account_id": "111122223333", "document_id": "https://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.html", "document_title": "Monitoring Amazon QuickSight usage using CloudWatch Logs", "document_status": "ADDED", "sync_result": "AVAILABLE", "sync_id": "86a70a9a-cad9-4fc6-8881-e3909c8954d2", "data_source_id": "56225744-18bc-4373-a91f-861dd1c3d566", "source_uri": "https://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.html", "knowledge_base_id": "b0bd0a47-8095-439d-9dff-c64bd5fe3fa3" } ``` 下列範例顯示略過的文件日誌，其中由於驗證錯誤而略過爬取： ``` { "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333", "event_timestamp": 1781296492951, "log_type": "KB_FILE_SYNC_LOGS", "account_id": "111122223333", "document_id": "https://docs.aws.amazon.com/quick/latest/userguide/blocked-page.html", "document_title": "Blocked Page", "document_status": "SKIPPED", "sync_result": "UNAVAILABLE", "sync_id": "86a70a9a-cad9-4fc6-8881-e3909c8954d2", "data_source_id": "56225744-18bc-4373-a91f-861dd1c3d566", "source_uri": "https://docs.aws.amazon.com/quick/latest/userguide/blocked-page.html", "error_message": "This URL wasn't crawled because crawling isn't allowed by its robots.txt file.", "error_mitigation": "Contact the website administrator for assistance.", "error_type": "VALIDATION_ERROR", "knowledge_base_id": "b0bd0a47-8095-439d-9dff-c64bd5fe3fa3" } ``` **注意** \* 根據預設，標記為「\*」的欄位不會新增至您的日誌訂閱。如有需要，在呼叫 CreateDelivery 時需要明確指定這些項目。 ## 安全考量 + **加密**：針對敏感資料使用客戶受管 AWS KMS 金鑰 + **存取控制**：實作最低權限的 IAM 政策 + **資料保留**：為您的合規要求設定適當的保留政策