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

Update quickstart to include dashboards #6004

Merged
merged 97 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from 41 commits
Commits
Show all changes
97 commits
Select commit Hold shift + click to select a range
9da1e70
Update quickstart to include dashboards redesign
vagimeli Dec 28, 2023
44a0460
Merge branch 'main' into quickstart-redesign
vagimeli Dec 28, 2023
f3a712f
Update quickstart to include dashboards redesign
vagimeli Dec 28, 2023
c957ec5
Update quickstart to include dashboards redesign
vagimeli Jan 3, 2024
727c3ea
Update quickstart to include dashboards redesign
vagimeli Jan 3, 2024
2cfa321
Updates to content and screenshots
vagimeli Jan 5, 2024
4a14b21
Updates to content and screenshots
vagimeli Jan 5, 2024
45ca0bd
Merge branch 'main' into quickstart-redesign
vagimeli Jan 5, 2024
8843561
Merge branch 'main' into quickstart-redesign
vagimeli Jan 8, 2024
daa9d14
Copyedit
vagimeli Jan 10, 2024
cbed625
Merge branch 'main' into quickstart-redesign
vagimeli Jan 10, 2024
7a5e749
Merge branch 'main' into quickstart-redesign
vagimeli Jan 11, 2024
5e92eec
Merge branch 'main' into quickstart-redesign
vagimeli Jan 11, 2024
07d0d9e
Merge branch 'main' into quickstart-redesign
vagimeli Jan 16, 2024
b3eb8fc
Merge branch 'main' into quickstart-redesign
vagimeli Jan 24, 2024
fbfb6f3
Copy edits and screenshot updates
vagimeli Jan 24, 2024
5362726
Merge branch 'main' into quickstart-redesign
vagimeli Feb 5, 2024
8d4c032
Update quickstart.md
vagimeli Feb 5, 2024
d4be24f
Add dark mode section
vagimeli Feb 5, 2024
261fe85
Update discover section
vagimeli Feb 6, 2024
16a6094
Update quickstart.md
vagimeli Feb 6, 2024
7de297f
Update quickstart.md
vagimeli Feb 6, 2024
0f32a7b
Update quickstart.md
vagimeli Feb 6, 2024
38b3d34
Update quickstart.md
vagimeli Feb 6, 2024
e029d92
Merge branch 'main' into quickstart-redesign
vagimeli Feb 6, 2024
33ec9c3
Merge branch 'main' into quickstart-redesign
vagimeli Feb 8, 2024
749bbc5
Merge branch 'main' into quickstart-redesign
vagimeli Feb 8, 2024
4c7a1b2
Update quickstart.md
vagimeli Feb 12, 2024
b108e98
Update quickstart.md
vagimeli Feb 12, 2024
4125309
Update quickstart.md
vagimeli Feb 12, 2024
dc05ebb
Update quickstart.md
vagimeli Feb 12, 2024
19f12b6
Update quickstart.md
vagimeli Feb 20, 2024
ae6ec77
Update quickstart.md
vagimeli Feb 20, 2024
90f36f1
Merge branch 'main' into quickstart-redesign
vagimeli Feb 20, 2024
0aa0247
Update content for relevancy
vagimeli Feb 20, 2024
af2a4e2
Update screenshots
vagimeli Feb 20, 2024
f373acc
Update screenshots
vagimeli Feb 20, 2024
c8f91a3
Edits
vagimeli Feb 20, 2024
a8ff097
Edits
vagimeli Feb 20, 2024
91d1565
Merge branch 'main' into quickstart-redesign
vagimeli Feb 20, 2024
95d643a
Remove inaccurate VisBuilder tutorial and replace with cross-ref to o…
vagimeli Feb 21, 2024
f4c63d0
Update _dashboards/quickstart.md
vagimeli Feb 26, 2024
06d3fc9
Update _dashboards/quickstart.md
vagimeli Feb 26, 2024
ddc1d1d
Update _dashboards/quickstart.md
vagimeli Feb 26, 2024
597b11c
Update _dashboards/quickstart.md
vagimeli Feb 26, 2024
5d56f43
Update quickstart.md
vagimeli Feb 26, 2024
0d6e0c2
Copy edits
vagimeli Feb 26, 2024
04b1861
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
78e2fd5
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
225bcc7
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
e920bac
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
ec73dff
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
b8fbe95
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
b799add
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
50bc9aa
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
fadfe2b
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
111e134
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
15694b1
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
280e777
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
5a0f1de
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
6655687
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
efe2071
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
89a9c90
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
8db94ab
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
ad3ab64
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
b063c3c
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
84641e4
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
4bdad1e
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
01f1462
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
5fac635
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
2c155f1
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
4c70673
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
66df8e5
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
a2f44bb
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
26533a2
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
705980b
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
9cbe173
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
cd9dd8d
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
b33117a
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
3599f24
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
f020174
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
a550004
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
23a2770
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
ab83354
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
9da1940
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
f0ba91d
Update _dashboards/quickstart.md
vagimeli Feb 27, 2024
102b155
Update quickstart.md
vagimeli Feb 27, 2024
6428084
Merge branch 'main' into quickstart-redesign
vagimeli Feb 27, 2024
66827d8
Address editorial feedback
vagimeli Feb 28, 2024
d438f88
Revisions to incorporate quickstart editorial feedback
vagimeli Feb 28, 2024
503c7d1
add redirect
vagimeli Feb 28, 2024
1015d8d
copy edit
vagimeli Feb 28, 2024
11e89d6
copy edit
vagimeli Feb 28, 2024
884baaa
Update _dashboards/discover/index-discover.md
vagimeli Feb 29, 2024
453b5a8
Update _dashboards/discover/index-discover.md
vagimeli Feb 29, 2024
e9d773f
Address editorial review comments
vagimeli Feb 29, 2024
fc302bc
Merge branch 'main' into quickstart-redesign
vagimeli Feb 29, 2024
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
129 changes: 64 additions & 65 deletions _dashboards/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,120 +1,119 @@
---
layout: default
title: Quickstart guide
title: OpenSearch Dashboards quickstart
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd prefer that we keep "guide" for clarity rather than using "quickstart" as a noun. Also, if this is a standalone document, should we use title case here and in the following heading?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes to title case

