[DOC] Update Discover index page (#4951)
Update UI screenshots and make copy edits to content --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
layout: default
|
||||
title: Using Dashboards Query Language
|
||||
parent: Exploring data
|
||||
title: Dashboards Query Language
|
||||
parent: Discover
|
||||
nav_order: 40
|
||||
redirect_from:
|
||||
- /dashboards/dql/
|
||||
---
|
||||
|
||||
# Using Dashboards Query Language
|
||||
# Dashboards Query Language
|
||||
|
||||
Dashboards Query Language (DQL) is a simple text-based query language for filtering data in OpenSearch Dashboards. Similar to [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index), DQL uses an HTTP request body. For example, to display your site visitor data for a host in the United States, you would enter `geo.dest:US` in the search field, as shown in the following image.
|
||||
|
||||
|
|
|
@ -1,104 +1,115 @@
|
|||
---
|
||||
layout: default
|
||||
title: Exploring data
|
||||
title: Discover
|
||||
nav_order: 20
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Exploring data
|
||||
# Discover
|
||||
Updated 2.10
|
||||
{: .label .label-purple }
|
||||
|
||||
**Discover** in OpenSearch Dashboards helps you extract insights and get value out of data assets across your organization. Discover enables you to:
|
||||
**Discover** is a tool for exploring your data in OpenSearch Dashboards. You can use **Discover** to visually represent your data on a dashboard and provide a high-level view of key metrics.
|
||||
|
||||
1. **Explore data**. You can explore, customize, and filter data as well as search data using [Dashboards Query Language (DQL)]({{site.url}}{{site.baseurl}}/dashboards/dql/).
|
||||
2. **Analyze data**. You can analyze data, view individual documents, and create tables summarizing data contents.
|
||||
3. **Visualize data**. You can display findings from your saved searches in a single dashboard that combines different data visualization types.
|
||||
{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/alert-icon.png" class="inline-icon" alt="alert icon"/>{:/} The legacy **Discover** tool will be deprecated in OpenSearch 2.11. The updated **Discover** tool provides new features and enhancements that make the data exploration experience in OpenSearch Dashboards more intuitive and user friendly. To use the updated tool now, install the [latest version of OpenSearch Dashboards](https://opensearch.org/downloads.html) or try out these features using [OpenSearch Playground](https://playground.opensearch.org/app/home#/).
|
||||
{: .note}
|
||||
|
||||
## Try it: Exploring sample data with Discover
|
||||
In this tutorial, you'll learn about using **Discover** to:
|
||||
|
||||
This tutorial shows you how to use Discover to analyze and understand a sample dataset. At the end of this tutorial, you should be ready to use Discover with your own data.
|
||||
- Add data.
|
||||
- Interpret and visualize data.
|
||||
- Share the data findings.
|
||||
- Set alerts.
|
||||
|
||||
Before starting this tutorial, make sure you've added the **Sample flight data**. See [Quickstart guide for OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/quickstart-dashboards/) for information about how to get started.
|
||||
{: .warning}
|
||||
#### Prerequisites
|
||||
|
||||
### Setting up data
|
||||
The following are prerequisites for using **Discover**:
|
||||
|
||||
Watch the following short video or start with the tutorial steps to learn how to set up a sample dataset in Discover.
|
||||
- Install [OpenSearch Dashboards 2.10 or later](https://opensearch.org/downloads.html).
|
||||
- Add OpenSearch [sample data]({{site.url}}{{site.baseurl}}/dashboards/quickstart/) or import your own data into OpenSearch.
|
||||
- Have a foundational understanding of OpenSearch [documents and indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/).
|
||||
|
||||
![Setting up the sample data in Discover]({{site.url}}{{site.baseurl}}/images/discover-setting-up-data.gif)
|
||||
## Import 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 **Home** page, choose **Discover** in the navigation pane.
|
||||
1. On the index pattern toolbar, select the **opensearch_dashboards_sample_data_flights** dataset.
|
||||
1. On the time filter toolbar, choose the calendar icon and then change the time range to **Last 7 days**.
|
||||
You must add data to OpenSearch before you can start analyzing it. This tutorial uses sample data. To add the sample data, follow these steps:
|
||||
|
||||
### Exploring the data fields
|
||||
1. On the OpenSearch Dashboards home page, choose **Add sample data**.
|
||||
2. Choose the desired sample data and select the **Add data** button. An example is shown in the following image.
|
||||
|
||||
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, as shown in the following image.
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/sample-data.png" alt="Add sample data interface" width="700"/>
|
||||
|
||||
![Exploring data fields interface]({{site.url}}{{site.baseurl}}/images/discover-data-fields.png)
|
||||
{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}//images/icons/info-icon.png" class="inline-icon" alt="info icon"/>{:/} **Note**<br>To learn about importing your own data, see [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/).
|
||||
{: .note}
|
||||
|
||||
Follow these steps to explore the data fields:
|
||||
## Define your search
|
||||
|
||||
1. View the list of **Available fields**.
|
||||
1. Choose **Cancelled** to view the values (`true` and `false`).
|
||||
1. Choose the plus (+) sign to add the field to the document table. The field will be automatically added to **Selected fields** and the document table.
|
||||
1. Select **FlightDelay** from the **Available fields** list, and then choose the plus (+) sign to add the field to the document table.
|
||||
1. Optional: Rearrange the table columns by selecting the table header and then choosing **Move left** or **Move right**.
|
||||
To define a search, follow these steps:
|
||||
|
||||
## Searching data
|
||||
1. On the OpenSearch Dashboards navigation menu, select **Discover**.
|
||||
2. Choose the data you want to work with. In this case, choose `opensearch_dashboards_sample_data_flights` from the upper-left dropdown menu.
|
||||
3. Select the calendar icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/calendar-oui.png" class="inline-icon" alt="calendar icon"/>{:/}) or clock icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/clock-icon.png" class="inline-icon" alt="clock icon"/>{:/}) to change the time range of your search. An example is shown in the following image.
|
||||
|
||||
You can use the search toolbar or enter a DQL query in the **DevTools** console to search data in Dashboards, as shown in the following image. The search toolbar is best for basic queries, such as searching by a field name. DQL is best for complex queries, such as searching data using a term, string, Boolean, date, range, or nested query.
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/discover-ui.png" alt="Discover interface showing flight sample data query" width="700"/>
|
||||
|
||||
![Searching data interface]({{site.url}}{{site.baseurl}}/images/discover-search.png)
|
||||
## Add data fields and get data details
|
||||
|
||||
Follow these steps to search data:
|
||||
The document table contains document data. Each row represents a single document, and each column contains a different document field representing metrics such as flight destination, average ticket price, and flight delay. You can add, delete, or modify data fields in a document table as needed to meet your data analysis requirements.
|
||||
|
||||
1. In the search toolbar, enter the Boolean query. For example, enter `FlightDelay:true AND FlightDelayMin >= 60` to search the data for flights delayed by 60 minutes or more.
|
||||
1. Choose **Update**.
|
||||
1. Optional: Choose the arrow (`>`) in a table row to expand the row and view the document table details.
|
||||
To add or delete fields in a document table, follow these steps:
|
||||
|
||||
## Filtering data
|
||||
1. View the data fields listed under **Available fields** and select the plus icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/plus-icon.png" class="inline-icon" alt="plus icon"/>{:/}) to add the desired fields to the document table. The field will be automatically added to both **Selected fields** and the document table. For this example, choose the fields `Carrier`, `AvgTicketPrice`, and `Dest`.
|
||||
1. To arrange or sort the columns, select the column header containing the field name and select the desired action. An example is shown in the following image.
|
||||
|
||||
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, as shown in the following image.
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/arrange-columns.png" alt="Document table interface" width="700"/>
|
||||
|
||||
![Filtering data interface]({{site.url}}{{site.baseurl}}/images/discover-filter.png)
|
||||
You can view individual or multiple fields in the document table. To gather information about the data in the document table, follow these steps:
|
||||
|
||||
Follow these steps to filter data:
|
||||
1. Choose the inspect icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/inspect-icon.png" class="inline-icon" alt="inspect icon"/>{:/}) to open the **Document Details** window.
|
||||
1. Review the data details. You can switch between the **Table** and **JSON** tabs to view the data in your preferred format.
|
||||
1. Select **View surrounding documents** to view data for other log entries either preceding or following your current document or select **View single document** to view a particular log entry.
|
||||
|
||||
1. In the filter bar, choose **Add filter**.
|
||||
1. Select options from the **Field**, **Operator**, and **Value** dropdown lists. For example, `Cancelled`, `is`, and `true`.
|
||||
### Search your data
|
||||
|
||||
You can use the search toolbar or enter a [DQL]({{site.url}}{{site.baseurl}}/dashboards/discover/dql/) query using the **DevTools** console to search data. While the search toolbar is best for basic queries, such as field name queries, DQL is best for complex queries, such as term, string, Boolean, date, range, or nested queries. DQL provides suggestions for fields and operators as you type, helping you build structured queries.
|
||||
|
||||
To search data, follow these steps:
|
||||
|
||||
1. Enter a simple query in the DQL search bar. For example, enter `FlightDelay:true`, which searches for delayed flights.
|
||||
1. Select the **Update** button to the right of the search bar.
|
||||
1. Enter a more complex query in the DQL search bar, and then select **Update**. For example, enter `FlightDelay:true AND FlightDelayMin >= 60`, which searches the data for flights delayed by 60 minutes or more.
|
||||
|
||||
### Filter your data
|
||||
|
||||
Filters allow you to narrow the results of a query by specifying certain criteria. You can filter by field, value, or range. The **Add filter** pop-up suggests the available fields and operators.
|
||||
|
||||
To filter your data, follow these steps:
|
||||
|
||||
1. Under the DQL search bar, choose **Add filter**.
|
||||
1. Select the desired options from the **Field**, **Operator**, and **Value** dropdown lists. For example, select `Cancelled`, `is`, and `true`.
|
||||
1. Choose **Save**.
|
||||
1. To remove the filter, choose the close icon (x) next to the filter name.
|
||||
1. Optional: Add more filters to further explore the data.
|
||||
1. To remove the filter, choose the cross icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/cross-icon.png" class="inline-icon" alt="cross icon"/>{:/}) next to the filter name.
|
||||
1. Add more filters to further explore the data.
|
||||
|
||||
## Analyzing data in the document table
|
||||
## Save a search
|
||||
|
||||
You can view the document table fields to better understand the data and gather insights for more informed decision-making:
|
||||
To save your search, including the query text, filters, and current data view, follow these steps:
|
||||
|
||||
1. Choose the arrow icon (>) to expand a table row.
|
||||
1. View the fields and details.
|
||||
1. Switch between the **Table** and **JSON** tabs to view the different formats, as shown in the following image.
|
||||
|
||||
![Analyzing data in the document table]({{site.url}}{{site.baseurl}}/images/discover-analyze.png)
|
||||
|
||||
## Saving the search
|
||||
|
||||
Saving a search saves the query text, filters, and current data view. To save your search to use it later, generate a report, or build visualizations and dashboards:
|
||||
|
||||
1. Choose the save icon in the toolbar.
|
||||
1. Select **Save** in the upper-right corner.
|
||||
1. Give the search a title, and then choose **Save**.
|
||||
1. Choose the save icon to access the saved search, as shown in the following image.
|
||||
1. Select **Open** to access the saved search.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/discover-save.png" alt= "Save search interface" width="350" height="350">
|
||||
## Create visual representations of your findings
|
||||
|
||||
## Visualizing the search
|
||||
To create visualizations of your data findings, follow these steps:
|
||||
|
||||
You can quickly visualize an aggregated field from **Discover**:
|
||||
1. Select the inspect icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/inspect-icon.png" class="inline-icon" alt="inspect icon"/>{:/}) next to the field you want to visualize. An example is shown in the following image.
|
||||
|
||||
1. From the **Available fields** list, select `FlightDelayType` and then choose **Visualize**, as shown in the following image.
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/discover-visual.png" alt="Visualize button in Discover" width="400"/>
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/discover-visualize.png" alt= "Visualizing search queries from Discover" width="350" height="350">
|
||||
2. Select the **Visualize** button. A visualization is displayed. An example is shown in the following image.
|
||||
|
||||
Dashboards creates a visualization for this field, which in this case is a basic bar chart, as shown in the following image.
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/visualize-discover.png" alt="Visual representation of data" width="700"/>
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/discover-visualize-2.png" alt= "Bar chart created from Discover" width="600" height="600">
|
||||
## Set alerts
|
||||
|
||||
You can set alerts to notify you when your data changes beyond the thresholds you define. To learn more about using **Discover** to create and manage alerts, see [Alerting dashboards and visualizations]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/dashboards-alerting/).
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
layout: default
|
||||
title: Adding multiple data sources
|
||||
parent: Exploring data
|
||||
title: Multiple data sources
|
||||
parent: Discover
|
||||
nav_order: 20
|
||||
---
|
||||
|
||||
# Adding multiple data sources
|
||||
# Multiple data sources
|
||||
|
||||
Use OpenSearch Dashboards to dynamically manage data sources, create index patterns based on those data sources, run queries against a specific data source, and combine visualizations in one dashboard.
|
||||
|
||||
|
|
|
@ -1,20 +1,20 @@
|
|||
---
|
||||
layout: default
|
||||
title: Setting the time filter
|
||||
parent: Exploring data
|
||||
title: Time filter
|
||||
parent: Discover
|
||||
nav_order: 10
|
||||
redirect_from:
|
||||
- /dashboards/get-started/time-filter/
|
||||
---
|
||||
|
||||
# Setting the time filter
|
||||
# Time filter
|
||||
|
||||
You can change the time range to display dashboard data over minutes, hours, days, weeks, months, or years.
|
||||
The time filter is used to set the time range, including minutes, hours, days, weeks, months, or years, that is displayed on your dashboard.
|
||||
|
||||
The default time range is **Last 15 minutes**. You can change the time range at the dashboard level or under **Dashboards Management** > **Advanced Settings** > **Time filter defaults**.
|
||||
{: .note}
|
||||
|
||||
To change the time range at the dashboard level, perform the following steps:
|
||||
To change the time range at the dashboard level, follow these steps:
|
||||
|
||||
1. From an OpenSearch Dashboards application (Discover, Dashboards, or Visualize), select the calendar icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/calendar-icon.png" class="inline-icon" alt="calendar icon"/>{:/}) on the right of the search bar.
|
||||
2. Select one of the time filter options, as shown in the following image:
|
||||
|
|
|
@ -15,7 +15,7 @@ This quickstart guide covers the core concepts that you need to understand to ge
|
|||
- Explore and inspect data.
|
||||
- Visualize data.
|
||||
|
||||
Before you get started, make sure you've installed OpenSearch and OpenSearch Dashboards. For information on 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/).
|
||||
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
|
||||
|
|
After Width: | Height: | Size: 172 KiB |
After Width: | Height: | Size: 61 KiB |
After Width: | Height: | Size: 54 KiB |
After Width: | Height: | Size: 578 KiB |
After Width: | Height: | Size: 50 KiB |
After Width: | Height: | Size: 609 KiB |
After Width: | Height: | Size: 115 KiB |
After Width: | Height: | Size: 4.7 KiB |
After Width: | Height: | Size: 4.6 KiB |
After Width: | Height: | Size: 4.7 KiB |
After Width: | Height: | Size: 4.3 KiB |
After Width: | Height: | Size: 4.7 KiB |
After Width: | Height: | Size: 4.9 KiB |
After Width: | Height: | Size: 4.3 KiB |
After Width: | Height: | Size: 4.6 KiB |