-
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 32 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,163 @@ | ||||||
--- | ||||||
layout: default | ||||||
title: Creating dashboards | ||||||
nav_order: 30 | ||||||
has_children: true | ||||||
--- | ||||||
|
||||||
# Creating dashboards | ||||||
|
||||||
A dashboard combines multiple data visualizations into a single view. With the **Dashboard** application you can: | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
- Get started with pre-built panels and dashboards and customize display properties to create the dashboard you need. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
- Analyze, monitor, and alarm on metrics, logs, and traces across multiple data sources. | ||||||
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. This seems out of scope for a beginner-targeted tutorial, particularly because we haven't yet launched the anywhere project. I'd recommend removing. 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. Good point. In thinking more broadly about dashboards capabilities, I've revised this intro. |
||||||
- Create interactive dashboards and share them with anyone in your organization. | ||||||
|
||||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dashboard-index.png" alt="Single-view dashboard in OpenSearch Dashboards" width="600" height="300"> | ||||||
|
||||||
Before you begin this tutorial, make sure you've installed OpenSearch and OpenSearch Dashboards and that you've connected to Dashboards at [http://localhost:5601](http://localhost:5601). The username and password are `admin`. | ||||||
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. A bit out of scope, but for the target user, I think it's a better assumption to expect that they'll either be doing it on their existing installation of OpenSearch Dashboards, or else on the playground: https://playground.opensearch.org/app/home. Although neither is perfect, since sample data may not be available on the former, and the latter doesn't support saving. 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. @joshuarrrr Please confirm the revised text addresses your feedback. |
||||||
{: .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
|
||||||
|
||||||
In this tutorial you'll learn the basics of creating a dashboard using the **Dashboard** application and OpenSearch sample data. Before getting started, get familiar with the Dashboard user interface. The user interface comprises five main parts, as shown in the following image: | ||||||
|
||||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/user-interface.png" alt="Dashboard user interface" width="600" height="300"> | ||||||
|
||||||
- The **navigation panel** (A) on the left contains the OpenSearch Dashboards applications. | ||||||
- The **toolbar** (B) contains frequently used commands and shortcuts. | ||||||
- The **search** bar (C) allows you to search for documents and other objects and add filters. | ||||||
- The **time filter** (D) allows you to customize the time and date. | ||||||
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. If we're having separate items for search and time bar, I'd also include the filter bar (below C), or else include it as part of C. |
||||||
- The **panel** (E) allows you to add existing visualizations to the dashboard or create new ones for 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. nit - extra empty line. |
||||||
|
||||||
_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. | ||||||
{: .note} | ||||||
|
||||||
## Adding sample data | ||||||
|
||||||
If you haven't already added the OpenSearch Dashboards sample datasets as described in [Quickstart guide for OpenSearch Dashboards](https://opensearch.org/docs/latest/dashboards/quickstart-dashboards/), add them before proceeding to the next steps. **Sample eCommerce orders** is used for this tutorial. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
To add the sample dataset: | ||||||
|
||||||
1. On the OpenSearch Dashboards **Home** page, choose **Add sample data**. | ||||||
2. Choose **Add data** and choose **Sample eCommerce orders**. | ||||||
|
||||||
## Creating dashboards | ||||||
|
||||||
Now that you've added the sample data, you can create a dashboard using that 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. | ||||||
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. I think we could also have them look at one of the sample dashboards first, and then say the goal of this tutorial will be to create something like that from scratch. 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. Good point. Change made. |
||||||
|
||||||
1. From the navigation panel, choose **Dashboard**. | ||||||
2. From the **Dashboards** window, choose **Create Dashboard**. | ||||||
3. Set the time filter to **Last 30 days**. | ||||||
4. Choose **Add an existing**. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
5. From the **Add panels** window, choose **Create new** and **Visualization**. This is a shortcut for creating a dashboard and a visualization in one flow. Alternatively, you can use the **Visualize** application to create visualizations and then add them to the dashboard. | ||||||
6. From the **New Visualization** window, choose **[eCommerce] Average Sold Quantity**. The donut chart is added to the dashboard. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
You've created a basic dashboard like the following, which you'll continue using throughout this tutorial. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
 | ||||||
|
||||||
## Creating and saving 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 **Vertical Bar** and then select the index pattern **opensearch_dashboards_sample_data_ecommerce**. You'll see an image like the following. | ||||||
|
||||||
 | ||||||
|
||||||
1. Configure the chart's **Data** settings by verifying **Metrics** is **Y-axis Count**. | ||||||
1. From the **Buckets** panel, choose **Add** and select **X-axis** from the **Add Bucket** dropdown list. | ||||||
1. From the **Aggregation** dropdown list, select **Date histogram**. | ||||||
1. Choose **Update**. You'll see a bar chart visualization like the following: | ||||||
|
||||||
 | ||||||
|
||||||
1. From the toolbar, select **Save** | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
1. In the **Save visualization** window, add a title for the visualization. For example, the title for the bar chart panel is Order Date. | ||||||
1. Select **Save and return**. | ||||||
|
||||||
The bar chart visualization is now saved and you are taken back to the dashboard. You'll see three visualizations on the dashboard, as shown in the following image: | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
 | ||||||
|
||||||
## Adding panels | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
Continuing with the dashboard you created in the preceding steps, you'll add a visualization to the dashboard. | ||||||
|
||||||
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. | ||||||
|
||||||
You'll see an area chart visualization display on the dashboard, as shown in the following image: | ||||||
|
||||||
 | ||||||
|
||||||
## Editing visualizations | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
You can edit visualizations, configure panels, and specify labels for a panel. For example, you can change the visualization's colors, title, and other attributes. Visualizations can be edited in the panel itself or in edit mode. Only changes made in edit mode are persistent, that is, they are saved in the visualization itself and will be reflected on any dashboard that uses the visualization. Editing in the panel is helpful for making minor changes at the dashboard level without saving them. | ||||||
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. I think usage of the term "edit mode" here is confusing, particularly because the dashboard itself has an edit mode and a view mode. What we want to distinguish between is tweaking the panel itself vs actually editing the visualization itself. Panel changes include:
I think it might be easier to re-arrange this section to just cover those topics as part of the tutorial, and then mention that it's separate from editing the 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. Revised. 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. @joshuarrrr Will you review this revised section? Do you think we should have a section herein on editing visualizations? Or do you think that tutorial would be better suited to the Building data visualizations section? |
||||||
|
||||||
Follow these steps to edit in the panel: | ||||||
|
||||||
1. Select a category in the legend and then select a color from the flyout. | ||||||
|
||||||
Follow these steps to use edit mode: | ||||||
|
||||||
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 edit. | ||||||
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
|
||||||
|
||||||
Using the **Options** window also allows you to edit or hide the title for a particular panel without applying the changes across the dashboard overall. | ||||||
|
||||||
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**. | ||||||
|
||||||
To hide the legend, select the list icon in the panel's lower left corner. | ||||||
|
||||||
## 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 and drag to the new location. | ||||||
- 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 to open the panel menu and then then select **More > Maximize panel**. | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
The following is an example of a customized dashboard showing visualizations arranged side by side and without legends: | ||||||
|
||||||
 | ||||||
|
||||||
## Filtering documents | ||||||
|
||||||
Filtering documents is helpful when you want to review data in an ad hoc manner. You can filter documents by applying filters and/or using Dashboards Query Language (DQL). For information about DQL, see [Using Dashboards Query Language]({{site.url}}{{site.baseurl}}/dashboards/discover/dql/). The dashboard queries the data it needs using the filter and/or DQL and applies the filter across the dashboard, that is, to all visualizations on 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. I'd drop the first sentence. DQL-based searches and filters feel more complex than the rest of this tutorial. |
||||||
|
||||||
To filter the data by applying a filter: | ||||||
|
||||||
1. From the dashboard toolbar, choose **Add filter**. | ||||||
2. From the **Edit filter** flyout, select a field, operator, and value. For example, select **geoip.region_name**, **is**, and **California**, as shown in the following image: | ||||||
|
||||||
 | ||||||
|
||||||
3. Choose **Save**. The filter is applied to all visualizations on the dashboard. | ||||||
4. To save the dashboard and filter, choose **Save** from the toolbar and then add a title and choose **Save** from the **Save dashboard** window. | ||||||
|
||||||
 | ||||||
|
||||||
To filter documents using DQL: | ||||||
|
||||||
1. From the DQL toolbar, specify the search term. For example, input `geoip.region_name: New York` in the query field. | ||||||
2. Select **Update**. A dashboard similar to the following is displayed: | ||||||
|
||||||
 | ||||||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
## 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. | ||||||
3. To save the time filter to the dashboard, select **Store time with dashboard**. | ||||||
4. Choose **Save**. |
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.
This may be out of scope so feel free to ignore, but I think it would be helpful to have an admonition somewhere that disambiguates "dashboards" as a shorthand for "OpenSearch Dashboards" (the project or the application) and the "Dashboard" application that we're discussing here. Only because it's a common point of confusion even for project contributors and maintainers!
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.
Revised