# Monitoring Amazon Quick using CloudWatch metrics
<a name="monitoring-cloudwatch-metrics"></a>

Amazon Quick sends metrics to Amazon CloudWatch in the `AWS/QuickSight` namespace. These metrics cover dashboards, visuals, dataset ingestions, SPICE capacity, knowledge base indexing, action connectors, and automations. Use them to observe availability and performance, and to create alarms for your Amazon Quick environment.

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
<a name="access-cw"></a>

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
<a name="cw-graph"></a>

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
<a name="cw-alerts"></a>

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
<a name="cw-metrics"></a>

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-automation metrics](#per-automation-metrics)

#### Per-dashboard metrics
<a name="per-dashboard-metrics"></a>

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.<br />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 dashboard to load. The measurement begins when a user reaches the Amazon Quick dashboard and ends when all of the dashboard's visuals finish rendering.<br />The most useful statistic for this metric is `AVERAGE`, which represents the average load time of a Quick dashboard during a set period of time. | DashboardId | Millisecond | 

#### Per-dataset ingestion metrics
<a name="per-ingestion-metrics"></a>

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.<br />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 API operations.<br />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.<br />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.<br />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
<a name="per-visual-metrics"></a>

The following metrics track the load times and error counts of individual visuals on a Amazon Quick 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 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 service, and then back to client.<br />The most useful statistic for this metric is `AVERAGE`, which represents the average load time of a visual during a set period of time. |  +  DashboardId <br />+  SheetId <br />+  VisualId   | Millisecond | 
| VisualLoadErrorCount | The number of times that a Amazon Quick 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.<br />The most useful statistic for this metric is `SUM`, which represents the total number of failed visual loads during a set period. |  +  DashboardId <br />+  SheetId <br />+  VisualId   | Count | 

#### Per-unstructured dataset metrics
<a name="per-unstructured-dataset-metrics"></a>

The following metrics track document statistics and indexing status for Amazon Quick 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. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| QuickIndexExtractedTextSize | The extracted text size of the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Bytes | 
| QuickIndexPurchasedInMB | The amount of storage that has been purchased for the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | MB | 
| QuickIndexCapacityConsumedRawFileSizeInGB | The raw file size consumed by the unstructured Quick index. |  +  QuickInstanceId   | GB | 
| QuickIndexCapacityRawFileSizeLimitInGB | The raw file size limit of the unstructured Quick index. |  +  QuickInstanceId   | GB | 
| DocumentsCrawled | The number of uploaded documents crawled in the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| DocumentsIndexed | The number of documents indexed in the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| DocumentsDeleted | The number of documents deleted from the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| DocumentsModified | The number of documents modified in the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| DocumentsFailedToIndex | The number of documents that failed to index in the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | Count | 
| ExtractedTextSize | The total text size extracted during a connector level sync in the unstructured Quick index. |  +  KnowledgeBaseId <br />+  QuickInstanceId   | MB | 

#### Per-action connector metrics
<a name="per-action-connector-metrics"></a>

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 an action connector was invoked. |  +  ActionConnectorId <br />+  ActionConnectorType <br />+  ActionId   | Count | 
| ActionInvocationError | The number of times an action connector failed to invoke. |  +  ActionConnectorId <br />+  ActionConnectorType <br />+  ActionId <br />+  InvokeErrorCode   | Count | 

#### Per-automation metrics
<a name="per-automation-metrics"></a>

The following metrics track automation run counts and duration. You can find these metrics under the `AWS/QuickSight` namespace in CloudWatch.


| Metric | Description | Dimension | Unit | 
| --- | --- | --- | --- | 
| TotalAutomationRunCount | The total number of automation runs initiated.<br />The most useful statistic for this metric is `SUM`, which represents the total number of automation runs during a set period of time. | AutomationId | Count | 
| SuccessfulAutomationRunCount | The number of automation runs that completed successfully.<br />The most useful statistic for this metric is `SUM`, which represents the total number of successful runs during a set period of time. | AutomationId | Count | 
| FailedAutomationRunCount | The number of automation runs that failed.<br />The most useful statistic for this metric is `SUM`, which represents the total number of failed runs during a set period of time. | AutomationId | Count | 
| StoppedAutomationRunCount | The number of automation runs that were stopped before completion.<br />The most useful statistic for this metric is `SUM`, which represents the total number of stopped runs during a set period of time. | AutomationId | Count | 
| AutomationRunDuration | The elapsed time of an automation run from start to completion.<br />The most useful statistic for this metric is `AVERAGE`, which represents the average duration of automation runs during a set period of time. | AutomationId | Seconds | 

### Aggregate metrics
<a name="cw-aggregate-metrics"></a>

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
<a name="aggregate-dashboard-metrics"></a>

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 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.<br />The most useful statistic for this metric is `SUM`, which represents the total number of Amazon Quick dashboard views during a set period of time. | Count | 
| DashboardViewLoadTime | The amount of time that it takes for all Amazon Quick dashboards to load. The measurement begins when a user navigates to the Amazon Quick dashboard and ends when all of the dashboard's visuals finish rendering.<br />The most useful statistic for this metric is `AVERAGE`, which represents the average load time of all Amazon Quick dashboard during a set period of time. | Millisecond | 

#### Aggregate ingestion metrics
<a name="aggregate-ingestion-metrics"></a>

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.<br />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 API operations.<br />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.<br />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.<br /> 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
<a name="aggregate-visual-metrics"></a>

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 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.<br />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 visuals that belong to the Amazon Quick account fail to complete a data query for an initial paint.<br />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
<a name="aggregate-unstructured-dataset-metrics"></a>

The following metrics track all unstructured dataset metrics within 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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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.<br />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
<a name="aggregate-action-connector-metrics"></a>

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.<br />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.<br />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
<a name="aggregate-spice-metrics"></a>

Use the following metrics to monitor SPICE consumption and avoid reaching the consumption limit that can cause ingestions to fail. CloudWatch stores statistics for up to 15 months, so 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
<a name="cw-dimensions"></a>

The following table lists Quick metric dimensions that appear in Amazon CloudWatch.


| Dimension | Description | 
| --- | --- | 
| DashboardId | The public ID of a Quick dashboard.<br />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 API Reference*. | 
| DatasetId | The public ID of a Quick dataset.<br />You can use the `ListDataSets` API operation to see a list of every dataset in your Amazon Quick account. For more information, see [ ListDataSets](https://docs.aws.amazon.com/quicksight/latest/developerguide/list-datasets.html) in the *Amazon Quick API Reference*. | 
| SheetId | The public ID of a Quick sheet. | 
| VisualId | The public ID of a Quick visual. | 
| KnowledgeBaseId | The public ID of a Quick 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. |