Link Search Menu Expand Document Documentation Menu

Tutorial: Creating a dashboard

You can use the Dashboards application in OpenSearch Dashboards to build a page containing multiple visual representations of your data.

Use the following tutorial to learn to create a dashboard using the Dashboards application and the OpenSearch sample data. The sample datasets have existing sample visualizations that you can use for the dashboard, or you can create your own visualizations. The tutorials demonstrate how to do both.

For an overview of the Dashboards UI, see Navigating the Dashboards UI.

Prerequisites

The tutorials on this page use the Sample eCommerce data dataset that is already installed in OpenSearch Playground.

If you’re using a local installation of OpenSearch Dashboards and haven’t added sample data yet, see Prepare your data.

The following tutorials assume you’re either using your existing installation of OpenSearch Dashboards or using the OpenSearch Playground. Depending on which one you use, certain capabilities may not be available. For example, sample datasets may not be included in your existing installation, and saving a dashboard isn’t an option in the OpenSearch Playground.

Creating a dashboard

To create a new dashboard, follow these steps:

  1. In classic navigation In workspaces navigation
    - Select OpenSearch Dashboards > Dashboards.
    - Select Dashboards.
    Select Dashboards.
  2. In classic navigation In workspaces navigation
    - In the Dashboards panel, select Create.
    - From the drop-down, select Dashboard.
    From the application menu, select Create Dashboard.

Adding an existing visualization

To add a saved visualization to the dashboard, follow these steps:

  1. From the application panel, choose Add an existing.

  2. In the Add panels dialog, type ecommerce in the Search box to filter the list of available visualizations.

  3. From the Add panels dialog, choose [eCommerce] Sales by Category.

  4. Choose the cross icon (cross) icon to close the dialog.

  5. Use the time filter to select Last 2 years as the time window as shown in the following image.

Time filter set to Last 2 years

  1. Drag-select the narrow band of data from the area chart as shown in the following image.

    Visualization showing drag-select

    The data adjusts to span the width of the data display and the scale adjusts automatically, as shown in the following image.

    Sales by category area visualization

    Selecting a date range interactively results in an absolute time interval.

You’ve created a dashboard with a single panel, which you’ll continue to modify in this tutorial. Save the dashboard as described in the following section.

Saving a dashboard

To save a new dashboard, follow these steps:

  1. In the Dashboards toolbar, choose Save.

  2. In the Save dashboard dialog, enter [Ecommerce] tutorial dashboard in the Title box.

  3. Save the time filter with the dashboard by selecting Store time with dashboard.

  4. Choose Save.

  5. Choose Edit from the application menu to continue editing the dashboard.

Creating a visualization

To create a new visualization in Dashboards, follow these steps:

  1. From the application toolbar, choose Create new.

  2. From the New Visualization window, choose Metric.

  3. In the New Metric/Choose a source dialog, select the index pattern opensearch_dashboards_sample_data_ecommerce.

  4. From the toolbar, choose Save.

  5. In the Save visualization dialog, enter a title for the visualization. For this tutorial, enter [eCommerce] Order Count.

  6. Choose Save and return.

    The Dashboards application saves the metric visualization and adds it to the dashboard as shown in the following image.

    Dashboard with Sales by Category and Order Count metric panels

Adding subsequent panels

Add a Markdown visualization to the dashboard. Follow these steps:

  1. From the dashboard toolbar, choose Add.

  2. From the Add panels dialog, choose [eCommerce] Markdown.

  3. Choose the cross icon (cross) icon to close the dialog.

    The Dashboards application adds the Markdown panel to the dashboard as shown in the following image.

    Example dashboard

Organizing a dashboard

You can organize a dashboard by resizing and rearranging panels. Move and resize the Markdown panel to serve as a title and description for the dashboard. Follow these steps:

  1. Select and hold the top of the panel anywhere to the left of the options icon (options) icon.

  2. Drag the panel to the top of the application panel.

    The Sales by Category panel automatically swaps places with the Markdown panel as you move it up.

  3. Select and hold the resize icon (resize) icon in the panel’s lower-right corner.

  4. Drag to make the panel longer and narrower so that it serves as a banner across the entire upper part of the dashboard.

    The metric panel automatically moves down to allow room for the resized Markdown panel.

    The resulting dashboard should look like the following image.

    Example dashboard

  5. Save your dashboard. See Saving a dashboard.

350 characters left

Have a question? .

Want to contribute? or .