Sign inTry Free

Dashboard Apps

On this page

Note

This is a Preview feature.

SingleStore Dashboard Apps enables users to create, publish, and manage real-time interactive dashboards through the Cloud Portal. It integrates with SingleStore Notebooks and uses Plotly's Dash framework. It helps in monitoring key metrics, exploring trends, and making data-driven decisions in real time.

You can create and manage dashboard apps using the Cloud Portal.

Publish Dashboard Apps using the Cloud Portal

Create a Dashboard App

Dashboard Apps can be created for shared notebooks only. You can create a dashboard app:

  1. Using Apps in the left navigation

    Select Apps in left navigation and then select Shared Notebooks.

  2. Using Shared Notebooks

    1. Navigate to Data Studio > Shared.

    2. Select a shared notebook.

    3. Select Publish (on the top right).

    Select Publish in the upper right to publish the notebook as dashboard app.

New Dashboard App

After selecting Publish, a new dialog box appears.

Select Dashboard in Publish Settings dialog.

Publish Settings

Publish as

Select Dashboard.

Name

Enter a name of the dashboard app.

Description

Enter the dashboard app description.

Notebook

Select a shared notebook to publish as a dashboard app. The shared notebook is pre-selected when the dashboard app is published through Notebooks.

Deployment

Select the SingleStore deployment (workspace) your notebook will connect to.

Selecting a workspace allows you to connect to your SingleStore databases referenced in the Notebook natively. You can also publish a dashboard app without a deployment attached to it.

Select Next.

Shows the summary of Publish Settings

Select Publish to publish your notebook as a dashboard app.

Manage an Existing Dashboard App

To view an existing dashboard app, select Apps in the left navigation. You can view, update, and delete a dashboard app.

View a Dashboard App

To view a dashboard app, select the dashboard app name under the Name column.

View the pubished dashboard app in Apps.

You can view the following details for each dashboard app:

View the dashboard after selecting the dashboard app name under Name column.

You can view the details of a dashboard app on the right navigation. You can refresh and delete the dashboard app from this page.

Update a Dashboard App

To update an existing dashboard app, select the ellipsis in the Actions column of the dashboard app, and select Update.

Update the details of dashboard in Dashboard settings.

You can also update the dashboard app using your shared notebook.

Select Update Dashboard in the upper right in the notebook to update the dashboard details.

Select Update Dashboard.

View the dialog for updating the dashboard after selecting Update Dashboard in the notebook or in the Apps.

Delete a Dashboard App

To delete an existing dashboard app, select the ellipsis in the Actions column of the dashboard app, and select Delete.

Status of Dashboard Apps

Status

Description

Initializing

The notebook is creating or updating the dashboard.

Active

The dashboard is configured correctly. The notebook is successfully published as a dashboard.

Failed

The dashboard is not configured correctly. View the notebook snapshot to debug the failure.

Error

An error unrelated to the notebook code prevented the dashboard from initializing. Refer to Troubleshoot Dashboard Apps.

Troubleshoot Dashboard Apps

SingleStore automatically saves a snapshot of the notebook for each execution that fails. Navigate to Apps in the left navigation, select your dashboard, and download the snapshot associated with the failed dashboard to diagnose the error.

Error

Solution

Workspace Deleted

Update the dashboard and select a deployment.

Workspace Suspended

Resume the workspace or create a new dashboard with a different deployment.

Database Detached

Reattach the database with the right permissions or create a new dashboard with a different database.

Notebook Deleted/Not Present

Create a new dashboard with a different notebook.

Internal Errors/Misc

Reach out to SingleStore Support or use the chat feature in the Cloud Portal.

Last modified: December 5, 2024

Was this article helpful?

On this page

Was this article helpful?