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 32 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
163 changes: 163 additions & 0 deletions _dashboards/dashboard/index.md
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:
Copy link
Member

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised


- Get started with pre-built panels and dashboards and customize display properties to create the dashboard you need.
- Analyze, monitor, and alarm on metrics, logs, and traces across multiple data sources.
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

@vagimeli vagimeli Feb 16, 2023

Choose a reason for hiding this comment

The 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`.
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Getting familiar with user interface
## Getting familiar with the UI


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.
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The 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.

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.
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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**.
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.

You've created a basic dashboard like the following, which you'll continue using throughout this tutorial.

![Creating a basic dashboard]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-basic.png)

## 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.

![New visualization vertical bar chart]({{site.url}}{{site.baseurl}}/images/dashboards/new-bar-viz.png)

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:

![Configuring a visualization]({{site.url}}{{site.baseurl}}/images/dashboards/configure-bar-viz.png)

1. From the toolbar, select **Save**
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:

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

## Adding panels

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:

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

## Editing visualizations

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.
Copy link
Member

Choose a reason for hiding this comment

The 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:

  1. Toggling visibility of the legend
  2. Changing colors via the legend
  3. Toggling visibility of the panel title
  4. Changing the panel title

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Select the gear icon on the area chart panel.
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 edit.
4. Select **Save and return**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Select **Save and return**.
4. Choose **Save and return**.


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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Select the gear icon on the panel.
1. Choose the gear icon on the panel.

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. From the **Customize panel**, add a title under **Panel title** or toggle the **Show panel title** to hide the 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**.

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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


- 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- To resize, select the resize icon in the panel's lower right corner and drag to the new dimensions.
- To resize a panel, choose the resize icon in the panel's lower-right corner and drag to the new dimensions.

- To view in fullscreen mode, select the gear icon to open the panel menu and then then select **More > Maximize panel**.

The following is an example of a customized dashboard showing visualizations arranged side by side and without legends:

![Dashboard with panels arranged side by side and without legends]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-arranged.png)

## 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.
Copy link
Member

Choose a reason for hiding this comment

The 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:

![Adding a filter]({{site.url}}{{site.baseurl}}/images/dashboards/edit-filter.png)

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.

![Saving the dashboard and filter]({{site.url}}{{site.baseurl}}/images/dashboards/save-dashboard.png)

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:

![Filtering using DQL]({{site.url}}{{site.baseurl}}/images/dashboards/dashboard-dql.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. 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**.
17 changes: 0 additions & 17 deletions _dashboards/discover/index.md

This file was deleted.

136 changes: 0 additions & 136 deletions _dashboards/discover/multi-data-sources.md

This file was deleted.

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-arranged.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-dql.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-filter.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/new-area-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/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.
Binary file added images/dashboards/new-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/save-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/user-interface.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 removed images/discover-index.png
Binary file not shown.