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] Exploring data with Discover #2435

Merged
merged 40 commits into from
Feb 1, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
7e03a3a
Create new content
vagimeli Jan 19, 2023
926cd73
First pass draft for tech review
vagimeli Jan 20, 2023
6b12e48
Address tech review feedback
vagimeli Jan 27, 2023
2a63c65
Update _dashboards/discover/index.md
vagimeli Jan 27, 2023
14d19c4
Update _dashboards/discover/index.md
vagimeli Jan 27, 2023
9640c7d
Update _dashboards/discover/index.md
vagimeli Jan 27, 2023
add179b
Update _dashboards/discover/index.md
vagimeli Jan 27, 2023
c438548
Copy edits
vagimeli Jan 30, 2023
db3c34a
Address doc review feedback
vagimeli Jan 30, 2023
4340872
Copy edits
vagimeli Jan 30, 2023
7c73ed2
Copy edits
vagimeli Jan 30, 2023
26bd602
Adjust image sizes
vagimeli Jan 30, 2023
59f06bb
Copy edits
vagimeli Feb 1, 2023
e23ca4f
Copy edits
vagimeli Feb 1, 2023
730647a
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
8486aa9
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
6cc930e
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
f8a6379
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
02680b7
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
d903ad0
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
d998530
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
473cde8
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
3659864
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
988a9c3
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
a112469
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
7fa42e6
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
3768896
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
f87052c
Update _dashboards/discover/index-discover.md
vagimeli Feb 1, 2023
06dc27a
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
0f70850
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
2b3adde
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
1f2c73a
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
245b0b6
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
b06fb17
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
8f21b41
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
39e0897
Update _dashboards/discover/multi-data-sources.md
vagimeli Feb 1, 2023
ec64bf5
Address editorial feedback
vagimeli Feb 1, 2023
440ea73
Address line 13 copy edit
vagimeli Feb 1, 2023
447b24a
Re-review to confirm editorial chages committed
vagimeli Feb 1, 2023
7fb3f80
Copy edit line 86
vagimeli Feb 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
93 changes: 85 additions & 8 deletions _dashboards/discover/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,94 @@
---
layout: default
title: Discover
nav_order: 10
title: Exploring data with Discover
nav_order: 20
has_children: true
---

# Discover
# Exploring data with Discover

**Discover** in OpenSearch Dashboards helps you extract insights and get value out of data assets across your organization. You can quickly ingest and query your data, display that data in visualizations and interactive dashboards, and deliver insights to your organization.
**Discover** in OpenSearch Dashboards helps you extract insights and get value out of data assets across your organization. Discover enables you to:

<img src="{{site.url}}{{site.baseurl}}/images/discover-index.png" alt="Discover user interface">
1. **Select data.** You can explore, customize, and filter data, as well as search data using the [Dashboards Query Language (DQL)]({{site.url}}{{site.baseurl}}/dashboards/dql/).
2. **Explore the data.** You can analyze data details, view individual documents, and create tables summarizing data contents.
3. **Visualize data.** You can display findings from your saved searches in a single dashboard showing different data visualization types.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## What's next?
## Try it: Exploring sample data with Discover
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

- [Running queries in the console]({{site.url}}{{site.baseurl}}/dashboards/run-queries/)
- [Creating a dashboard with multiple data sources]({{site.url}}{{site.baseurl}}/)
This tutorial shows you how to use Discover to analyze and understand a sample data set. At the end of this tutorial, you should be ready to use Discover with your own data.

Before continuing this tutorial, make sure you've added the **Sample flight data**. See [OpenSearch Dashboards Quickstart]() for more details on getting started.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .warning}
### Setting up data