nav_order: 2
has_children: false
redirect_from:
- /dashboards/quickstart-dashboards/
---

# Quickstart guide
# OpenSearch Dashboards quickstart
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

This quickstart guide covers the core concepts that you need to understand to get started with OpenSearch Dashboards. You'll learn how to:
This quickstart covers the following basics to help you get started with OpenSearch Dashboards:
Copy link
Collaborator

Choose a reason for hiding this comment

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

The organization here throws me off a little because the bullet points don't correspond to the headings that follow, and we take more of a marketing tone than I'd prefer. See my changes and let me know what you think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the rewrites. You've tightened the writing and improved readability.

vagimeli marked this conversation as resolved.
Show resolved Hide resolved

- Add sample data.
- Explore and inspect data.
- Visualize data.
- **Adding sample data:** Use pre-loaded visualizations, dashboards, and other tools to help you explore OpenSearch Dashboards before you add your own data.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **Exploring your data:** Dig into your data and see what is there.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **Creating visualizations:** Make your data more accessible by creating visualizations.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Here's a glance at the view you see when you open the **Dashboard** or **Discover** tool.
Your OpenSearch Dashboards view can be in either [light or dark mode](#turning-on-and-off-dark-mode), depending on your admin settings. To dock or undock the navigation pane, select the menu icon {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/menu-icon.png" class="inline-icon" alt="menu icon"/>{:/} and then **Dock navigation** or **Undock navigation**. A view of the OpenSearch Dashboards homepage is shown in the following image.

Check failure on line 18 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L18

[OpenSearch.Spelling] Error: undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 18, "column": 148}}}, "severity": "ERROR"}

Check failure on line 18 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L18

[OpenSearch.Spelling] Error: Undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: Undock. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 18, "column": 354}}}, "severity": "ERROR"}
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's either make this its own note or combine it with the following note.


<img src="{{site.url}}{{site.baseurl}}/images/dashboards/new-look.png" alt="Light and dark mode UI on Discover and Dashboard tools' home page" width="700">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/opensearch-dashboards-home.png" alt="OpenSearch Dashboards homepage" width="700">

