Navigation

Launch MongoDB Charts

The following tutorial guides you through launching the Charts SaaS application. Alternatively, you can install and run Charts locally by following the guide on this page.

Prerequisites

MongoDB Charts is accessible through MongoDB Atlas. You will need a MongoDB Atlas user account to complete this procedure. To learn more about creating an Atlas user, see the Atlas Getting Started documentation.

You will also need an Atlas cluster to visualize data using Charts. The steps on this page guide you through creating an Atlas cluster.

Note

Each instance of the MongoDB Charts application is tied to a single Atlas project, and can only visualize data from Atlas clusters within the same project.

Required Access

To access MongoDB Charts, your Atlas user must have appropriate permissions to read data from the clusters in your Atlas project. This means that your Atlas user can have any Project Role except Project Read Only, which does not grant the appropriate permissions.

When you first register an Atlas account, you are granted the Project Owner role on your initial project. For information on configuring additional users and roles, see Atlas Access in the Atlas documentation.

Procedure

1

Log into MongoDB Atlas.

To access the MongoDB Charts application, you must be logged into Atlas.

2

Select your desired Atlas project, or create a new project.

If you have an Atlas project with clusters containing data you wish to visualize, select the project from the Context dropdown in the left navigation pane.

If you do not have a suitable existing Atlas project, see Create a Project in the Atlas documentation for instructions on creating a new project.

3

(Optional) Invite people to your Atlas project and shared Charts instance.

All Atlas project users with Project Roles other than Project Read Only have access to the Charts instance associated with that project. To add additional members to your Atlas project, see Manage Project Users and Teams in the Atlas documentation.

4

(Optional) Create an Atlas cluster.

The MongoDB Charts application makes it easy to add collections in your cluster as data sources. Data sources reference specific collections which you can access in the Chart Builder to visualize the data in those collections.

Note

You can skip this step if you already have an Atlas cluster in the current project.

To create an Atlas cluster:

  1. In the left navigation pane, click Clusters.

  2. Click Build a New Cluster.

  3. In the Create New Cluster page, choose your preferred cloud provider and region, cluster tier, and additional settings. As you build your cluster, Atlas displays the associated cluster costs at the bottom of the page.

    Note

    Atlas provides a Free Tier M0 replica set as well as paid M10+ clusters. Free Tier deployments have restrictions as compared to paid M10+ deployments, but will work for the purposes of this setup and all Charts tutorials offered in this documentation. For complete documentation on these restrictions, see Atlas M0 (Free Tier), M2, and M5 Limitations.

  4. The default cluster name is Cluster0. If you wish to change your cluster name, do so now, as cluster names cannot be changed once configured.

  5. Click the Create Cluster button to deploy your cluster.

Note

For complete instructions on creating an Atlas cluster and details on all available configuration options, see Create a Cluster in the Atlas documentation.

5

Launch the MongoDB Charts application.

In Atlas, click Charts in the navigation bar.

Note

When you first launch MongoDB Charts in a project, Charts automatically creates new MongoDB users in your Atlas project to access your cluster data. The names of these users are in the format: mongodb-stitch-charts-<PROJECT-NAME>-<ID>_<CLUSTER-NAME>

If you have previously used Charts, you will either see your existing dashboards or be prompted to add a new dashboard.

If you are a new Charts user, MongoDB Charts directs you to the Charts Welcome Experience.

The Charts Welcome Experience provides two possible paths to begin using Charts:

Additionally, MongoDB Charts automatically creates a new, empty dashboard named <YOUR-NAME>'s Dashboard of which you are the Owner. This dashboard is private by default, but you can modify dashboard permissions as you would any other dashboard.

To navigate back to the Atlas Clusters view, click Atlas at the top of the MongoDB Charts application.

Moving Forward

Now that you have configured a data source, you are ready to begin visualizing your data. The next steps are to create a dashboard, and then build charts to populate your dashboard.

For complete walkthroughs of MongoDB Charts and its features, including downloadable data sets to visualize, see the following Tutorials.

Delete Your MongoDB Charts Instance

Important

Deleting a MongoDB Charts instance deletes all data associated with that instance including dashboards, data sources, and metadata. Once the MongoDB Charts instance is deleted, this data cannot be recovered.

If you are an Atlas Project Owner, you can deactivate and delete a MongoDB Charts instance linked to your Atlas project from your Atlas Project Settings.

If you delete your linked MongoDB Charts instance, you can create a new MongoDB Charts instance for your project at any time. The newly created instance does not retain any data from previously deleted instances.