-
Notifications
You must be signed in to change notification settings - Fork 520
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
Changes from 65 commits
1217869
dc69be4
da290a9
fa22d76
0210674
4aafa2f
fea90a1
8f7be38
d289b58
4091471
71aa7b5
515f11c
91579dd
f8c97b4
73a8ad3
9a74267
4fda7fd
f2119c9
ad80dab
64a09ba
799bbcc
668c7a4
eba801d
6d018ca
3626bad
24fdacb
8272282
7092445
96225e5
5294167
7ef0a76
5465b20
188bbad
e409180
793661e
0093fd2
d7252d7
a59f77a
3962c08
245f20f
c17197a
8aaafe8
7ebad03
192e10e
2ed9142
7f7203b
9b2d43b
25977bc
dc8e496
a91298d
a2d426e
ebca6c1
a33e7b1
48cd0ad
bec0855
49a581e
2f72bfc
9a2664c
5fa036b
ff0f968
bcdf797
a0b7bf3
9e6c72d
2bd1fa4
fa4eb32
937b190
12163f6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. For 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
{: .note} | ||||||
|
||||||
## Getting familiar with user interface | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
Before getting started, let's get familiar with the **Dashboard** user interface. The user interface comprises the following main parts: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe "elements" or "components" instead of "parts"? |
||||||
|
||||||
 | ||||||
|
||||||
- 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 | ||||||
|
||||||
Learn some useful terminology for working with OpenSearch Dashboards and the **Dashboard** application. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit - extra empty line. |
||||||
- _Dashboards_ is the abbreviated proper name for OpenSearch Dashboards. OpenSearch Dashboards is an open-source visualization tool designed to work with OpenSearch. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- _Dashboard_ is the application in OpenSearch Dashboards that is used to track, analyze, and display data at a glance. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- _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 Dashboard-related documentation. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Helpful! ❤️ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
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 aren't available. For example, sample datasets may not be in your existing installation and saving a dashboard isn't an option in the playground. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
{: .note} | ||||||
|
||||||
## Creating a dashboard and adding an existing visualization | ||||||
|
||||||
To create the dashboard and add the sample visualization: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
1. Connect to `https://localhost:5601`. The username and password are `admin`. Alternatively, go to the [OpenSearch playground](https://playground.opensearch.org/app/home#/). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
1. On the top menu, go to **OpenSearch Dashboards > Dashboard**. | ||||||
1. From the **Dashboards** panel, choose **Create Dashboard**. | ||||||
1. Select the calendar icon and set the time filter to **Last 30 days**. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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. | ||||||
|
||||||
 | ||||||
|
||||||
## Creating visualizations | ||||||
|
||||||
Continuing with the dashboard you created in the preceding steps, you'll create a new visualization and save it to the dashboard. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
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, add a title for the visualization. For example, the title for the gauge chart panel is [eCommerce] Orders. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
 | ||||||
|
||||||
## Adding subsequent panels | ||||||
|
||||||
Continuing with the dashboard you created in the preceding steps, you'll add an existing visualization to the dashboard. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
1. From the dashboard toolbar, choose **Add**. | ||||||
1. From the **Add panels** window, choose **[eCommerce] Sales by Category**. | ||||||
1. Select `x` to close the **Add panels** window. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
You'll see an area chart visualization display on the dashboard, as shown in the following image: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
 | ||||||
|
||||||
## Saving dashboards | ||||||
|
||||||
When you've finalized your dashboard, save it. If you're saving a new dashboard: | ||||||
|
||||||
1. In the toolbar, choose **Save**. | ||||||
2. On the **Save dashboard** window, enter the **Title**. The **Description** is optional. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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 top right in the toolbar. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
If you see **Create new** at the top right in the toolbar, you're already in edit mode. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
{: .note} | ||||||
|
||||||
Showing a legend can give readers more information, while hiding a legend can give it a cleaner look. If you want to show or hide the panel legend: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Instead of "it", let's name what we're referring to. |
||||||
|
||||||
- Select the list icon in the panel's lower left corner. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
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. Select the gear icon on the area chart panel. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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. Select **Save and return**. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
This color change affects the saved visualization and any dashboard that links to the visualization. | ||||||
{: .note} | ||||||
|
||||||
If you want to show or hide panel title or customize it: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
1. Select the gear icon on the panel. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
2. From the **Options** window, select **Edit panel title**. | ||||||
3. From the **Customize panel**, add a title under **Panel title** or toggle the **Show panel title** to hide the title. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
{: .note} | ||||||
|
||||||
## Arranging panels | ||||||
|
||||||
To organize panels, arrange them side-by-side, or resize them, you can use these options: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- To move, select and hold the panel title or the panel top and drag to the new location. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there better terminology than "panel top"? |
||||||
- To resize, select the resize icon in the panel's lower right corner and drag to the new dimensions. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- To view in fullscreen mode, select the gear icon (edit mode) or vertical ellipsis (⋮) in the top right of the panel and select **Maximize panel**. To minimize the fullscreen mode, select the gear icon or vertical ellipsis and select **Minimize**. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
The following is an example of a customized dashboard created in this tutorial. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
 |
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.