[DOCS] Updates Discover docs for 8.5 (#142021)

* [DOCS] Updates Discover docs for 8.5

* [DOCS] Adds resize for chart and updates images

* [DOCS] Incorporates review comments

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/discover/document-explorer.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/user/discover.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Incorporates review comments

* Update docs/discover/search-for-relevance.asciidoc

Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>

* [DOCS] Incorporated review comments

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Co-authored-by: Matthias Wilhelm <ankertal@gmail.com>
This commit is contained in:
gchaps 2022-10-10 15:21:23 -07:00 committed by GitHub
parent 1eb40b7368
commit 8ec6582f21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 100 additions and 64 deletions

View file

@ -1,19 +1,40 @@
[[document-explorer]]
== Explore your documents
*Discover* displays your documents in table format, so you can
best explore your data. Resize columns, set row height,
perform multi-column sorting, compare data, and more.
Fine tune your explorations by customizing *Discover* to bring out the the best view of your documents.
Adjust the chart height, modify the document table, and look inside a document.
[role="screenshot"]
image:images/customer.png[Customer last name, first initial in the document table]
image:images/discover.png[A view of the Discover app]
[float]
[[document-explorer-c]]
=== Hide or resize the chart
Hide or resize the chart for a better fit.
* To turn off the display of the chart, click
image:images/chart-icon.png[icon button for opening Show/Hide chart menu, width=24px]
to open the *Chart options* menu, and then click *Hide*.
* To change the chart height, drag the resize handle
image:images/resize-icon.png[two-line icon for increasing or decreasing the height of the chart, width=24px]
to the size you want.
The chart size is saved in your browser.
* To reset the height, open the *Chart options* menu, and then select *Reset to default height*.
[float]
[[document-explorer-customize]]
=== Modify the document table
Customize the appearance of the document table and its contents by resizing the columns and rows,
sorting and modifying the fields, and filtering the documents.
[float]
[[document-explorer-columns]]
=== Reorder and resize columns
Use drag and drop to organize the columns and improve the view of the data.
==== Reorder and resize the columns
* To move a single column, click its header. In the dropdown menu,
click *Move left* or *Move right*.
@ -22,26 +43,26 @@ click *Move left* or *Move right*.
In the pop-up, drag the column names to their new order.
* To resize a column, drag the right edge of the column header until the column is the width that you want.
+
Column widths are stored with a saved search. When you visualize saved searches on dashboards, the saved search appears the same as in **Discover**.
[float]
[[document-explorer-row-height]]
=== Adjust row height
==== Adjust the row height
To set the row height to 1 or more lines, or automatically
To set the row height to one or more lines, or automatically
adjust the height to fit the contents, click the row height icon
image:images/row-height-icon.png[icon to open the Row height pop-up].
[role="screenshot"]
image::images/document-explorer-row-height.png[Row height settings for the document table, width="75%"]
image::images/document-explorer-row-height.png[Row height settings for the document table, width="50%"]
[float]
[[document-explorer-sort-data]]
=== Sort data
==== Sort the fields
Sort your data by one or more fields, in ascending or descending order.
Sort the data by one or more fields, in ascending or descending order.
The default sort is based on the time field, from new to old.
To add or remove a sort on a single field, click the
@ -49,38 +70,69 @@ column header, and then select the sort order.
To sort by multiple fields:
. In the document table, click the *field sorted* option.
. Click the *field sorted* option.
+
[role="screenshot"]
image::images/document-explorer-sort-data.png[Pop-up in document table for sorting columns, width="75%"]
image::images/document-explorer-sort-data.png[Pop-up in document table for sorting columns, width="50%"]
. To add more fields to the sort, select from the dropdown menu.
. To add fields to the sort, select their names from the dropdown menu.
+
By default, columns are sorted in the order they are added.
+
[role="screenshot"]
image::images/document-explorer-multi-field.png[Multi field sort in the document table, width="75%"]
image::images/document-explorer-multi-field.png[Multi field sort in the document table, width="50%"]
. To change the sort order, select a field in the pop-up, and then drag it to the new location.
[float]
[[document-explorer-edit-field]]
==== Edit a field
Change how {kib} displays a field.
. Click the column header for the field, and then select *Edit data view field.*
. In the *Edit field* form, change the field name and format.
+
For detailed information on formatting options, refer to <<managing-fields, Format data fields>>.
[float]
[[document-explorer-compare-data]]
=== Compare data
==== Filter the documents
Narrow your results to a subset of documents to easily
compare the data of interest.
Narrow your results to a subset of documents so you're comparing just the data of interest.
. Select the documents you want to compare.
. Click the *documents selected* option, and then select *Show selected documents only*.
+
[role="screenshot"]
image::images/document-explorer-compare-data.png[Compare data in the document table, width="75%"]
image::images/document-explorer-compare-data.png[Compare data in the document table, width="50%"]
[float]
[[document-explorer-configure-table]]
==== Set the number of rows per page
To change the numbers of rows you want to display on each page, use the *Rows per page* menu. By default, the document table displays 100 rows per page.
[role="screenshot"]
image::images/document-table-rows-per-page.png["Menu with options for setting the number of rows in the document table"]
To customize the default number of rows per page, go to *Stack Managaement > Advanced Settings*
and search for *rows per page*.
[float]
[[document-explorer-full-screen]]
==== View in fullscreen
To toggle the table in and out of fullscreen mode, click the fullscreen icon
image:images/fullscreen-icon.png[icon to display the document table in fullscreen mode].
[float]
[[document-explorer-expand-documents]]
=== Expand documents
=== Go inside a document
Dive into an individual document to inspect its fields, set filters, and view
the documents that occurred before and after it.
@ -97,8 +149,7 @@ image::images/document-table-expanded.png[Expanded view of the document table]
. In the *Table* view, scan through the fields and their values, or search for a field by name.
. When you find a field of interest,
click
image:images/actions-icon.png[three dots icon in table column] in the *Actions* column
hover your mouse over the *Actions* column
to:
.. Filter the results to include or exclude specific fields or values.
.. Toggle the field in or out the document table.
@ -122,22 +173,3 @@ filters remain active, while other filters are copied in a disabled state.
+
[role="screenshot"]
image::images/discover-context.png[Image showing context view feature, with anchor documents highlighted in blue]
[float]
[[document-explorer-full-screen]]
=== View documents in fullscreen
To view as much data as possible and eliminate distractions, click the fullscreen icon
image:images/fullscreen-icon.png[icon to display the document table in fullscreen mode]
in the document table.
[float]
[[document-explorer-configure-table]]
=== Configure the number of documents displayed
By default, the document table displays 100 rows per page. To change this number,
click *Rows per page*.
[role="screenshot"]
image::images/document-table-rows-per-page.png["Menu with options for setting the number of rows in the document table"]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 274 KiB

After

Width:  |  Height:  |  Size: 313 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 82 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 226 KiB

After

Width:  |  Height:  |  Size: 355 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 229 KiB

After

Width:  |  Height:  |  Size: 266 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 512 KiB

After

Width:  |  Height:  |  Size: 472 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 291 KiB

After

Width:  |  Height:  |  Size: 399 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 311 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 486 KiB

After

Width:  |  Height:  |  Size: 376 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 268 KiB

After

Width:  |  Height:  |  Size: 196 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

After

Width:  |  Height:  |  Size: 221 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 162 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 271 KiB

After

Width:  |  Height:  |  Size: 295 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

View file

@ -6,12 +6,6 @@ that you've created in *Discover*.
Saved searches are good for adding search results to a dashboard,
and can also serve as a foundation for building visualizations.
A saved search stores the query text, filters, and
current view of *Discover*, including the columns selected in the document table,
the sort order, and the {data-source}.
Saved searches are different from <<save-load-delete-query,saved queries>>, which
are for storing query text and are available in any app with a query bar.
[role="xpack"]
[[discover-read-only-access]]
[float]
@ -24,8 +18,13 @@ image::discover/images/read-only-badge.png[Example of Discover's read only acces
[float]
=== Save a search
. Once you've created a search worth saving in *Discover*, click *Save* in the toolbar.
. Enter a name for the search and click *Save*.
By default, a saved search stores the query text, filters, and
current view of *Discover*, including the columns and sort order in the document table, and the {data-source}.
. Once you've created a search worth saving, click *Save* in the toolbar.
. Enter a name for the search.
. Optionally store <<managing-tags,tags>> and the time range with the search.
. Click *Save*.
. To reload your search results in *Discover*, click *Open* in the toolbar, and select the saved search.
+
If the saved search is associated with a different {data-source} than is currently

View file

@ -26,7 +26,7 @@ At this point, you're sorting by the`timestamp` field.
. Select *High-Low*.
+
[role="screenshot"]
image::images/field-sorting-popover.png["Field sorting popover", width=60%]
image::images/field-sorting-popover.png["Field sorting popover", width="60%"]
+
Your table now sorts documents from most to least relevant.

View file

@ -57,7 +57,8 @@ your {es} data.
To view the ecommerce sample data, open the {data-source} menu, and then select **Kibana Sample Data Ecommerce**.
+
[role="screenshot"]
image::images/discover-data-view.png[How to set the {data-source} in Discover, width=50%]
image::images/discover-data-view.png[How to set the {data-source} in Discover, width="40%"]
+
To create a data view for your own data,
click *Create a data view*.
@ -87,12 +88,15 @@ You can also search for the field by name.
[role="screenshot"]
image:images/discover-sidebar-available-fields.png[Fields list that displays the top five search results, width=50%]
. Click the `manufacturer` field to view its five most popular values.
. Click `manufacturer` to view its most popular values.
+
[role="screenshot"]
image:images/find-manufacturer-field.png[Fields list that displays the top five search results, width=75%]
**Discover** shows the top 10 values and the number of records used to calculate those values.
. Click image:images/add-icon.png[Add icon] to toggle the field into the document table.
+
[role="screenshot"]
image::images/discover-add-icon.png[How to add a field as a column in the table, width="50%"]
. Find the `customer_first_name` and `customer_last_name` fields and add
them to the document table. Your table should look similar to this:
@ -103,7 +107,8 @@ image:images/document-table.png[Document table with fields for manufacturer, cus
. To rearrange the table columns, click a
column header, and then select *Move left* or *Move right*.
. To view more of the document table, click
. To view more of the document table,
click
image:images/chart-icon.png[icon button for opening Show/Hide chart menu, width=24px]
to open the *Chart options* menu,
and then select *Hide chart*.
@ -217,8 +222,7 @@ to show document details.
image:images/document-table-expanded.png[Table view with document expanded]
. Scan through the fields and their values. If you find a field of interest,
click
image:images/actions-icon.png[three dots icon next to data view dropdown] in the *Actions* column for filters and other controls.
hover your mouse over the *Actions* column for filters and other options.
. To create a view of the document that you can bookmark and share, click **Single document**.
@ -238,6 +242,8 @@ the document table, the sort order, and the {data-source}.
. In the toolbar, click **Save**.
. Optionally store <<managing-tags,tags>> and the time range with the search.
. Give your search a title, and then click **Save**.
[float]
@ -299,9 +305,8 @@ For more about this and other rules provided in {alert-features}, go to <<alerti
* <<discover-search-for-relevance, Search for relevance>>.
* <<kibana-discover-settings, Configure Discover>> to better meet your needs.
Go to **Advanced Settings** to configure the number of documents to show,
the table columns that display by default, and more.
* <<document-explorer, Configure the chart and document table>> to better meet your needs.
--
include::{kib-repo-dir}/discover/document-explorer.asciidoc[]