AWS quick documentation change
Summary
Added documentation for new 'INDEX_USAGE_LOGS' log type to monitor index storage usage for knowledge bases and Spaces, including log schema, example configuration, and usage notes.
Security assessment
This change adds documentation for a new monitoring feature (INDEX_USAGE_LOGS) that tracks storage metrics for knowledge bases and Spaces. While not addressing a specific security vulnerability, enhanced logging capabilities contribute to security posture by enabling better audit trails, resource monitoring, and anomaly detection for AI service usage. The change expands existing logging infrastructure without indicating any security incident.
Diff
diff --git a/quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.md b/quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.md index cb89ee249..729dd6512 100644 --- a//quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.md +++ b//quick/latest/userguide/monitoring-quicksuite-chat-feedback-cloudwatch.md @@ -7 +7 @@ -Supported log destinationsPrerequisitesConfigure loggingLog schema and formatAgent/Research hours LogsSecurity considerations +Supported log destinationsPrerequisitesConfigure loggingLog schema and formatAgent/Research hours LogsIndex usage logsSecurity considerations @@ -11 +11 @@ Supported log destinationsPrerequisitesConfigure loggingLog schema and formatAge -You can use [Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) to deliver chat conversations, user feedback and agent/research hours usage in Amazon Quick for you to analyze. These logs can be delivered to multiple destinations, such as CloudWatch, Amazon S3, or Amazon Data Firehose (standard rates apply). We recommend that you set up vended logs shortly after enabling Amazon Quick AI features. +You can use [Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) to deliver chat conversations, user feedback, agent/research hours usage, and index storage usage in Amazon Quick for you to analyze. These logs can be delivered to multiple destinations, such as CloudWatch, Amazon S3, or Amazon Data Firehose (standard rates apply). We recommend that you set up vended logs shortly after enabling Amazon Quick AI features. @@ -26,0 +27,2 @@ The following are examples of tasks you can complete with logs from Amazon Quick + * Track index storage usage across knowledge bases and Spaces + @@ -114 +116 @@ For example IAM policies with all the required permissions for your specific log -Create a delivery source with the [PutDeliverySource](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) CloudWatch Logs API operation. Give the delivery source a name and for `resourceArn`, specify the ARN of your application. For `logType`, specify `CHAT_LOGS`, `AGENT_HOURS_LOGS` or `FEEDBACK_LOGS` +Create a delivery source with the [PutDeliverySource](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html) CloudWatch Logs API operation. Give the delivery source a name and for `resourceArn`, specify the ARN of your application. For `logType`, specify `CHAT_LOGS`, `AGENT_HOURS_LOGS`, `FEEDBACK_LOGS`, or `INDEX_USAGE_LOGS`. @@ -136,0 +139,7 @@ Create a delivery source with the [PutDeliverySource](https://docs.aws.amazon.co + + { + "logType": "INDEX_USAGE_LOGS", + "name": "my-quick-index-usage-delivery-source", + "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id" + } + @@ -316,0 +326,42 @@ The following is an example of Agent Hours logs: +## Index usage logs + +Index usage logs capture per-source storage metrics for knowledge bases and Spaces. Events are published whenever a change occurs (created, updated, synced, or deleted). + + * `consumed_index_size` – Total size (in bytes) consumed by the entire index. This is the authoritative total, not computed by summing individual sources. + + * `source_type` – Type of source: `SPACE` or `KB`. + + * `source_name` – Display name of the Space or knowledge base. + + * `source_arn` – Full ARN of the source. + + * `consumed_source_size` – Size (in bytes) consumed by this individual source. + + * `consumed_source_doc_count` – Number of documents in this source. + + + + +The following is an example of index usage logs: + + + { + "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 + } + +###### Note + +Events are published per source on change. Not all sources emit events every day. To reconstruct the current state, use the most recent event per `source_arn`. + +For information about building dashboards and running queries against index usage logs, see [Monitor index storage usage](./index-usage-monitoring.html). +