{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/alert-icon.png" class="inline-icon" alt="alert icon"/>{:/} **Note**<br>Before you get started, make sure you've installed OpenSearch and OpenSearch Dashboards. For information about installation and configuration, see [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/) and [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/).
{: .note}

## Adding sample data
The following sections include tutorials on using OpenSearch Dashboards applications and tools. You can use your own environment or the [OpenSearch Playground](https://playground.opensearch.org/app/home#/), which runs on the latest version of OpenSearch.
natebower marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

I incorporated this content into the introductory sentence, with the exception of "which runs on the latest version of OpenSearch." If this information is critical, let's find a way to provide it elsewhere, perhaps in one of the notes.

Copy link
Contributor Author

@vagimeli vagimeli Feb 27, 2024

Choose a reason for hiding this comment

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

I incorporated this content into the introductory sentence, with the exception of "which runs on the latest version of OpenSearch." If this information is critical, let's find a way to provide it elsewhere, perhaps in one of the notes.

@natebower Your changes tighten the wording and improve readability. I accepted them.


Sample datasets come with visualizations, dashboards, and other tools to help you explore Dashboards before you add your own data. To add sample data, perform the following steps:
## Adding sample data

1. Verify access to OpenSearch Dashboards by connecting to [http://localhost:5601](http://localhost:5601) from a browser. The default username and password are `admin`.
1. On the OpenSearch Dashboards **Home** page, choose **Add sample data**.
2. Choose **Add data** to add the datasets, as shown in the following image.
The [**Sample flight data**](https://playground.opensearch.org/app/home#/tutorial_directory) is used in the tutorials throughout this quickstart.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .note}

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-sample-data.png" alt="Sample datasets" width="700">
To add sample data, follow these steps:

## Exploring and inspecting data
1. On the OpenSearch Dashboards **Home** page, choose either **Add sample data**. Alternatively, choose **Add data** from the upper-right toolbar.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
2. On the **Add sample data** page, choose the datasets you want to add. The following image shows a screenshot.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

In [**Discover**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/), you can:
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-sample-data-2.png" alt="Adding sample data window" width="700">

- Choose data to explore, set a time range for that data, search it using [Dashboards Query Language (DQL)]({{site.url}}{{site.baseurl}}/dashboards/dql/), and filter the results.
- Explore the data, view individual documents, and create tables summarizing the data.
- Visualize your findings.
## Using the Discover application

Check failure on line 39 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L39

[OpenSearch.HeadingCapitalization] 'Using the Discover application' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Using the Discover application' is a heading and should be in sentence case.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 39, "column": 4}}}, "severity": "ERROR"}

### Try it: Getting familiar with Discover
With [**Discover**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/), you can:

1. On the OpenSearch Dashboards **Home** page, choose **Discover**.
1. Change the [time filter]({{site.url}}{{site.baseurl}}/dashboards/discover/time-filter/) to **Last 7 days**, as shown in the following image.
- Choose data to analyze, set a time range for that data, search it using [Dashboards Query Language (DQL)]({{site.url}}{{site.baseurl}}/dashboards/dql/), and filter the results.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Analyze your data by querying and filtering, viewing results in a table, and examining documents.
- Display the distribution of your data in histograms.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/last-7--days.png" alt="Time filter interface" width="250"/>
The following steps give you a basic overview about using the Discover tool:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

2. Search using the DQL query `FlightDelay:true AND DestCountry: US AND FlightDelayMin >= 60` and then choose **Update**. You should see results for US-bound flights delayed by 60 minutes or more, as shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dql-search-field.png" alt="DQL search field example" width="700"/>
1. From the OpenSearch Dashboards navigation menu, choose **Discover**.
2. On the **Discover** page, choose the index pattern `opensearch_dashboards_sample_data_flights` from the dropdown menu on the upper-left side of the page.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
3. Select the calendar icon {::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/calendar-oui.png" class="inline-icon" alt="calendar icon"/>{:/} to change the [time filter]({{site.url}}{{site.baseurl}}/dashboards/discover/time-filter/) from the default of **Last 15 minutes** to **Last 7 days**.
4. In the DQL search bar, input `FlightDelay:true AND DestCountry: US AND FlightDelayMin >= 60` and then select **Update**. Results for US-bound flights delayed by 60 minutes or more are shown.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
5. Filter data by selecting **Add filter** from under the DQL search bar and then selecting a **Field**, **Operator**, and **Value** from the dropdown lists on the **Edit Filter** pop-up window. For example, select `FlightDelayType`, **is**, and **Weather Delay**.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

3. To filter data, choose **Add filter** and then select an **Available field**. For example, select `FlightDelayType`, **is**, and **Weather delay** from the **Field**, **Operator**, and **Value** dropdown lists, as shown in the following image.
The following image shows the view you see once you have completed the preceding steps.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/filter-data-discover.png" alt="Filter data by FlightDelayType field" width="250"/>
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/opensearch-dashboards-discover.png" alt="Discover output of steps 1 through 6" width="700">

## Visualizing data
## Using the Dashboards application

Check failure on line 59 in _dashboards/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _dashboards/quickstart.md#L59

[OpenSearch.HeadingCapitalization] 'Using the Dashboards application' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Using the Dashboards application' is a heading and should be in sentence case.", "location": {"path": "_dashboards/quickstart.md", "range": {"start": {"line": 59, "column": 4}}}, "severity": "ERROR"}

Raw data can be difficult to comprehend and use. Data visualizations help you prepare and present data in a visual form. In **Dashboard** you can:
With **Dashboards**, you can:

- Display data in a single view.
- Build dynamic dashboards.
- Create and share reports.
- Embed analytics to differentiate your applications.

### Try it: Getting familiar with Dashboard
The following steps give you a basic overview about using the Dashboard tool:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. On the OpenSearch Dashboards **Home** page, choose **Dashboard**.
1. Choose **[Flights] Global Flight Data** in the **Dashboards** window, as shown in the following image.
1. On the OpenSearch Dashboards **Home** page, choose **Dashboards** .
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
2. From the search toolbar, search for **[Flights] Global Flight Dashboard** and then select it. You'll see a pre-loaded dashboard with visuals, including charts, maps, and data tables.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
3. To add other panels to the dashboard, select the **Edit** button and then choose **Add** from the toolbar. The **Add panels** window then opens.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
4. From the search toolbar in the **Add panels** window, search for the existing panel **[Flights] Delay Buckets** and then select it. A pop-up message confirms that you've added the panel.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
5. Select close `x` to exit the **Add panels** window.
6. View the newly added panel, **[Flights] Delay Buckets**, at the end of the dashboard.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dashboard-flight-quickstart.png" alt="Data visualization dashboard" width="700"/>
The following image shows a view you see once you have completed the preceding steps.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. To add panels to the dashboard, choose **Edit** and then **Add** from the toolbar.
1. In the **Add panels** window, choose the existing panel **[Flights] Delay Buckets**. You'll see a pop-up window on the lower right confirming that you've added the panel.
1. Select `x` to close the **Add panels** window.
1. View the added panel **[Flights] Delay Buckets**, which is added as the last panel on the dashboard, as shown in the following image.
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-panel2.png" alt="Add panel tutorial screen view" width="700">

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-panel.png" alt="Add panel to dashboard" width="700"/>

### Try it: Creating a visualization panel
For information about using a specific data visualization type, such as VisBuilder, go to [Building data visualizations]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/). For information about using dashboards and visualizations in **Observability**, go to [Observability]({{site.url}}{{site.baseurl}}/observing-your-data/).
{: .note}

Continuing with the preceding dashboard, you'll create a bar chart comparing the number of canceled flights and delayed flights to delay type and then add the panel to the dashboard:
### Interacting with data using Dashboards
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. Change the default [time range]({{site.url}}{{site.baseurl}}/dashboards/discover/time-filter/) from **24 hours** to **Last 7 days**.
1. In the toolbar, choose **Edit**, then **Create new**.
1. Select **VisBuilder** in the **New Visualizations** window.
1. In the **Data Source** dropdown list, choose `opensearch_dashboards_sample_data_flights`.
1. Drag the fields **Cancelled** and **FlightDelay** to the y-axis column.
1. Drag the field **FlightDelayType** to the x-axis column.
1. Choose **Save** and name the visualization in the **Title** field.
2. Choose **Save and return**. The following bar chart is added as the last panel on the dashboard, as shown in the following image.
Interactive dashboards allow you to analyze data in more depth and filter it in several ways. With **Dashboards**, you can interact directly with data through the use of dashboard-level filters.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/viz-panel-quickstart.png" alt="Creating a visualization panel" width="700"/>
Take your previous dashboard and follow these steps to further analyze and filter the sample flight data:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## Interacting with data
1. On the **[Flights] Airline Carrier** panel, choose **OpenSearch-Air**. The dashboard updates automatically.
2. Choose **Save** to save the customized dashboard.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Interactive dashboards allow you analyze data in more depth and filter it in several ways. In Dashboards, you can interact directly with data on a dashboard by using dashboard-level filters. For example, continuing with the preceding dashboard, you can filter to show delays and cancellations for a specific airline.
Another option is to use the dashboard toolbar to apply filters. Follow these steps to learn about this feature:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

### Try it: Interacting with the sample flight data
1. In the dashboard toolbar, choose **Add filter**.
2. From the **Field**, **Operator**, and **Value** dropdown lists, choose **Carrier**, **is**, and **OpenSearch-Air**, respectively, as shown in the following image.
3. Choose **Save**. The dashboard updates automatically.

1. On the **[Flights] Airline Carrier** panel, choose **OpenSearch-Air**. The dashboard updates automatically.
1. Choose **Save** to save the customized dashboard.
The following image shows the view you see once you have completed the preceding steps.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Alternatively, you can apply filters using the dashboard toolbar:
<img src="{{site.url}}{{site.baseurl}}//images/<insert image>" alt="Screenshot of Dashboard tutorial panel view" width="700">

1. In the dashboard toolbar, choose **Add filter**.
1. From the **Field**, **Operator**, and **Value** dropdown lists, choose **Carrier**, **is**, and **OpenSearch-Air**, respectively, as shown in the following image.
## Turning on and off dark mode
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/edit-filter.png" alt="Edit field interface" width="400"/>
Turning on and off dark mode in OpenSearch Dashboards requires administrative access. If you are an administrator, follow these steps:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

"permissions" instead of "access"?


1. Choose **Save**. The dashboard updates automatically, and the result is the dashboard shown in the following image.
1. Navigate to **Management** > **Dashboards Management** > **Advanced Settings**.
2. Scroll down to the **Appearance** section and locate the **Dark mode** option.
3. Use the toggle switch to turn on or turn off dark mode for all users of your OpenSearch Dashboards instance.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
4. Select the **Save changes** button and then the **Reload** button. Changes take effect immediately, so you will see the updated theme right away, similar to the view shown in the following image.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/interact-filter-dashboard.png" alt="Dashboard view after applying Carrier filter" width="700"/>
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dark-mode.png" alt="Dark mode view" width="700">

## Next steps

- **Visualize data**. To learn more about data visualizations in OpenSearch Dashboards, see [**Building data visualizations**]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/).
- **Create dashboards**. To learn more about creating dashboards in OpenSearch Dashboards, see [**Creating dashboards**]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/).
- **Explore data**. To learn more about exploring data in OpenSearch Dashboards, see [**Exploring data**]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/).
- **Visualize data.** To learn more about data visualizations in OpenSearch Dashboards, go to [Building data visualizations]({{site.url}}{{site.baseurl}}/dashboards/visualize/viz-index/).
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **Create dashboards.** To learn more about creating dashboards in OpenSearch Dashboards, go to [Creating dashboards]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/).
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- **Gain data insights.** To learn more about your data in OpenSearch Dashboards, go to [Exploring data]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/).
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would change the name of the linked page to "Analyzing data" and take a look at our word choices across the Dashboards documentation. We seem to do a lot of "exploring," "discovering," and "unlocking," when it would be better to use a word that reflects what the user will actually do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would change the name of the linked page to "Analyzing data" and take a look at our word choices across the Dashboards documentation. We seem to do a lot of "exploring," "discovering," and "unlocking," when it would be better to use a word that reflects what the user will actually do.

@natebower I created an issue based on this comment. #6531

- **Ingest data.** To learn more about ingesting data in OpenSearch, go to [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/) and [Ingest pipelines]({{site.url}}{{site.baseurl}}/ingest-pipelines/).
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we mean "to learn more about using OpenSearch for data ingestion"?

Binary file added images/dashboards/add-panel2.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/add-sample-data-2.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/dark-mode.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/dashboards-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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-basics.png
Copy link

Choose a reason for hiding this comment

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

Let's replace this mockups with
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Replaced

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-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/icons/menu-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading