Navigation
This documentation refers to the MongoDB Charts service in MongoDB Atlas. Read the on-premises documentation to learn how to use the MongoDB Charts on site.

Dashboards

Dashboards are a collection of charts assembled to create a single unified display of your data. Each chart shows data from a single MongoDB collection or view, so dashboards are essential to attain insight into multiple focal points of your data in a single display. Dashboards can be shared with other users.

Dashboards Page

The Dashboards page shows all dashboards you have access to view. To learn more about dashboard permissions in MongoDB Charts, see Dashboard Permissions.

Charts Dashboard Tab

Each dashboard shows the following information:

  • Title
  • Description
  • A preview of the first three charts in the dashboard, including the chart title and type
  • When the dashboard was last modified

By default, the most recently modified dashboards are shown first in the list. You can change the sort order by using the Sort By dropdown menu.

Create a New Dashboard

To create a new dashboard:

  1. From the Dashboards page, click the New Dashboard button.
  2. In the New Dashboard dialog, enter a title for your dashboard.
  3. (Optional) Enter a description for your dashboard.
  4. Click Create.

After after clicking the Create button you are taken to the page for your newly created dashboard, where you are prompted to add the first chart to your dashboard:

Charts New Dashboard Example

Refresh Dashboard Data

MongoDB Charts automatically refreshes chart data once it becomes out of date with the backing data source. You can also manually refresh dashboard data at any time.

Configure Auto Refresh Settings

Charts on a dashboard automatically refresh once their data becomes out of date. You can specify how stale your charts’ data can be before it is refreshed. This is known as your staleness tolerance. The default behavior is to refresh when data is one hour stale.

To configure auto-refresh settings for a dashboard:

  1. Select a dashboard from the Dashboards page.
  2. Click Settings at the top of the dashboard.
  3. Select your data staleness tolerance from the dropdown. Charts supports staleness tolerances between 1 minute and 30 days.
  4. Click Save.

Manually Refresh Data

You can manually refresh an entire dashboard or individual charts to render your charts with the latest data. In a manual refresh, MongoDB Charts reloads data even if the current data is within your specified staleness tolerance.

MongoDB Charts users of all permission levels can refresh dashboard data.

Manually Refresh a Dashboard

Manually refresh an entire dashboard to requery all of the data sources backing your charts and render your charts with the latest data.

To manually refresh dashboard data:

  1. Select a dashboard from the Dashboards page.
  2. Click the arrow next to the Settings button.
  3. Click Force Refresh.

Manually Refresh a Single Chart

Manually refresh a single chart to only requery the data source for that chart and render that chart with the latest data.

To manually refresh a single chart:

  1. Select a dashboard from the Dashboards page.
  2. Click the arrow next to the Settings button.
  3. Click Force Refresh.

Refresh Behavior

  • When Charts refreshes dashboard data, only charts with data older than your specified staleness tolerance are refreshed. Charts does not refresh the entire dashboard at once.

  • Auto-refresh settings are stored in the local browser state. These settings are not persisted with the dashboard or shared between users.

  • Hover over the timer at the bottom of the chart to view more information.

    Chart refresh timer.

    What you see depends on where you view the chart and if the last refresh failed:

    Viewing Method Details You See
    Authenticated Dashboard
    • The error code that describes why the refresh failed, if applicable.
    • Time since the last refresh occurred.
    • Time until the next automatic refresh occurs.
    Dashboard Accessed with a Public Link
    • Time since the last refresh occurred.
    • Time until the next automatic refresh occurs.
    Embedded using an iframe or the SDK
    • The embedding error code that describes why the refresh failed, if applicable.
    • If the chart is configured to automatically refresh: - Time since the last refresh occurred. - Time until the next automatic refresh occurs.
  • When MongoDB Charts loads charts on a dashboard, it does not consistently query the data source for each chart. Instead, MongoDB Charts queries the data sources when the dashboard first loads, and that data is cached on both the client and server.

    Note

    The data stored in the cache is encrypted with a key specific to your MongoDB Charts tenant.

  • When a dashboard refreshes automatically:

    • If a chart’s data is within the staleness tolerance period, Charts doesn’t refresh the chart’s data.
    • If a chart’s data is outside of the staleness tolerance period, Charts returns the latest data from the server cache. If the server cache contains stale data, Charts queries the data source for the latest data, refreshes the chart, and updates the data cached on both the client and server.
  • When you manually refresh a dashboard, Charts updates all chart data by querying the data source for the latest data even if the chart data is within the specified staleness tolerance period.

  • When an automatic or manual refresh fails:

    • MongoDB Charts displays the most recently rendered chart, including all of the chart’s interactive elements.

    • If MongoDB Charts has never successfully rendered the chart, the following message is displayed: Unable to load data.

    • MongoDB Charts displays the following error message at the bottom of the chart: Last refresh failed.

    • If you’re viewing the chart on an Authenticated Dashboard, click the failed link in the error message to view additional error details.

      Note

      This link is not available when you view charts on a dashboard from a public link or embedded using an iframe or the SDK.

    • The error message includes a Refresh link if the chart is rendered on an authenticated dashboard or embedded using an iframe or the SDK. Click the link to manually refresh the chart.

Fullscreen View

MongoDB Charts provides a fullscreen view for dashboards. In this view, MongoDB Charts hides the main navigation bar and expands the dashboard to show the title, description, time of last modification, and charts in the entire space of the screen.

To open a dashboard in fullscreen view, first select a dashboard from the Dashboards page, then click the expanding arrows at the top-right of the dashboard:

Fullscreen Arrows

Note

You can still remove, resize, rearrange, and access editing for charts in fullscreen view by hovering over the desired chart.

Additionally, in fullscreen view you can still configure auto-refresh settings and manually refresh chart data.

To exit fullscreen view, either click the contracting arrows at the top-right of the dashboard or press the escape key.