翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # 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 マスキングポリシーを使用して、ログでこのデータをマスキングすることもできます。詳細については、「[Help protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)」を参照してください。 ## サポートされているログの送信先 Amazon Quick は、次の宛先にログを配信できます。 + **Amazon CloudWatch Logs** - リアルタイムのモニタリングと分析用 + **Amazon S3** - 長期ストレージとバッチ処理用 + **Amazon Data Firehose** - ストリーミング分析とデータ変換用 ## 前提条件 ログ記録を有効にする前に、以下を確認してください。 + Enterprise または Professional サブスクリプションを持つアクティブな Amazon Quick インスタンス + ログ配信を設定するための適切な IAM アクセス許可 + ログ用に設定された送信先 (CloudWatch Logs、Amazon S3 バケット、または Firehose) ## のログ記録の設定 Amazon Quick Chat とフィードバックのログ記録を有効にするには、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`、`FEEDBACK_LOGS`、`INDEX_USAGE_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 Logs は、チャットログとフィードバックログのすべてのログタイプと特定のフィールドで共有される共通のフィールドを持つ構造化スキーマに従います。 ### 共通フィールド すべてのログイベントには、次の共通フィールドが含まれます。 + `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" } ``` ## エージェント/調査時間ログ このログタイプは、料金に使用されるクイックアカウント内のさまざまなエージェントの使用状況ログをキャプチャします。 + `subscription_type` - エンタープライズまたはプロフェッショナル + `reporting_service` - エージェントに対応するサービス: RESEARCH、FLOWS、AUTOMATIONS + `usage_group` - これまでのサブスクリプションタイプと使用状況`Included or Extra`に基づく + `usage_hours` - 特定のログインスタンスの使用時間を示す 10 進値 + `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)。 ## ナレッジベースのファイル同期ログ ナレッジベースのファイル同期ログは、ドキュメントごとの同期ステータスイベントをキャプチャします。同期実行ごとにドキュメントごとに 1 つのログレコードが出力されます。 + `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 ポリシーを実装する + **データ保持**: コンプライアンス要件に適した保持ポリシーを設定する