[Discover][Doc] Improve main documentation (#91854)

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Matthias Wilhelm 2021-03-04 19:09:43 +01:00 committed by GitHub
parent ebe1f1f6d3
commit 88f41565b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 56 additions and 26 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 401 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

View file

@ -3,9 +3,29 @@
[partintro] [partintro]
-- --
**_Tell {kib} where to find your data, then search and filter it for hidden insights and relationships._** **_Gain insight to your data._**
Youve added your data, and now youre ready to dig in. You have questions about your data. *Discover* enables you to quickly search and filter your data, get information
about structure of the fields, and visualize your data with *Lens* and *Maps*.
You can customize and save your searches and place them on a dashboard.
++++
<script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js">
</script>
<img
style="width: 100%; margin: auto; display: block;"
class="vidyard-player-embed"
src="https://play.vidyard.com/c2qBPz74BU16ncbvDWGvbz.jpg"
data-uuid="c2qBPz74BU16ncbvDWGvbz"
data-v="4"
data-type="inline"
/>
++++
[float]
=== Explore and query your data
You have questions about your data.
What pages on your website contain a What pages on your website contain a
specific word or phrase? What events were logged most recently? specific word or phrase? What events were logged most recently?
What processes take longer than 500 milliseconds to respond? What processes take longer than 500 milliseconds to respond?
@ -23,9 +43,6 @@ that summarize the contents of the data.
At the end of this tutorial, youll be ready to start exploring with your own At the end of this tutorial, youll be ready to start exploring with your own
data in *Discover*. data in *Discover*.
[role="screenshot"]
image::images/Discover-Start.png[Discover]
[float] [float]
=== Prerequisites === Prerequisites
@ -36,24 +53,6 @@ image::images/Discover-Start.png[Discover]
- You should have an understanding of {ref}/documents-indices.html[{es} documents and indices]. - You should have an understanding of {ref}/documents-indices.html[{es} documents and indices].
[float]
[[whats-you-goal-in-discover]]
=== Define your goal
When you explore your data in **Discover**, it's common to start with one or two goals:
- **Get an overview of what is happening.**
For example, you might look for
information on the overall health and performance of your ecommerce business,
and then share your findings in a report.
- **Find an answer to a specific question.** You want
to determine your customers' shopping preferences,
and then visualize your findings on a dashboard.
For this tutorial, your goal is to better manage your product inventory. You want to
know the top-selling products and on what day of the week these products sell the most.
[float] [float]
[[find-the-data-you-want-to-use]] [[find-the-data-you-want-to-use]]
=== Find your data === Find your data
@ -90,6 +89,9 @@ which can be overwhelming. Youll modify this table to display only your field
. Scan through the list of **Available fields** to see . Scan through the list of **Available fields** to see
whats in your data. You can also search for a field by name. whats in your data. You can also search for a field by name.
+
[role="screenshot"]
image:images/discover-sidebar-available-fields.png[Fields list that displays the top five search results, width=50%]
. Find the `manufacturer` field, and then click it to view the five most popular values for that field. . Find the `manufacturer` field, and then click it to view the five most popular values for that field.
+ +
@ -114,7 +116,13 @@ column header, and then use the move and sort controls.
One of the unique capabilities of **Discover** is the ability to combine One of the unique capabilities of **Discover** is the ability to combine
free text search with filtering based on structured data. free text search with filtering based on structured data.
To search all fields, enter a simple string in the **Search** field. To search particular fields and To search all fields, enter a simple string in the **Search** field.
[role="screenshot"]
image:images/discover-search-field.png[Search field in Discover]
To search particular fields and
build more complex queries, use the <<kuery-query,Kibana Query language>>. build more complex queries, use the <<kuery-query,Kibana Query language>>.
As you type, KQL prompts you with the fields you can search and the operators As you type, KQL prompts you with the fields you can search and the operators
you can use to build a structured query. you can use to build a structured query.
@ -137,6 +145,9 @@ You can filter results to include or exclude specific fields, filter for a value
and more. The **Add filter** popup prompts you with the fields you can filter and more. The **Add filter** popup prompts you with the fields you can filter
and the operators you can use. and the operators you can use.
[role="screenshot"]
image:images/discover-add-filter.png[Add filter dialog in Discover]
Exclude documents where day of week is not Wednesday: Exclude documents where day of week is not Wednesday:
. Click **Add filter**. . Click **Add filter**.
@ -178,6 +189,9 @@ Saving a search saves the query and the filters.
. In the toolbar, click **Save**. . In the toolbar, click **Save**.
. Give your search a title, and then click **Save**. . Give your search a title, and then click **Save**.
+
[role="screenshot"]
image:images/discover-save-saved-search.png[Save saved search in Discover, width=50%]
[float] [float]
=== Visualize your findings === Visualize your findings
@ -186,6 +200,9 @@ visualize it from **Discover**.
. From the **Selected fields** list, click `day_of_week`, and then click **Visualize**. . From the **Selected fields** list, click `day_of_week`, and then click **Visualize**.
+ +
[role="screenshot"]
image:images/discover-visualize.png[Discover sidebar field popover with visualize button, width=75%]
+
{kib} creates a visualization best suited for this field. {kib} creates a visualization best suited for this field.
. Drag `manufacturer.keyword` from the field list and drop it on . Drag `manufacturer.keyword` from the field list and drop it on
@ -196,11 +213,26 @@ image:images/visualize-from-discover.png[Visualization that opens from Discover
. Save your visualization for use on a dashboard. . Save your visualization for use on a dashboard.
If your documents contain geo point fields (image:images/geoip-icon.png[Geo point field icon, width=20px]), you can visualize them in **Maps**.
. Make sure the index pattern is set to **kibana_sample_data_ecommerce** and the configured time range
contains data.
. From the **Available fields** list, click `geoip.location`, and then click **Visualize**.
+
[role="screenshot"]
image:images/discover-maps.png[Map containing documents]
. Save your map for use on a dashboard.
[float] [float]
=== Whats next? === Whats next?
* <<kuery-query, Learn more about the structure of a KQL query>>. * <<kuery-query, Learn more about the structure of a KQL query>>.
* <<discover-search-for-relevance, Search for relevance>>.
* <<kibana-discover-settings, Configure Discover>> to better meet your needs. * <<kibana-discover-settings, Configure Discover>> to better meet your needs.
In **Advanced Settings**, you can configure the number of documents to show, In **Advanced Settings**, you can configure the number of documents to show,
the table columns that display by default, and more. the table columns that display by default, and more.
@ -209,8 +241,6 @@ the table columns that display by default, and more.
* <<reporting-getting-started, Present your findings in a report>>. * <<reporting-getting-started, Present your findings in a report>>.
* <<discover-search-for-relevance, Search for relevance>>.
-- --
include::{kib-repo-dir}/management/index-patterns.asciidoc[] include::{kib-repo-dir}/management/index-patterns.asciidoc[]