Monitoring data in Amazon Quick Sight using CloudWatch - Amazon Quick Suite
Accessing metrics in CloudWatch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Monitoring data in Amazon Quick Sight using CloudWatch

Amazon Quick Suite sends metrics to Amazon CloudWatch that you can use to observe and respond to the availability and performance of your Amazon Quick Suite 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 Suite.

For more information about using Amazon CloudWatch, see the Amazon CloudWatch User Guide.

Accessing Quick Suite metrics in Amazon CloudWatch

Use the following procedure to access Amazon Quick Suite metrics in Amazon CloudWatch.

To access Amazon Quick Suite metrics in CloudWatch

  1. Sign in to the Amazon Web Services account that's associated with your Amazon Quick Suite account.

  2. In the upper-left corner of the Amazon Web Services Management Console home page, choose Services, and then choose CloudWatch.

  3. In the navigation pane, choose Metrics, All metrics, QuickSight.

Graph metrics with the Amazon CloudWatch console

You can also use the Amazon CloudWatch console to graph metric data generated by Quick Suite. For more information, see Graphing metrics 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 Suite assets. When the metric reaches a threshold that you specify, CloudWatch automatically sends you a notification. For examples, see Creating Amazon CloudWatch alarms in the Amazon CloudWatch User Guide.

Metrics

The Amazon/QuickSight namespace includes the following metrics for monitoring traffic and latency of your Amazon Quick Suite assets.

Per-dashboard metrics

The following metrics track dashboard view counts and load times. You can find these metrics under the Amazon/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 datasets. You can find these metrics under the Amazon/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 Amazon/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.

  • DashboardId

  • SheetId

  • VisualId

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.

  • DashboardId

  • SheetId

  • VisualId

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 Amazon/QuickSight/QuickInstanceId group in CloudWatch.

Metric Description Dimension Unit

QuickIndexDocumentCount

The number of documents in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

QuickIndexExtractedTextSize

The extracted text size of the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Bytes

QuickIndexPurchasedInMB

The amount of storage that has been purchased for the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

MB

DocumentsCrawled

The number of uploaded documents crawled in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

DocumentsIndexed

The number of documents indexed in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

DocumentsDeleted

The number of documents deleted from the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

DocumentsModified

The number of documents modified in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

DocumentsFailedToIndex

The number of documents that failed to index in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

Count

ExtractedTextSize

The total text size extracted during a connector level sync in the unstructured Quick index.

  • KnowledgeBaseId

  • QuickInstanceId

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 Amazon/QuickSight namespace in CloudWatch.

Metric Description Dimension Unit

ActionInvocationCount

The number of times your Action Connector was invoked.

  • ActionConnectorId

  • ActionConnectorType

  • ActionId

Count

ActionInvocationError

The number of times your Action Connector failed to invoke.

  • ActionConnectorId

  • ActionConnectorType

  • ActionId

  • InvokeErrorCode

Count

Aggregate metrics

The Amazon/QuickSight namespace includes the following aggregate metrics for monitoring traffic and latency of your Amazon Quick Suite assets.

Aggregate dashboard metrics

The following metrics track view counts and load times of all dashboards in a Amazon Quick Suite account and region. You can find these metrics under the Amazon/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 Suite 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 Suite account and Amazon Web Services Region. You can find these metrics under the Amazon/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 Suite account in a Region. You can find these metrics under the Amazon/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 Suite 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 Suite 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 Suite account in a Region. You can find these metrics under the Amazon/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

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 Suite action connector invocations associated with a Amazon Quick Suite account in an Amazon Region. You can find these metrics under the Amazon/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 Suite account. You can find these metrics in the Amazon/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 Suite 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 Suite account. For more information, see ListDashboards 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 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.