Monitor & Portal Custom Dashboards

This feature has been deprecated in the on-premises SentryOne Portal feature for SQL Sentry in versions 2021.1 and later. It is replaced by Custom Charts.

Applies to the following products and features: The SentryOne Monitor product and the on-premises SentryOne Portal feature for SQL Sentry (versions earlier than 2021.1).

SentryOne Monitor offers the ability to create custom dashboards. With custom dashboards, you can include the performance metric widgets that you want, and you can have performance charts for different targets on the same dashboard.

Create Custom Dashboard

1. To create a custom dashboard, select Add New from the bottom of the Dashboards drop-down menu:

Monitor Dashboards drop-down menu, select Add New to create a custom dashboard.

2. After selecting Add New, the Create a New Dashboard dialog appears where you will enter the name of the new custom dashboard or select the name of existing one to clone. When you are done entering the Dashboard Name, select Create Dashboard.

Monitor Create a New Dashboard prompt with SentryOne Docs Example entered for the name.

Note:  You must have existing custom dashboards to have the option to clone one using a Dashboard Template.

Monitor create or clone a dashboard prompt, drop-down menu with an existing dashboard and the blank dashboard options.

3. Once the dashboard appears, use the edit button in the upper right to customize the dashboard:

A blank Monitor Custom Dashboard with the name SentryOne Docs Example highlighting the edit dashboard pencil button.

4. Select the performance charts from the list of Available Widgets to add them to your custom dashboard:

Monitor Custom Dashboard SentryOne Docs Example Edit Dashboard menu with Available Widgets across varying metrics.

5. Once you've added the desired widgets, select Save Dashboard:

Monitor Custom Dashboard with CPU Usage and SQL Server Waits charts added, highlighting the Save Dashboard button.

Success: You've created your first custom dashboard!

Monitor Custom Dashboard with CPU Usage and SQL Server Waits Charts with a tooltip displaying for the CPU usage chart.

Note:  This custom dashboard is available across other targets.

Monitor Custom Dashboard select the SentryOne Docs Example dashboard across multiple targets.

Configure Widget

Widgets may be configured to have a Custom Date Range or a Custom Target (which allows for multiple targets per dashboard).

Custom Date Range

A Custom Date Range allows you to configure a widget to display a defined number of minutes, hours, or days. 

Monitor Custom dashboard with the cog button selected. A custom range is selected in the Configure Widget window.

To set a Custom Date Range:

  1. Select edit on a custom dashboard.
  2. Select configure on a specific widget.
  3. Toggle the Use Dashboard Time Range switch to false.
  4. Use the Enter Number textbox and Select Units drop-down to enter an amount of time.
  5. Select Update on the Configure Widget screen.
  6. Select Save Dashboard on the Edit Dashboard screen.

In this example, the top CPU Usage chart has the default Dashboard Time Range, and the bottom chart is displaying a Custom Time Range of 5 minutes.

Monitor Custom Dashboard. The top CPU Usage chart has the default range and the bottom chart has a custom range of 5 minutes.

Multiple Targets per Dashboard

1. If you would like to have different targets on the same dashboard, use the Configure option on a widget in the custom dashboard to open the Configure Widget options. Under Configure Widget options, toggle Use Dashboard Target to off, then click Select Target.

Monitor Custom Dashboard with the Configure Widget pane opened. Use Dashboard target is toggled off to use Select Target.

2. Use Select Target to open the target selection window and choose a target to associate with the performance chart widget. You can type into the filter area or use (chevron-down) to select a target from the list of devices.

Monitor Select Target window with 8 selectable device instances.

3. Once you've selected a device, you'll see it populated under Custom Target. Select Update to set the chart widget to the Custom Target:

Monitor Configure Widget window with Custom Target Q-Regression selected to update a CPU Usage chart.

4. Configure the widgets until you have the performance chart and target combination desired for your custom dashboard and save your changes using Save Dashboard. The example below shows a custom dashboard with CPU Usage for a custom target and Disk I/O for the primary target of the dashboard:

Monitor custom dashboard with CPU Usage for a custom target and Disk I/O for the primary target of the dashboard.

The example below shows a custom dashboard with three SQL Server Activity chart widgets, all configured to display the values for a different target:

Monitor custom dashboard with three SQL Server Activity chart widgets, all configured to display the values for a different target.

SQL Server vs. Azure SQL DB Widgets

When adding widgets, you'll see SQL Server and Azure SQL DB labels under the widget name. If you add an Azure SQL DB widget to a custom dashboard that has an Azure SQL Database as the default target, then the chart widget will use that target.

Add an Azure SQL DB widget to a dashboard that has an Azure SQL Database as the default target:

Monitor Custom Dashboard with the Edit Dashboard window opened and 6 Azure SQL DB widgets available to add to the dashboard.

The widget loads for the default target without any additional configuration:

Monitor Custom Dashboard with SQL Server Activity charts for an Azure SQL DB target with no additional configuration.

However, if you start from a different target type as the base (SQL Server in this case), you'll need to configure the target to an Azure SQL DB instance to populate the chart data.

Add an Azure SQL DB widget to a dashboard with a different target type from the default target. The widget is added without data to display. The default target is a SQL Server which doesn't have Azure SQL DB data to match the widget:

Monitor Custom Dashboard for a SQL Server target with the edit widget page open for Azure SQL DB widgets.

Select edit on the widget to select a different target for the chart. Configure per the Custom Target instructions under Multiple Targets per Dashboard.

Note:  The list of targets and instances provided in the Select Target list will be specific to targets of the same widget type.

Monitor Select Target list for Widget type with 2 Azure SQL DB instances only This list of instances for the Azure SQL DB widget type only includes targets of that type.

Clone Dashboard

Once you have a custom dashboard created, you may be able to save time by using it as a template for additional custom dashboards. 

To clone a dashboard: 

1. Select Add New from the Dashboards menu.

2. Enter a Dashboard Name.

3. Select a Dashboard Template from the drop-down menu to select the name of the dashboard you want to clone..

5. Select Create Dashboard.

Monitor Create a New Dashboard window with Blank Dashboard selected as the template.

6. The cloned dashboard appears and you can use the edit button to configure the options for your cloned dashboard.

Delete Dashboard

While viewing a custom dashboard, select the edit button to open Edit Dashboard options and select Delete Dashboard at the bottom to delete the dashboard.

SentryOne Monitor Edit Dashboard pane with the Delete Dashboard button highlighted.