Monitor your Amazon QuickSight deployments utilizing the brand new Amazon CloudWatch integration

Amazon QuickSight is a fully-managed, cloud-native enterprise intelligence (BI) service that makes it simple to hook up with your knowledge, create interactive dashboards, and share these with tens of hundreds of customers, both inside the QuickSight interface or embedded in software program as a service (SaaS) functions or internet portals. With QuickSight offering insights to energy your every day selections, it turns into extra necessary than even for directors and builders to make sure their QuickSight dashboards and knowledge refreshes are working easily as anticipated.

We lately introduced the supply of QuickSight metrics inside Amazon CloudWatch, which permits builders and directors to watch the supply and efficiency of their QuickSight deployments in actual time. With the supply of metrics associated to dashboard views, visible load occasions, and knowledge ingestion particulars into SPICE (the QuickSight in-memory knowledge retailer), builders and directors can be sure that end-users of QuickSight deployments have an uninterrupted expertise with related knowledge. CloudWatch integration is now accessible in QuickSight Enterprise Version in all supported Areas. These metrics may be accessed by way of CloudWatch, and permit QuickSight deployments to be monitored equally to different software deployments on AWS, with the power to generate alarms on failures and to slice and cube historic occasions to view traits and establish optimization alternatives. Metrics are saved for a interval of 15 months, permitting them for use for historic comparability and development evaluation.

Function overview

QuickSight emits the next metrics to trace the efficiency and availability of dataset ingestions, dashboards, and visuals. Along with particular person asset metrics, QuickSight additionally emits aggregated metrics to trace efficiency and availability of all dashboards and SPICE ingestions for an account in a Area.

Entry QuickSight metrics in CloudWatch

Use the next process to entry QuickSight metrics in CloudWatch:

1. Check in to the AWS account related together with your QuickSight account.
2. Within the upper-left nook of the AWS Console Dwelling, select Providers, after which select CloudWatch.
   
3. On the CloudWatch console, underneath Metrics within the navigation pane, select All metrics, and select QuickSight.
   
4. To entry particular person metrics, select Dashboard metrics, Visible metrics, and Ingestion metrics.
5. To entry mixture metrics, select Mixture metrics.
   

Visualize metrics on the CloudWatch console

You should utilize the CloudWatch console to visualise metric knowledge generated out of your QuickSight deployment. For extra data, see Graphing metrics.

Create an alarm utilizing CloudWatch console

You may also create a CloudWatch alarm that displays CloudWatch metrics in your QuickSight property. CloudWatch routinely sends you a notification when the metric reaches a threshold you specify. For examples, see Utilizing Amazon CloudWatch alarms.

Use case overview

Let’s take into account a fictional firm, OkTank, which is an impartial software program vendor (ISV) within the healthcare area. They’ve an software that’s utilized by totally different hospitals throughout totally different areas of the nation to handle their income. OkTank has a whole bunch of hospitals with hundreds of healthcare staff accessing their software and has embedded operations associated to their enterprise utilizing a number of QuickSight dashboards of their software. As well as, they permit embedded authoring expertise to every hospital’s in-house knowledge analysts to construct their very own dashboards for his or her BI wants.

All of the dashboards are powered by a database cluster, they usually have a number of ingestion schedules. As a result of their QuickSight utilization is rising and hospitals’ in-house knowledge analysts are contributing by bringing in additional knowledge and their very own dashboards, OkTank desires to watch and ensure they’re offering their readers with a constant, performant, and uninterrupted expertise on QuickSight.

OkTank has some key monitoring wants that they deem essential:

• Monitoring console – They need a basic monitoring console the place they will monitor reader engagement of their account, hottest dashboards, and total visible load efficiency. They want to monitor total ingestion efficiency of their account.
• Dashboard adoption and efficiency – They wish to monitor visitors development with respect to efficiency to ensure they’re assembly scaling wants.
• Visible efficiency and availability – They’ve some visuals with advanced queries and want to make sure that these queries are working quick sufficient with out failures in order that their readers have a performant and uninterrupted expertise.
• Ingestion failures – They wish to be alerted if any scheduled ingestion fails, in order that they will act immediately and ensure their readers don’t expertise any interruptions.

Within the following sections, we talk about how OkTank meets every monitoring want in additional element.

Monitoring console

OkTank desires to have a basic monitoring console to have a look at key KPIs, monitor reader engagement, and ensure their readers are getting a constant and uninterrupted expertise with QuickSight.

To create a monitoring console and add a KPI metric to it, OkTank takes the next steps:

1. On the CloudWatch console, underneath Metrics within the navigation pane, select Dashboards.
2. Select Create dashboard.
   
3. Enter the dashboard title and select Create dashboard.
   
4. On the clean dashboard touchdown web page, select both Add a primary widget or the plus signal so as to add a widget.
   
5. Within the Add widget part, select Quantity.
   
   
6. On the Browse tab, select QuickSight.
   
7. Select Mixture metrics.
8. Choose DashboardViewCount.
9. Select Create widget.
   
10. On the choices menu of the newly created widget, select Edit.
    
