# Incident response, logging, and monitoring in Amazon Quick
| |
| --- |
| Intended audience: System administrators and Amazon Quick administrators |
Effective incident response, logging, and monitoring are essential for maintaining the security, performance, and reliability of your Amazon Quick instance. This monitoring framework provides multiple layers of visibility into user activities, system performance, security events, and operational metrics across all Amazon Quick features including chat, spaces, flows, actions, research, dashboards, and custom agents.
Amazon Quick integrates with AWS native monitoring and logging services to provide both real-time insights and historical analysis capabilities. The monitoring system captures detailed analytics on user engagement, conversation patterns, resource utilization, and security-related events, while CloudTrail logging ensures complete audit trails for compliance and forensic analysis.
This section covers:
+ **Analytics and monitoring** - Comprehensive dashboards and metrics for tracking user adoption, performance, feedback, and security events across all Amazon Quick capabilities
+ **CloudTrail logging** - Complete audit trails of API calls and administrative actions for compliance and security monitoring in Amazon Quick Sight
+ **Non-API event logging** - Monitoring of user interactions, content access, and system events that don't generate API calls
+ **Log analysis and interpretation** - Understanding log entries, identifying security incidents, and responding to operational issues in Amazon Quick Sight
Whether you're investigating a security incident, analyzing user behavior patterns, measuring system performance, or ensuring regulatory compliance, these monitoring and logging capabilities provide the visibility and data you need to maintain a secure and well-functioning Amazon Quick environment.
**Topics**
+ [Monitoring Amazon Quick usage using CloudWatch Logs](monitoring-quicksuite-chat-feedback-cloudwatch.md)
+ [Incident response, logging, and monitoring in Amazon Quick Sight using CloudTrail](incident-response-logging-and-monitoring-qs.md)
+ [Monitoring data in Amazon Quick Sight using CloudWatch](monitoring-quicksight.md)
# Monitoring Amazon Quick usage using CloudWatch Logs
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.
The following are examples of tasks you can complete with logs from Amazon Quick:
+ Identify common user queries and pain points by reviewing the chat message content.
+ Monitor the quality of responses by looking at metrics like `feedbackReason`.
+ Understand user sentiment and satisfaction by analyzing the feedback data, including comments and usefulness ratings.
+ Generate custom dashboards and reports to track key metrics and trends over time.
+ Identify and Analyze cases where the chat returned no answer or the user query was blocked
+ Monitor agent and research hours usage
**Important**
Logs from conversations might include sensitive or personally identifiable data passed in the chats. You can filter out this information from your logs when setting up logs subscription. Or you can mask this data on your logs using CloudWatch Logs masking policies. For more information, see [Help protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).
## Supported log destinations
Amazon Quick can deliver logs to the following destinations:
+ **Amazon CloudWatch Logs** - For real-time monitoring and analysis
+ **Amazon S3** - For long-term storage and batch processing
+ **Amazon Data Firehose** - For streaming analytics and data transformation
## Prerequisites
Before you can enable logging, ensure you have:
+ An active Amazon Quick instance with Enterprise or Professional subscriptions
+ Appropriate IAM permissions to configure log delivery
+ A destination configured for your logs (CloudWatch Logs, Amazon S3 bucket, or Firehose)
## Configure logging
To enable logging for Amazon Quick chat and feedback, you need to configure IAM permissions, create a delivery source and destination, and verify that logs are being delivered successfully.
**Topics**
+ [Set up IAM permissions](#quicksuite-chat-feedback-setup-iam-permissions)
+ [Configure log subscription](#quicksuite-chat-feedback-configure-log-subscription)
+ [Verify log delivery](#quicksuite-chat-feedback-verify-log-delivery)
### Set up IAM permissions
To set up CloudWatch Logs for Amazon Quick, use the following IAM policy examples to grant the necessary permissions.
```
{
"Version": "2012-10-17" ,
"Statement": [{
"Sid": "QuicksightLogDeliveryPermissions",
"Effect": "Allow",
"Action": "quicksight:AllowVendedLogDeliveryForResource",
"Resource": "arn:aws:quicksight:region:account-id:account/account-id"
}]
}
```
You must also allow the `delivery.logs.amazonaws.com` service principal in your customer managed AWS KMS key policy.
```
{
"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:*"
}
}
}
```
### Configure log subscription
For example IAM policies with all the required permissions for your specific logging destination, see [Enable logging from AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) in the *Amazon CloudWatch Logs User Guide*.
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`
```
{
"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"
}
```
To enable user conversation logging with the CloudWatch Logs API operations, you call the `PutDeliverySource`, `PutDeliveryDestination`, and `CreateDelivery` API operations.
**Note**
Logs would be available for the region mentioned in resource ARN in `PutDeliverySource` input.
### Verify log delivery
Once configured, verify that logs are being delivered to your destination:
+ **Verify the setup:** Verify the list of deliveries that have been created in the account by using the `DescribeDeliveries` API in CloudWatch Logs.
+ **CloudWatch Logs**: Check the specified log group for new log streams.
+ **Amazon S3**: Monitor your bucket for new log files.
+ **Firehose**: Verify data is flowing through your delivery stream.
## Log schema and format
Amazon Quick logs follow a structured schema with common fields shared across all log types and specific fields for chat and feedback logs.
### Common fields
All log events include these common fields:
+ `resource_arn` - Resource ARN of your Amazon Quick account (for example, `arn:aws:quicksight:us-east-1:111122223333:account/111122223333:`)
+ `event_timestamp` - ISO 8601 timestamp of the event (for example, `1763532110061`)
+ `logType` - Type of log (for example, `Chat` or `Feedback`)
+ `accountId` - AWS account ID (for example, `123456789012`)
+ `user_arn` - Amazon Quick user ARN associated with the event (for example, `"arn:aws:quicksight:us-west-2:111122223333:user/default/user"`)
### Chat logs
Chat logs capture conversation interactions and contains below fields:
+ `status_code` - Status of the chat request (for example, `Success, request_blocked, no_answer_found` )
+ `namespace*` - Amazon Quick namespace for the event (for example, `default`)
+ `user_type` - Amazon Quick user type associated with the event (for example, `ADMIN_PRO`)
+ `conversation_id` - Unique ID for the user conversation
+ `system_message_id` - System-generated message ID
+ `latency*` - Chat message latency in milliseconds
+ `time_to_first_token*` - Time in milliseconds of first response token
+ `message_scope` - Scope of the message (for example, `all_resources, specific_resources, no_resources` )
+ `user_message_id` - Unique ID of the user message
+ `user_message` - user message in the conversation
+ `agent_id` - Unique ID of the chat agent
+ `flow_id` - Unique ID of the Amazon Quick Flow
+ `system_text_message` - System response in the conversation
+ `surface_type*` - Application being used for the conversation
+ `web_search*` - Web search enabled or not
+ `user_selected_resources`- List of resources selected by user
+ `action_connectors` - List of action connectors
+ `cited_resource` - List of cited resources
+ `file_attachment` - List of files attached by user
The following is an example of chat logs:
```
{
"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"}]
}
```
### Feedback logs
Feedback logs capture user feedback on chat and contains below fields:
+ `status_code` - Status of the event delivery
+ `namespace*` - Amazon Quick namespace for the event (for example, `default`)
+ `user_type` - Amazon Quick user type associated with the event (for example, `ADMIN_PRO`)
+ `conversation_id` - Unique ID of the conversation
+ `system_message_id` - System generated message ID
+ `user_message_id` - Unique ID of user message
+ `feedback_type` - Type of feedback (for example, `Not Useful, Useful` )
+ `feedback_reason` - Feedback reason selected by the user
+ `feedback_details` - (Optional) Additional details provided by the user
The following is an example of feedback logs:
```
{
"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"
}
```
## Agent/Research hours Logs
This log type captures the usage logs for different agents within your Quick account used for pricing:
+ `subscription_type` - ENTERPRISE or PROFESSIONAL
+ `reporting_service` - Service corresponding to the agent: RESEARCH, FLOWS OR AUTOMATIONS
+ `usage_group` - `Included or Extra` based on the subscription type and usage so far
+ `usage_hours` - Decimal value indicating the usage hours for the particular log instance
+ `service_resource_arn` - ARN of the corresponding Agent’s service
The following is an example of Agent Hours logs:
```
{
"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"
}
```
**Note**
\$1 Fields marked with ‘\$1’ do not get added by default to your log subscription. These need to be specified explicitly while calling CreateDelivery if required.
## Security considerations
+ **Encryption**: Use customer-managed AWS KMS keys for sensitive data
+ **Access control**: Implement least-privilege IAM policies
+ **Data retention**: Configure appropriate retention policies for your compliance requirements
# Incident response, logging, and monitoring in Amazon Quick Sight using CloudTrail
Amazon Quick Sight is integrated with AWS CloudTrail. This service provides a record of actions taken by a user, role, or an AWS service in Amazon Quick Sight. CloudTrail captures all API calls for Amazon Quick Sight as events. The calls captured include some calls from the Amazon Quick Sight console and all code calls to Amazon Quick Sight API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon Quick Sight. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**. Using the information collected by CloudTrail, you can determine the request that was made to Amazon Quick Sight, the IP address from which the request was made, who made the request, when it was made, and additional details.
Amazon Quick Sight doesn’t natively support alerting with Amazon CloudWatch or other external systems. However, it's possible to develop a custom solution to process CloudTrail logs.
Amazon Quick Sight service status can be viewed on the [Service Health Dashboard](https://status.aws.amazon.com/).
By default, the log files delivered by CloudTrail to your bucket are encrypted by Amazon [server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html). To provide a security layer that is directly manageable, you can instead use [server-side encryption with AWS KMS–managed keys (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) for your CloudTrail log files. Enabling server-side encryption encrypts the log files but not the digest files with SSE-KMS. Digest files are encrypted with [Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html).
To learn more about CloudTrail, including how to configure and enable it, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/).
**Topics**
+ [Logging Amazon Quick Sight information with AWS CloudTrail](#logging-using-cloudtrail)
+ [Tracking non-API events by using CloudTrail logs](#logging-non-api)
+ [Example: Amazon Quick Sight log file entries](#understanding-quicksight-entries)
## Logging Amazon Quick Sight information with AWS CloudTrail
| |
| --- |
| Intended audience: System administrators |
CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in Amazon Quick Sight, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**. You can view, search, and download recent events in your AWS account. For more information, see [Viewing Events with CloudTrail Event History](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html).
For an ongoing record of events in your AWS account, including events for Amazon Quick Sight, create a trail. A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all . The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following:
+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations)
+ [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html)
+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
+ [Cross-Account CloudTrail Logging](https://docs.aws.amazon.com/lake-formation/latest/dg/cross-account-logging.html) in the AWS Lake Formation Developer Guide Guide – This topic includes instructions for including principal identities in cross-account CloudTrail logs.
Amazon Quick Sight supports logging the following actions as events in CloudTrail log files:
+ Whether the request was made with root or AWS Identity and Access Management user credentials
+ Whether the request was made with temporary security credentials for an IAM role or federated user
+ Whether the request was made by another AWS service
For more information on user identity, see the [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html).
By default, each Amazon Quick Sight log entry contains the following information:
+ **userIdentity** – User identity
+ **eventTime** – Event time
+ **eventId** – Event Id
+ **readOnly** – Read only
+ **awsRegion** – AWS Region
+ **eventSource (quicksight)** – Source of the event (Amazon Quick Sight)
+ **eventType (AwsServiceEvent)** – Event type (AWS service event)
+ **recipientAccountId (customer AWS account)** – Recipient account ID (Customer AWS account)
**Note**
CloudTrail displays users as `unknown` if they were provisioned by Amazon Quick Sight. This display is because these users aren't a known IAM identity type.
## Tracking non-API events by using CloudTrail logs
Following is a list of the non-API events you can track.
**User management**
+ **CreateAccount** – Create Account
+ **BatchCreateUser** – Create User
+ **BatchResendUserInvite** – Invite User
+ **UpdateGroups** – Update Groups
This event works with Enterprise edition only.
+ **UpdateSpiceCapacity** – Update SPICE Capacity
+ **DeleteUser** – Delete User
+ **Unsubscribe** – Unsubscribe User
**Subscription**
+ **CreateSubscription** – Create Subscription
+ **UpdateSubscription** – Update Subscription
+ **DeleteSubscription** – Delete Subscription
**Dashboard**
+ **GetDashboard** – Get Dashboard
+ **CreateDashboard** – Create Dashboard
+ **UpdateDashboard** – Update Dashboard
+ **UpdateDashboardAccess** – Update Dashboard Access
+ **DeleteDashboard** – Delete Dashboard
**Analysis**
+ **GetAnalysis** – Get Analysis
+ **CreateAnalysis** – Create Analysis
+ **UpdateAnalysisAccess** – Update Analysis Access
+ **UpdateAnalysis** – Update Analysis
+ **RenameAnalysis** – Rename Analysis
+ **CreateVisual** – Create Visual
+ **RenameVisual** – Rename Visual
+ **DeleteVisual** – Delete Visual
+ **DeleteAnalysis** – Delete Analysis
**Data source**
+ **CreateDataSource** – Create Data Source
+ **FlatFile** – Flat file
+ **External** – External
+ **S3** – S3
+ **ImportS3ManifestFile** – S3 Manifest File
+ **Presto** – Presto
+ **RDS** – RDS
+ **Redshift** – Redshift (manual)
+ **UpdateDataSource** – Update Data Source
+ **DeleteDataSource** – Delete Data Source
**Data set**
+ **CreateDataSet** – Create Data Set
+ **CustomSQL** – Custom SQL
+ **SQLTable** – SQL Table
+ **File** – CSV or XLSX
+ **UpdateDataSet** – Update SQL Join Dataset
+ **UpdateDatasetAccess** – Update Dataset Access
+ **DeleteDataSet** – Delete Dataset
+ **Querydatabase** – During a dataset refresh, query data source.
## Example: Amazon Quick Sight log file entries
A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order.
The following example shows a CloudTrail log entry that demonstrates the BatchCreateUser action.
```
{
"eventVersion":"1.05",
"userIdentity":
{
"type":"Root",
"principalId":"123456789012",
"arn":"arn:aws:iam::123456789012:root",
"accountId":"123456789012",
"userName":"test-username"
},
"eventTime":"2017-04-19T03:16:13Z",
"eventSource":"quicksight.amazonaws.com",
"eventName":"BatchCreateUser",
"awsRegion":"us-west-2",
"requestParameters":null,
"responseElements":null,
"eventID":"e7d2382e-70a0-3fb7-9d41-a7a913422240",
"readOnly":false,
"eventType":"AwsServiceEvent",
"recipientAccountId":"123456789012",
"serviceEventDetails":
{
"eventRequestDetails":
{
"users":
{
"test-user-11":
{
"role":"USER"
},
"test-user-22":
{
"role":"ADMIN"
}
}
},
"eventResponseDetails":
{
"validUsers":[
],
"InvalidUsers":[
"test-user-11",
"test-user-22"
]
}
}
}
```
# Monitoring data in Amazon Quick Sight using CloudWatch
Amazon Quick sends metrics to Amazon CloudWatch that you can use to observe and respond to the availability and performance of your Amazon Quick environment in near real time. Currently, you can monitor metrics for Amazon Quick Sight dashboards, visuals, and dataset ingestions, as well as unstructured datasets and Quick Action Connectors, to provide your readers with a consistent, high-performing, and uninterrupted experience experience on Amazon Quick.
For more information about using Amazon CloudWatch, see the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com//AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).
## Accessing Quick metrics in Amazon CloudWatch
Use the following procedure to access Amazon Quick metrics in Amazon CloudWatch.
**To access Amazon Quick metrics in CloudWatch**
1. Sign in to the AWS account that's associated with your Amazon Quick account.
1. In the upper-left corner of the AWS Management Console home page, choose **Services**, and then choose **CloudWatch**.
1. In the navigation pane, choose **Metrics**, **All metrics**, **QuickSight**.
**Topics**
+ [Graph metrics with the Amazon CloudWatch console](#cw-graph)
+ [Creating alarms with the Amazon CloudWatch console](#cw-alerts)
+ [Metrics](#cw-metrics)
+ [Aggregate metrics](#cw-aggregate-metrics)
+ [Aggregate SPICE metrics](#aggregate-spice-metrics)
+ [Dimensions](#cw-dimensions)
### Graph metrics with the Amazon CloudWatch console
You can also use the Amazon CloudWatch console to graph metric data generated by Quick. For more information, see [Graphing metrics](https://docs.aws.amazon.com//AmazonCloudWatch/latest/monitoring/graph_metrics.html) in the *Amazon CloudWatch User Guide.*
### Creating alarms with the Amazon CloudWatch console
You can create a Amazon CloudWatch alarm that monitors CloudWatch metrics for your Quick assets. When the metric reaches a threshold that you specify, CloudWatch automatically sends you a notification. For examples, see [Creating Amazon CloudWatch alarms](https://docs.aws.amazon.com//AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html) in the *Amazon CloudWatch User Guide*.
### Metrics
The `AWS/QuickSight` namespace includes the following metrics for monitoring traffic and latency of your Amazon Quick assets.
**Topics**
+ [Per-dashboard metrics](#per-dashboard-metrics)
+ [Per-dataset ingestion metrics](#per-ingestion-metrics)
+ [Per-visual metrics](#per-visual-metrics)
+ [Per-unstructured dataset metrics](#per-unstructured-dataset-metrics)
+ [Per-action connector metrics](#per-action-connector-metrics)
#### Per-dashboard metrics
The following metrics track dashboard view counts and load times. You can find these metrics under the `AWS/QuickSight/Dashboard Metrics` group in CloudWatch.
| Metric | Description | Dimension | Unit |
| --- | --- | --- | --- |
| DashboardViewCount | The number of times that a dashboard has been viewed. This number includes all access patterns such as web, mobile, and embedded. The most useful statistic for this metric is `SUM`, which represents the total number of dashboard views during a set period of time. | DashboardId | Count |
| DashboardViewLoadTime | The amount of time that it takes for a Amazon Quick Sight dashboard to load. The measurement begins when a user reaches the Amazon Quick Sight dashboard and ends when all of the dashboard's visuals finish rendering. The most useful statistic for this metric is `AVERAGE`, which represents the average load time of a Amazon Quick Sight dashboard during a set period of time. | DashboardId | Millisecond |
#### Per-dataset ingestion metrics
The following metrics track ingestions for specific [SPICE](https://docs.aws.amazon.com/quicksight/latest/user/spice.html) datasets. You can find these metrics under the `AWS/QuickSight/Ingestion Metrics` group in CloudWatch.
| Metric | Description | Dimension | Unit |
| --- | --- | --- | --- |
| IngestionErrorCount | The number of failed ingestions. The most useful statistic for this metric is `SUM`, which represents the total number of failed ingestions during a set period of time. | DatasetId | Count |
| IngestionInvocationCount | The number of ingestions that have been initiated. This includes scheduled and manual ingestions that are initiated through the console and the Amazon Quick Sight API operations. The most useful statistic for this metric is `SUM`, which represents the total number of ingestions initiated during a set period of time. | DatasetId | Count |
| IngestionLatency | The time period between the initiation of an ingestion to the completion of the ingestion. The most useful statistic for this metric is `AVERAGE`, which represents the average runtime of ingestions during a set period of time. | DatasetId | Second |
| IngestionRowCount | The number of successful row ingestions. The most useful statistic for this metric is `SUM`, which represents the total amount of data ingested during a set period of time. | DatasetId | Count |
#### Per-visual metrics
The following metrics track the load times and error counts of individual visuals on a Amazon Quick Sight dashboard. You can find these metrics under the `AWS/QuickSight/Visual Metrics` group in CloudWatch.
| Metric | Description | Dimension | Unit |
| --- | --- | --- | --- |
| VisualLoadTime | The time that it takes for a Amazon Quick Sight visual to receive the necessary query data for an initial paint of the visual. This includes the round-trip query time from the client, to the Amazon Quick Sight service, and then back to client. The most useful statistic for this metric is `AVERAGE`, which represents the average load time of a visual during a set period of time. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Millisecond |
| VisualLoadErrorCount | The number of times that a Amazon Quick Sight visual fails to complete a data query for the initial paint. Any error that occurs during a visual's loading period is included in this metric. The most useful statistic for this metric is `SUM`, which represents the total number of failed visual loads during a set period. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
#### Per-unstructured dataset metrics
The following metrics track document statistics and indexing status for Amazon Quick Sight unstructured datasets. You can find these metrics under the `AWS/QuickSight/QuickInstanceId` group in CloudWatch.
| Metric | Description | Dimension | Unit |
| --- | --- | --- | --- |
| QuickIndexDocumentCount | The number of documents in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| QuickIndexExtractedTextSize | The extracted text size of the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Bytes |
| QuickIndexPurchasedInMB | The amount of storage that has been purchased for the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | MB |
| QuickIndexCapacityConsumedRawFileSizeInGB | The raw file size consumed by the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | GB |
| QuickIndexCapacityRawFileSizeLimitInGB | The raw file size limit of the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | GB |
| DocumentsCrawled | The number of uploaded documents crawled in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| DocumentsIndexed | The number of documents indexed in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| DocumentsDeleted | The number of documents deleted from the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| DocumentsModified | The number of documents modified in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| DocumentsFailedToIndex | The number of documents that failed to index in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| ExtractedTextSize | The total text size extracted during a connector level sync in the unstructured Quick index. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | MB |
#### Per-action connector metrics
The following metrics track the number of invocations made to Quick Action Connectors. You can find these metrics under the `AWS/QuickSight` namespace in CloudWatch.
| Metric | Description | Dimension | Unit |
| --- | --- | --- | --- |
| ActionInvocationCount | The number of times your Action Connector was invoked. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
| ActionInvocationError | The number of times your Action Connector failed to invoke. | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/quick/latest/userguide/monitoring-quicksight.html) | Count |
### Aggregate metrics
The `AWS/QuickSight` namespace includes the following aggregate metrics for monitoring traffic and latency of your Amazon Quick assets.
**Topics**
+ [Aggregate dashboard metrics](#aggregate-dashboard-metrics)
+ [Aggregate ingestion metrics](#aggregate-ingestion-metrics)
+ [Aggregate visual metrics](#aggregate-visual-metrics)
+ [Aggregate unstructured dataset metrics](#aggregate-unstructured-dataset-metrics)
+ [Aggregate action connector metrics](#aggregate-action-connector-metrics)
#### Aggregate dashboard metrics
The following metrics track view counts and load times of all dashboards in a Amazon Quick account and region. You can find these metrics under the `AWS/QuickSight/Aggregate Metrics` group in CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| DashboardViewCount | The number of times that all Amazon Quick Sight dashboards have been viewed across the entire Amazon Quick account in the region. This number is an aggregate that includes all access patterns such as web, mobile, and embedded. The most useful statistic for this metric is `SUM`, which represents the total number of Amazon Quick Sight dashboard views during a set period of time. | Count |
| DashboardViewLoadTime | The amount of time that it takes for all Amazon Quick Sight dashboards to load. The measurement begins when a user navigates to the Amazon Quick Sight dashboard and ends when all of the dashboard's visuals finish rendering. The most useful statistic for this metric is `AVERAGE`, which represents the average load time of all Amazon Quick Sight dashboard during a set period of time. | Millisecond |
#### Aggregate ingestion metrics
The following metrics track all ingestions associated with a Amazon Quick account and AWS Region. You can find these metrics under the `AWS/QuickSight/Aggregate Metrics` group in CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| IngestionErrorCount | The number of failed ingestions. The most useful statistic for this metric is `SUM`, which represents the total number of failed ingestion during a set period. | Count |
| IngestionInvocationCount | The number of ingestions that have been initiated. This includes scheduled and manual ingestions that are initiated through the console and the Amazon Quick Sight API operations. The most useful statistic for this metric is `SUM`, which represents the total number of ingestions initiated during a set period of time. | Count |
| IngestionLatency | The time period between the initiation of an ingestion to the completion of the ingestion. The most useful statistic for this metric is `AVERAGE`, which represents the average runtime of ingestions during a set period of time. | Second |
| IngestionRowCount | The number of successful row ingestions. The most useful statistic for this metric is `SUM`, which represents the total amount of data ingested during a set period of time. | Count |
#### Aggregate visual metrics
The following metrics track load times and error counts of all visuals on a dashboard and in a Amazon Quick account in a Region. You can find these metrics under the `AWS/QuickSight/Aggregate Metrics` group for CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| VisualLoadTime | The time that it takes for all Amazon Quick Sight visuals to receive the necessary query data for an initial paint of the visuals. This includes the round-trip query time from the client, to the Amazon Quick service, and then back to the client. The most useful statistic for this metric is `AVERAGE`, which represents the average load time of all visuals during a set period of time. | Millisecond |
| VisualLoadErrorCount | The number of times that all Amazon Quick Sight visuals that belong to the Amazon Quick account fail to complete a data query for an initial paint. The most useful statistic for this metric is `SUM`, which represents the total number of failed visuals during a set period. | Count |
#### Aggregate unstructured dataset metrics
The following metrics track all unstructured dataset metrics within a a Amazon Quick account in a Region. You can find these metrics under the `AWS/QuickSight/Aggregate Metrics` group for CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| QuickIndexDocumentCount | The number of documents in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents added to your index during a set period of time. | Count |
| QuickIndexExtractedTextSize | The extracted text size of the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total size of all text across all documents in your index. | Bytes |
| QuickIndexPurchasedInMB | The amount of storage that has been purchased for the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total size of purchased storage in MB across your index. | MB |
| QuickIndexCapacityConsumedRawFileSizeInGB | The raw file size consumed by the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total raw file size consumed across your index in GB. | GB |
| QuickIndexCapacityRawFileSizeLimitInGB | The raw file size limit of the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total raw file size limit across your index in GB. | GB |
| DocumentsCrawled | The number of uploaded documents crawled in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents crawled in your index. | Count |
| DocumentsIndexed | The number of documents indexed in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents indexed. | Count |
| DocumentsDeleted | The number of documents deleted from the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents deleted from your index. | Count |
| DocumentsModified | The number of documents modified in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents modified in your index. | Count |
| DocumentsFailedToIndex | The number of documents that failed to index in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total number of documents that failed to index. | Count |
| ExtractedTextSize | The total text size extracted during a connector level sync in the unstructured Quick index. The most useful statistic for this metric is `SUM`, which represents the total size of documents extracted during a connector level sync. | MB |
#### Aggregate action connector metrics
The following metrics track all Quick action connector invocations associated with a Amazon Quick account in an AWS Region. You can find these metrics under the `AWS/QuickSight/Aggregate Metrics` group for CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| ActionInvocationCount | The number of action connector invocations made. The most useful statistic for this metric is `SUM`, which represents the total number of action connector invocations initiated during a set period of time. | Count |
| ActionInvocationError | The number of failed action connector invocations. The most useful statistic for this metric is `SUM`, which represents the total number of action connector invocations that failed during a set period of time. | Count |
### Aggregate SPICE metrics
The following metrics monitor SPICE consumption information to help you avoid reaching the SPICE consumption limit that can cause your ingestions to fail. Statistics are stored for up to 15 months so that you can access historical information to better understand the consumption trends of your Amazon Quick account. You can find these metrics in the `AWS/QuickSight/Aggregate Metrics` group for CloudWatch.
| Metric | Description | Unit |
| --- | --- | --- |
| SPICECapacityLimitInMB | This value represents the provisioned SPICE capacity at a specific point in time. This metric refreshes when an update of 1 MB or more in consumed or purchased capacity is made. | MegaBytes |
| SPICECapacityConsumedInMB | This value represents the consumed SPICE capacity at a specific point in time. This metric refreshes when an update of 1 MB or more in consumed or purchased capacity is made. | MegaBytes |
### Dimensions
Following is a list of Quick metric dimensions that appear in Amazon CloudWatch.
| Dimension | Description |
| --- | --- |
| DashboardId | The public ID of a Amazon Quick Sight dashboard. You can use the `ListDashboards` API operation to see a list of every dashboard in your Amazon Quick account. For more information, see [ ListDashboards](https://docs.aws.amazon.com//quicksight/latest/developerguide/list-dashboards.html) in the *Amazon Quick Sight API Reference*. |
| DatasetId | The public ID of a Amazon Quick Sight dataset. You can use the `ListDataSets` API operation to see a list of every dataset in your Amazon Quick Sight account. For more information, see [ ListDataSets](https://docs.aws.amazon.com//quicksight/latest/developerguide/list-datasets.html) in the *Amazon Quick Sight API Reference*. |
| SheetId | The public ID of a Amazon Quick Sight sheet. |
| VisualId | The public ID of a Amazon Quick Sight visual. |
| KnowledgeBaseId | The public ID of a Amazon Quick Sight knowledge base. |
| QuickInstanceId | The public ID of the Quick instance. |
| ActionConnectorId | The public ID of the Quick Action Connector. |
| ActionConnectorType | The type of the Quick Action Connector. |
| ActionId | The public ID of the Quick Action. |
| InvokeErrorCode | The error code related to a failed Quick Action Connector invocation. |