Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Create new doc for Dashboard application #2350

Merged
merged 67 commits into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
1217869
New site page and content
vagimeli Jan 6, 2023
dc69be4
Content dev
vagimeli Jan 7, 2023
da290a9
Content dev
vagimeli Jan 7, 2023
fa22d76
Change link to localhost instead of playground
vagimeli Jan 9, 2023
0210674
Continue writing
vagimeli Jan 10, 2023
4aafa2f
Continue writing
vagimeli Jan 10, 2023
fea90a1
Merge branch 'main' into 2349-dashboard-site-page
vagimeli Jan 10, 2023
8f7be38
Continue writing
vagimeli Jan 11, 2023
d289b58
Add installation guide for Debian distribution (#2355)
Jan 11, 2023
4091471
Clean up RPM/YUM installation guide (#2371)
Jan 11, 2023
71aa7b5
[DOC] Adds new site pages and content under Visualize (#2377)
vagimeli Jan 11, 2023
515f11c
Adds response fields to the cluster health API (#2385)
kolchfa-aws Jan 11, 2023
91579dd
Continue writing tutorial
vagimeli Jan 11, 2023
f8c97b4
Continue writing
vagimeli Jan 12, 2023
73a8ad3
Continue content development
vagimeli Jan 20, 2023
9a74267
Continue content development
vagimeli Jan 20, 2023
4fda7fd
Writing
vagimeli Feb 3, 2023
f2119c9
Revert "Add installation guide for Debian distribution (#2355)"
vagimeli Feb 4, 2023
ad80dab
Revert "Clean up RPM/YUM installation guide (#2371)"
vagimeli Feb 4, 2023
64a09ba
Revert "[DOC] Adds new site pages and content under Visualize (#2377)"
vagimeli Feb 4, 2023
799bbcc
Revert "Adds response fields to the cluster health API (#2385)"
vagimeli Feb 4, 2023
668c7a4
Continue writing tutorial
vagimeli Feb 4, 2023
eba801d
Continue writing
vagimeli Feb 6, 2023
6d018ca
Continue writing
vagimeli Feb 6, 2023
3626bad
Continue writing
vagimeli Feb 7, 2023
24fdacb
Continue writing
vagimeli Feb 8, 2023
8272282
Continue writing
vagimeli Feb 8, 2023
7092445
Continue writing
vagimeli Feb 8, 2023
96225e5
Final draft for tech review
vagimeli Feb 8, 2023
5294167
Image resizing
vagimeli Feb 9, 2023
7ef0a76
Resizing images
vagimeli Feb 9, 2023
5465b20
Copy edits
vagimeli Feb 9, 2023
188bbad
Update _dashboards/dashboard/index.md
vagimeli Feb 9, 2023
e409180
Update _dashboards/dashboard/index.md
vagimeli Feb 15, 2023
793661e
address tech review feedback
vagimeli Feb 16, 2023
0093fd2
address tech feedback
vagimeli Feb 17, 2023
d7252d7
Edit .gitignore file
vagimeli Feb 17, 2023
a59f77a
Update images
vagimeli Feb 17, 2023
3962c08
Update _dashboards/dashboard/index.md
vagimeli Feb 17, 2023
245f20f
Update _dashboards/dashboard/index.md
vagimeli Feb 17, 2023
c17197a
Update _dashboards/dashboard/index.md
vagimeli Feb 17, 2023
8aaafe8
address tech feedback
vagimeli Feb 17, 2023
7ebad03
address tech feedback
vagimeli Feb 17, 2023
192e10e
copy edits
vagimeli Feb 17, 2023
2ed9142
copy edits
vagimeli Feb 17, 2023
7f7203b
copy edits
vagimeli Feb 17, 2023
9b2d43b
copy edits
vagimeli Feb 17, 2023
25977bc
address tech review feedback
vagimeli Feb 20, 2023
dc8e496
address tech review feedback
vagimeli Feb 20, 2023
a91298d
Copy edits
vagimeli Feb 21, 2023
a2d426e
add definitions
vagimeli Feb 21, 2023
ebca6c1
Update index.md
vagimeli Feb 22, 2023
a33e7b1
Update index.md
vagimeli Feb 22, 2023
48cd0ad
Update index.md
vagimeli Feb 22, 2023
bec0855
Update index.md
vagimeli Feb 22, 2023
49a581e
Update index.md
vagimeli Feb 22, 2023
2f72bfc
Update index.md
vagimeli Feb 22, 2023
9a2664c
Update index.md
vagimeli Feb 22, 2023
5fa036b
Update index.md
vagimeli Feb 22, 2023
ff0f968
copy edits and graphics updates
vagimeli Feb 22, 2023
bcdf797
clean up unused images
vagimeli Feb 22, 2023
a0b7bf3
copy edit
vagimeli Feb 22, 2023
9e6c72d
Update index.md
vagimeli Feb 22, 2023
2bd1fa4
copy edit
vagimeli Feb 22, 2023
fa4eb32
Incorporated tech review comments
kolchfa-aws Feb 28, 2023
937b190
Implemented editorial comments
kolchfa-aws Mar 1, 2023
12163f6
Merge branch 'main' into 2349-dashboard-site-page
kolchfa-aws Mar 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions _dashboards/dashboard/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
---
layout: default
title: Creating dashboards
nav_order: 30
has_children: true
---

# Creating dashboards

The **Dashboard** application in OpenSearch Dashboards lets you visually represent your analytical, operational, and strategic data to help you quickly understand the trends in your data, giving you a high-level view of key metrics, simplifying data exploration, and delivering insights when and where you need them.

In this tutorial you'll learn the basics of creating a dashboard using the **Dashboard** application and OpenSearch sample data. The sample dataset has existing sample visualizations, and you can use those visualizations or create new visualizations for the dashboard. In this tutorial, you'll do both. Once you've completed this tutorial, you'll have learned the foundations of creating a new dashboard with multiple panels in OpenSearch Dashboards.

This OpenSearch Playground [dashboard example](https://playground.opensearch.org/app/dashboards#/view/722b74f0-b882-11e8-a6d9-e546fe2bba5f?_g=(filters:!(),refreshInterval:(pause:!f,value:900000),time:(from:now-7d,to:now))&_a=(description:'Analyze%20mock%20eCommerce%20orders%20and%20revenue',filters:!(),fullScreenMode:!f,options:(hidePanelTitles:!f,useMargins:!t),query:(language:kuery,query:''),timeRestore:!t,title:'%5BeCommerce%5D%20Revenue%20Dashboard',viewMode:view)) shows you what's possible with OpenSearch Dashboards.
{: .note}

## Getting familiar with the UI

Before getting started, let's get familiar with the **Dashboard** UI. The UI comprises the following main components:

![Dashboard user interface]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-UI.png)

- The **navigation panel** (A) on the left contains the OpenSearch Dashboards applications.
- The **search** bar (B) lets you search for documents and other objects and add filters.
- The **filter** (C) lets you narrow a dashboard's results.
- The **toolbar** (D) contains frequently used commands and shortcuts.
- The **time filter** (E) lets you customize the time and date.
- The **panel** (F) allows you to add existing visualizations to the dashboard or create new ones for the dashboard.

## Defining terminology

The following is some useful terminology for working with OpenSearch Dashboards and the **Dashboard** application:

- _Dashboards_ is the abbreviated name for OpenSearch Dashboards. OpenSearch Dashboards is an open-source visualization tool designed to work with OpenSearch.
- _Dashboard_ is the OpenSearch Dashboards application used to track, analyze, and display data.
- _dashboard_ or _dashboards_ are common names for a tool used to visually display data.
- _Panel_ is a term used to refer to a visualization displayed on a dashboard. The terms _panel_ and _visualization_ may be used interchangeably throughout this and other Dashboards documentation.

The following tutorial assumes you're either using your existing installation of OpenSearch Dashboards or using the [OpenSearch Playground](https://playground.opensearch.org/app/home#/). 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.
{: .note}

## Creating a dashboard and adding an existing visualization

To create a dashboard and add a sample visualization:

1. Connect to `https://localhost:5601`. The username and password are `admin`. Alternatively, go to the [OpenSearch Playground](https://playground.opensearch.org/app/home#/).
1. On the top menu, go to **OpenSearch Dashboards > Dashboard**.
1. From the **Dashboards** panel, choose **Create Dashboard**.
1. Choose the calendar icon and set the time filter to **Last 30 days**.
1. From the panel, choose **Add an existing**.
1. From the **Add panels** window, choose **[eCommerce] Promotion Tracking**, and then choose `x` to close the panel.

You've now created the following basic dashboard with a single panel, which you'll continue using throughout this tutorial.

![Basic dashboard with single panel]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-basic.png)

## Creating visualizations

Continuing with the dashboard you created in the preceding steps, you'll create a new visualization and save it to the dashboard:

1. From the dashboard toolbar, choose **Create new**.
1. From the **New Visualization** window, choose **Gauge** and then select the index pattern **opensearch_dashboards_sample_data_ecommerce**.
1. From the toolbar, choose **Save**.
1. In the **Save visualization** window, enter a title for the visualization. For example, the title for the gauge chart panel is [eCommerce] Orders.
1. Choose **Save and return**.

The gauge chart visualization is now saved and you are taken back to the dashboard. You'll see two visualizations on the dashboard, like the following.

![Dashboard showing visualizations combined in a single view]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-combined.png)

## Adding subsequent panels

Continuing with the dashboard you created in the preceding steps, you'll add an existing visualization to the dashboard:

1. From the dashboard toolbar, choose **Add**.
1. From the **Add panels** window, choose **[eCommerce] Sales by Category**.
1. Choose `x` to close the **Add panels** window.

You'll see an area chart visualization display on the dashboard, as shown in the following image.

![Adding another panel to the dashboard]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-adding-panels.png)

## Saving dashboards

When you've finalized your dashboard, save it. If you're saving a new dashboard:

1. In the toolbar, choose **Save**.
2. In the **Save dashboard** window, enter the **Title**. The **Description** is optional.
3. To save the time filter to the dashboard, select **Store time with dashboard**.
4. Choose **Save**.

## Customizing the look of a panel

To customize the panels, you'll need to be in edit mode:

- Choose **Edit** at the top right of the toolbar.

If you see **Create new** at the top right of the toolbar, you're already in edit mode.
{: .note}

Displaying a legend can give readers more information, while hiding a legend can give a panel a cleaner look. If you want to display or hide the panel legend:

- Choose the list icon in the panel's lower left corner.

If you want to change the color of the panel legend:

- From the visualization legend, select a category and then select a color from the flyout. The area chart updates with your change.

This color change is only saved for the current panel and dashboard and doesn't affect the saved visualization.
{: .note}

If you want to change the color of the panel legend in the visualization:

1. Choose the gear icon on the area chart panel.
2. From the **Options** window, select **Edit visualization**.
3. From the visualization legend, select a category and then select a color from the flyout. The area chart updates with your change.
4. Choose **Save and return**.

This color change affects the saved visualization and any dashboard that links to the visualization.
{: .note}

If you want to display, hide, or customize the panel title:

1. Choose the gear icon on the panel.
2. From the **Options** window, select **Edit panel title**.
3. From the **Customize panel**, enter a title under **Panel title** or toggle the **Show panel title** to hide the title.
4. Choose **Save**.

Changing panel titles only affects the particular panel on the particular dashboard and won't affect any other panel containing that same visualization or any other dashboard.
{: .note}

## Arranging panels

To organize panels, arrange them side by side, or resize them, you can use these options:

- To move a panel, select and hold the panel title or the top of the panel and drag to the new location.
- To resize a panel, choose the resize icon in the panel's lower-right corner and drag to the new dimensions.
- To view a panel in full screen mode, choose the gear icon (edit mode) or vertical ellipsis (⋮) at the top right of the panel and select **Maximize panel**. To minimize the full screen mode, choose the gear icon or vertical ellipsis and select **Minimize**.

The following is an example of a customized dashboard created by using this tutorial.

![Customized dashboard with panels arranged side by side and without legends]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-customized.png)
Binary file added images/dashboards/configure-bar-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-UI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-adding-panels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-combined.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-customized.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/dashboard-index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/discover-index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/edit-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/example-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/new-bar-viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.