Skip to content

Commit

Permalink
[Discover][Doc] Improve main documentation (#91854) (#93656)
Browse files Browse the repository at this point in the history
Co-authored-by: gchaps <[email protected]>

Co-authored-by: gchaps <[email protected]>
  • Loading branch information
kertal and gchaps authored Mar 4, 2021
1 parent ec42331 commit 4fd56e3
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 26 deletions.
Binary file added docs/discover/images/discover-add-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 docs/discover/images/discover-maps.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 docs/discover/images/discover-search-field.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 docs/discover/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.
Binary file added docs/discover/images/geoip-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 56 additions & 26 deletions docs/user/discover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,29 @@

[partintro]
--
**_Tell {kib} where to find your data, then search and filter it for hidden insights and relationships._**
**_Gain insight to 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"
/>
++++

You’ve added your data, and now you’re ready to dig in. You have questions about your data.
[float]
=== Explore and query your data

You have questions about your data.
What pages on your website contain a
specific word or phrase? What events were logged most recently?
What processes take longer than 500 milliseconds to respond?
Expand All @@ -23,9 +43,6 @@ that summarize the contents of the data.
At the end of this tutorial, you’ll be ready to start exploring with your own
data in *Discover*.

[role="screenshot"]
image::images/Discover-Start.png[Discover]


[float]
=== Prerequisites
Expand All @@ -36,24 +53,6 @@ image::images/Discover-Start.png[Discover]
- 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]
[[find-the-data-you-want-to-use]]
=== Find your data
Expand Down Expand Up @@ -90,6 +89,9 @@ which can be overwhelming. You’ll modify this table to display only your field

. Scan through the list of **Available fields** to see
what’s 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.
+
Expand All @@ -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
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>>.
As you type, KQL prompts you with the fields you can search and the operators
you can use to build a structured query.
Expand All @@ -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 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:

. Click **Add filter**.
Expand Down Expand Up @@ -178,6 +189,9 @@ Saving a search saves the query and the filters.
. In the toolbar, 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]
=== Visualize your findings
Expand All @@ -186,6 +200,9 @@ visualize it from **Discover**.

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

. Drag `manufacturer.keyword` from the field list and drop it on
Expand All @@ -196,11 +213,26 @@ image:images/visualize-from-discover.png[Visualization that opens from Discover

. 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]
=== What’s next?

* <<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.
In **Advanced Settings**, you can configure the number of documents to show,
the table columns that display by default, and more.
Expand All @@ -209,8 +241,6 @@ the table columns that display by default, and more.

* <<reporting-getting-started, Present your findings in a report>>.

* <<discover-search-for-relevance, Search for relevance>>.

--

include::{kib-repo-dir}/management/index-patterns.asciidoc[]
Expand Down

0 comments on commit 4fd56e3

Please sign in to comment.