11. Enter the specified widget title.
12. For Statistic, select Sum.
13. For Interval, select 1 day.
14. Select Replace widget.
    

With the widget choices, OkTank has added extra KPIs on the console, reminiscent of common dashboard load time throughout the area in the course of the day and the ten hottest dashboards with the best views, and created their monitoring console.

Dashboard adoption and efficiency

OkTank has some essential dashboards, they usually wish to monitor adoption of that dashboard and observe its loading efficiency to ensure they will meet scaling wants.

They take the next steps to create a widget:

1. On the monitoring console, select the plus signal.
   
2. Within the Add widget part, select Line.
   
3. Within the Add to this dashboard part, select Metrics.
   
4. On the Browse tab, select QuickSight.
5. Select Dashboard metrics.
   
6. Select the DashboardViewCount and DashbordViewLoadTime metrics of the essential dashboard.
7. Select Create widget.
   

The newly created widget reveals essential dashboards views and cargo occasions in a number of dimensions.

Visible efficiency and availability

OkTank has some visuals that require them to run advanced queries whereas loading. They wish to present their readers with constant and uninterrupted expertise. As well as, they want to be alerted in case a question experiences failures when working or takes longer than the specified runtime.

They take the next steps to watch and arrange an alarm:

1. On the monitoring console, select the plus signal.
2. Within the Add widget part, select Line.
3. Within the Add to this dashboard part, select Metrics.
4. On the Browse tab, select QuickSight.
5. Select Visual metrics.
   
6. Select the VisualLoadTime metric of the essential visible and configure the time interval on the menu above the chart.
7. To get alerted in case the essential visible fails to load as a result of question failure, select the VisualLoadErrorCount metric.
   
   The newly created widget reveals visuals load efficiency over the chosen time-frame.
8. On the Graphed metrics tab, choose the VisualLoadErrorCount metric.
9. On the Actions menu, select Create alarm.
   
10. For Metric title, enter a reputation.
11. Affirm that the worth for DashboardId matches the dashboard that has the visible.
    
    Within the Circumstances part, OkTank desires to be notified when the error rely is larger than or equal to 1.
12. For Threshold sort, choose Static.
13. Choose Better/Equal.
14. Enter 1.
15. Select Subsequent.
    
16. Within the Notification part, select Choose an current SNS matter or Create a brand new matter.
17. In case you’re creating a brand new matter, present a reputation for the subject and e mail addresses of recipients.
18. Select Create matter.
    
19. Enter an alarm title and non-obligatory description.
20. Select Subsequent.
    
21. Confirm the small print and select Create alarm.
    

The alarm is now accessible on the CloudWatch console. If the visible fails to load, the VisualLoadErrorCount worth turns into 1 or extra (relying on the variety of occasions the dashboard is invoked) and the alarm state is ready to In alarm.

Select the alarm to get extra particulars.

You possibly can scroll down for extra details about the alarm.

OkTank additionally receives an e mail to the e-mail endpoint outlined within the Amazon Easy Notification Service (Amazon SNS) matter.

Ingestion failures

OkTank desires to be alerted if any scheduled SPICE knowledge ingestion fails, in order that they will act immediately and ensure their readers don’t expertise any interruptions. This permits the administrator to seek out out the basis reason behind the SPICE ingestion failure (for instance, an overloaded database occasion) and repair it to make sure the most recent knowledge is on the market within the dependent dashboards.

They take the next steps to watch and arrange an alarm:

1. On the monitoring console, select the plus signal.
2. Within the Add widget part, select Line.
3. Within the Add to this dashboard part, select Metrics.
4. On the Browse tab, select QuickSight.
5. Select Ingestion metrics.
   
6. Select the IngestionErrorCount metric of the dataset and configure the time interval on the menu above the chart.
   
7. Comply with the identical steps as within the earlier part to arrange an alarm.
   

When ingestion fails for the dataset, the alarm modifications to an In Alarm state and also you obtain an e mail notification.

The next screenshot reveals an instance of the e-mail.

Conclusion

With QuickSight metrics in CloudWatch, QuickSight builders and directors can observe and reply to the supply and efficiency of their QuickSight ecosystem in near-real time. They’ll monitor dataset ingestions, dashboards, and visuals to supply end-users of QuickSight and functions that embed QuickSight dashboards with a constant, performant, and uninterrupted expertise.

Check out QuickSight metrics in Amazon CloudWatch to watch your Amazon QuickSight deployments, and share your suggestions and questions within the feedback.

Concerning the Authors

Mayank Agarwal is a product supervisor for Amazon QuickSight, AWS’ cloud-native, absolutely managed BI service. He focuses on account administration, governance and developer expertise. He began his profession as an embedded software program engineer creating handheld units. Previous to QuickSight he was main engineering groups at Credence ID, creating customized cell embedded system and internet options utilizing AWS providers that make biometric enrollment and identification quick, intuitive, and cost-effective for Authorities sector, healthcare and transaction safety functions.

Raj Jayaraman is a Senior Specialist Options Architect for Amazon QuickSight. Raj focuses on serving to prospects develop pattern dashboards, embed analytics and undertake BI design patterns and greatest practices.