Manage big data clusters for SQL Server controller dashboard

Applies to: SQL Server 2019 (15.x)

Important

The Microsoft SQL Server 2019 Big Data Clusters add-on will be retired. Support for SQL Server 2019 Big Data Clusters will end on February 28, 2025. All existing users of SQL Server 2019 with Software Assurance will be fully supported on the platform and the software will continue to be maintained through SQL Server cumulative updates until that time. For more information, see the announcement blog post and Big data options on the Microsoft SQL Server platform.

In addition to azdata and the cluster status notebook, there is another way to view the status of a SQL Server Big Data Cluster. You can now add the SQL Server Big Data Cluster controller through the Connections viewlet. This enables you to have a dashboard to view the cluster health.

Prerequisites

The following prerequisites are required to launch the notebook:

• Latest version of Azure Data Studio
• SQL Server 2019 (15.x) extension installed in Azure Data Studio

In addition to above, SQL Server 2019 Big Data Cluster also requires:

• azdata
  • Windows installer
  • Linux package manager
• kubectl
• Azure CLI

Add SQL Server Big Data Cluster controller

1. Click on the Connections view on the left pane.
2. At the bottom of the Connections view, click SQL Server Big Data Clusters to expand it.
3. Click Add SQL Server big data cluster controller, this will launch a new dialog.

Add New Controller

1. Add your cluster name.
2. Add your Cluster Management Service URL. This can be found on the Service Endpoints table in your BDC dashboard, or ask your cluster admin.
3. Add your username and password.

Launch controller dashboard

1. When you successfully add your controller, you can view it under SQL Server Big Data Clusters.
2. To launch the dashboard, right-click on the controller and click Manage.

Controller Dashboard

1. On the Controller dashboard, there are 3 main components:

   • Toolbar on top which contain actions for the dashboard.
   • Nav pane on left which changes to the different views on the dashboard.
   • View covering the majority of the page.

2. On the Big data cluster overview page, you can see:

   • Cluster Properties to see information about your cluster.
   • Cluster Overview to see high level overview of all the cluster components, and which ones are unhealthy
   • Service Endpoints to copy or access to different services within your SQL Server Big Data Cluster.

3. On the Nav pane, you can see the list of services and click on one to view additional cluster details. This is the same views when you click on a service in Cluster Overview.

4. Each view under Cluster Details consist of the same UI components:

   • Health Status Details which share the state and health status of the component.
   • Metrics and Logs to view additional metrics and logs through Grafana and Kibana.

5. If you view a component that is unhealthy, click on Troubleshoot on the toolbar to launch a Jupyter Book containing a notebook to help diagnose the issue.

Next Steps

For more information about the controller, see our controller documentation.