![Setting up the sample data in Discover]({{site.url}}{{site.baseurl}}/images/discover-setting-up-data.gif)
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

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`.
2. On the **Home** page, select **Discover** in the navigation pane.
3. On the index pattern toolbar, select the **opensearch_dashboards_sample_data_flights** data set.
4. On the time filter toolbar, select the calendar icon and change the time range to **Last 7 days**.

### Exploring the data fields

In the Discover panel, you'll see a table that shows all the documents that match your search. The table includes a list of data fields that are available in the document table.

1. View the list of **Available fields**.
2. Select **Cancelled** to view the values (`true` and `false`).
3. Select the plus sign icon to add the field to the document table. You'll see this field automatically add to **Selected fields** and the document table.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
4. Select **FlightDelay** from the **Available fields** list, and then select the plus sign icon to add the field to the document table.
5. (Optional) Rearrange the table columns by selecting the table header and then **Move left** or **Move right**.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

![Exploring data fields interface]({{site.url}}{{site.baseurl}}/images/discover-data-fields.png)

## Searching data

You can use the search toolbar or DQL to search data in Dashboards. The search toolbar is best for basic queries, such as searching by a field name. DQL is best for more complex queries, such as searching data using a term query, string query, boolean query, date or range query, or nested query.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. In the search toolbar, enter the boolean query `FlightDelay:true AND FlightDelayMin >= 60` to search the data for flights delayed 60 minutes or longer.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
1. Select **Update**.
2. (Optional) Select the arrow icon `>` in a table row to expand the row and view the document table details.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

![Searching data interface]({{site.url}}{{site.baseurl}}/images/discover-search.png)

## Filtering data

Filters allow you to refine sets of documents to subsets of those documents. For example, you can filter data to include or exclude certain fields.

1. In the filter bar, select **Add filter**.
1. Select **Field > Operator > Value** (for example, `Cancelled > is > true`).
1. Select **Save**.
1. To remove the filter, select the close icon `x` next to filter name.
1. (Optional) Add more filters to further explore the data.

![Filtering data interface]({{site.url}}{{site.baseurl}}/images/discover-filter.png)

## Analyzing data in the document table

You can view the document table fields to better understand the data and gather insights for more informed decision-making.

1. Select the arrow icon `>` to expand a table row.
1. View the fields and details.
1. Switch between **Table** and **JSON** tabs to view the different formats.

![Analyzing data in the document table]({{site.url}}{{site.baseurl}}/images/discover-analyze.png)

## Saving the search

You can save your search to use it later, generate a report, or build visualizations and dashboards. Saving a search saves the query text, filters, and current data view.

1. Select the save icon in the toolbar.
1. Give the search a title, and then select **Save**.##
1. Select the save icon to access the saved search.

![Save search interface]({{site.url}}{{site.baseurl}}/images/discover-save.png)

## Visualizing the search

You can quickly visualize an aggregated field from **Discover**.

1. From the **Available fields** list, select `FlightDelayType`, and then select **Visualize**.
![Visualizing search queries from Discover]({{site.url}}{{site.baseurl}}/images/discover-visualize.png)

Dashboards creates a visualization for this field. In this example, it's a basic bar chart.

![Bar chart created from Discover]({{site.url}}{{site.baseurl}}/images/discover-visualize-2.png)
28 changes: 14 additions & 14 deletions _dashboards/discover/multi-data-sources.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: default
title: Multiple data sources
parent: Discover
title: Adding multiple data sources
parent: Exploring data with Discover
nav_order: 5
---

# Multiple data sources
# Adding multiple data sources

The multiple data sources feature is an experimental feature released in OpenSearch 2.4. It can't be used in a production environment. For updates on the feature’s progress or to leave feedback on improving the feature, see the [OpenSearch Forum discussion](https://forum.opensearch.org/t/feedback-experimental-feature-connect-to-external-data-sources/11144).
{: .warning }
Expand All @@ -14,14 +14,14 @@ You can add multiple data sources to a single dashboard. OpenSearch Dashboards a

In this tutorial we provide the steps for enabling the `data_source` setting in Dashboards; adding credentials, data source connections, and index patterns; and combining visualizations in a single dashboard.

## Try out the multiple data sources feature in your local environment
## Try it: Exploring multiple data sources feature in your local environment
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

This tutorial uses a preconfigured data source and index pattern, and you aren’t required to configure settings. However, you’ll need to enable the `data_source` setting in the configuration file before before getting started with exploring this feature.
{: .note }

The multiple data sources feature is experimental and can't be deployed into production. You can try it out with a sample data source and a sample index pattern. Before getting started, you must first edit the YAML configuration. The following section provides the steps for enabling the feature.

## Edit the YAML configuration to enable the multiple data sources feature
## Modifying the multiple data sources settings

Dashboards is configured in the cluster settings, and the multiple data sources feature is disabled by default. To enable it, you need to edit the configuration in `opensearch_dashboards.yml` and then restart the cluster.

Expand All @@ -33,7 +33,7 @@ To enable the feature:
4. Restart the Dashboards container.
5. Verify the feature configuration settings were created and configured properly by connecting to Dashboards through [http://localhost:5601](http://localhost:5601/) and viewing the **Stack Management** console. **Data Sources `Experimental`** will appear in the sidebar. Alternatively, you can open on [http://localhost:5601/app/management/opensearch-dashboards/dataSources](http://localhost:5601/app/management/opensearch-dashboards/dataSource).

## Create a data source connection
## Creating a data source connection

A data source connection specifies the parameters needed to connect to a data source. These parameters form a connection string for the data source. In Dashboards, you can add new data source connections or edit existing connections.

Expand All @@ -55,7 +55,7 @@ To create a new data source connection:
6. (Optional): Select the data source to verify that the settings are configured properly.
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-4.png" width=500 alt="Data sources settings verification user interface">

## Create an index pattern
## Creating an index pattern

Index patterns allow you to access the OpenSearch data that you want to explore. An index pattern selects the data to use and allows you to define the field properties. Learn how to load your own data and create an index pattern following these steps. This tutorial uses the preconfigured index pattern `opensearch_dashboards_sample_data_ecommerce Default`.

Expand All @@ -72,11 +72,11 @@ Index patterns allow you to access the OpenSearch data that you want to explore.
5. Select an option for the **Time field** and then choose **Create index pattern**.
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-8.png" width=500 alt="Index pattern time field user interface">

## Search data
## Searching data

Before you start searching for data, set up the time filter. The sample index pattern used for this tutorial contains time-based data. You can set a time filter that displays only the data within a specified time range, and you can select the time filter to change the time range or select a specific time range in the histogram.

### Use the time filter
### Using the time filter

1. In the Dashboards console, select **Discover** and confirm the index pattern being used is `opensearch_dashboards_sample_data_ecommerce`.
2. Select the calendar icon to change the time field. The default is **Last 15 minutes**.
Expand All @@ -86,7 +86,7 @@ Before you start searching for data, set up the time filter. The sample index pa
4. To set the start and end times, select the bar next to the time filter. In the popup, select **Absolute**, **Relative**, or **Now** and then specify the required options.
<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-10.png" width=300 alt="Start and end times user interface">

### Select a time range from the histogram
### Selecting a time range from the histogram

To select a time range for the histogram, you can do one of the following:

Expand All @@ -96,7 +96,7 @@ To select a time range for the histogram, you can do one of the following:

<img src="{{site.url}}{{site.baseurl}}/images/multi-data-sources-11.jpg" alt="Histogram user interface">

## Create visualizations
## Creating visualizations

Follow these steps to learn how to connect your visualizations in a single dashboard:

Expand All @@ -107,7 +107,7 @@ Follow these steps to learn how to connect your visualizations in a single dashb
5. In the **Aggregation** field, select **Date Histogram** and then **Update**.
6. Select **Save** and add the file name. This tutorial uses preconfigured visualizations, so you won’t be able to save your visualization.

## Connect visualizations in a single dashboard
## Connecting visualizations in a single dashboard

Follow these steps to connect your visualizations in a single dashboard:

Expand All @@ -122,7 +122,7 @@ Your dashboard might look like this:

You have now explored the data sources experimental feature. We look forward to your feedback on how we can improve this feature ahead of its release for production use.

## Limitations
## Understanding the feature's limitations
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

The following limitations apply to the OpenSearch 2.4 release of this experimental feature:

Expand All @@ -133,4 +133,4 @@ The following limitations apply to the OpenSearch 2.4 release of this experiment
## Related topics

* [OpenSearch 2.4.0 is ready for download](https://opensearch.org/blog/)
* [OpenSearch Forum](https://forum.opensearch.org/)
* [OpenSearch Forum](https://forum.opensearch.org/)
Binary file added images/discover-analyze.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/discover-data-fields.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/discover-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 removed images/discover-index.png
Binary file not shown.
Binary file added images/discover-save.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/discover-search.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/discover-setting-up-data.gif
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/discover-visualize-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/discover-visualize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.