Monitoring data in Amazon QuickSight - Amazon QuickSight

Monitoring data in Amazon QuickSight

Amazon QuickSight sends metrics to Amazon CloudWatch that you can use to observe and respond to the availability and performance of your QuickSight environment in near real time. Currently, you can monitor metrics for QuickSight dashboards, visuals, and dataset ingestions to provide your readers with a consistent, high-performing, and uninterrupted experience on Amazon QuickSight.

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

Following, you can find information on how to access CloudWatch and a list of all current supported metrics.

Accessing Amazon QuickSight metrics in Amazon CloudWatch

Use the following procedure to access Amazon QuickSight metrics in Amazon CloudWatch.

To access QuickSight metrics in CloudWatch

  1. Sign in to the AWS account that's associated with your QuickSight account.

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

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

Metrics

The AWS/QuickSight namespace includes the following metrics for monitoring traffic and latency of your Amazon QuickSight dashboards and ingestions.

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 for 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 QuickSight dashboard to load. The measurement begins when a user reaches the QuickSight 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 QuickSight 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 AWS/QuickSight/Ingestion Metrics group for 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 QuickSight 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 QuickSight dashboard. You can find these metrics under the AWS/QuickSight/Visual Metrics group for CloudWatch.

Metric Description Dimension Unit

VisualLoadTime

The time that it takes for a QuickSight 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 QuickSight 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 QuickSight 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

Aggregate metrics

The AWS/QuickSight namespace includes the following aggregate metrics for monitoring traffic and latency of your Amazon QuickSight dashboards and ingestions.

Aggregate dashboard metrics

The following metrics track view counts and load times of all dashboards in a QuickSight account and region. You can find these metrics under the AWS/QuickSight/Aggregate Metrics group for CloudWatch.

Metric Description Unit

DashboardViewCount

The number of times that all QuickSight dashboards have been viewed across the entire QuickSight 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 QuickSight dashboard views during a set period of time.

Count

DashboardViewLoadTime

The amount of time that it takes for all QuickSight dashboards to load. The measurement begins when a user navigates to the QuickSight 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 QuickSight dashboard during a set period of time.

Millisecond

Aggregate ingestion metrics

The following metrics track all ingestions associated with a QuickSight account and AWS Region. You can find these metrics under the AWS/QuickSight/Aggregate Metrics group for 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 QuickSight 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 QuickSight 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 QuickSight 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 QuickSight 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 QuickSight visuals that belong to the QuickSight 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

Dimensions

Following is a list of Amazon QuickSight metric dimensions that appear in Amazon CloudWatch.

Dimension Description

DashboardId

The public ID of a QuickSight dashboard.

You can use the ListDashboards API operation to see a list of every dashboard in your Amazon QuickSight account. For more information, see ListDashboards in the Amazon QuickSight API Reference.

DatasetId

The public ID of a QuickSight dataset.

You can use the ListDataSets API operation to see a list of every dataset in your Amazon QuickSight account. For more information, see ListDataSets in the Amazon QuickSight API Reference.

SheetId

The public ID of a QuickSight sheet.

VisualId

The public ID of a QuickSight visual.

Graphing metrics by using the Amazon CloudWatch console

You can also use the Amazon CloudWatch console to graph metric data generated by Amazon QuickSight. For more information, see Graphing metrics in the Amazon CloudWatch User Guide.

Creating alarms by using the Amazon CloudWatch console

You can create a Amazon CloudWatch alarm that monitors CloudWatch metrics for your Amazon QuickSight 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.