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

[Discover] Restore context documentation #90784

Merged
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
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
63 changes: 63 additions & 0 deletions docs/discover/context.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
[[discover-document-context]]
== View surrounding documents

Once you've narrowed your search to a specific event in *Discover*,
you can inspect the documents that occurred
immediately before and after the event.
To view the surrounding documents, your index pattern must contain time-based events.

. In the document table, click the expand icon (>).
. Click *View surrounding documents.*
+
In the context view, documents are sorted by the time field specified in the index pattern
and displayed using the same set of columns as the *Discover* view from which
the context was opened. The anchor document is highlighted in blue.
+
[role="screenshot"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should change the context view to show the anchor doc in the middle, so the reader sees docs both above and below the anchor.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I've changed it new file is also smaller in size but better in resolution, so it's a win
discover-context

image::images/Discover-ContextView.png[Image showing context view feature, with anchor documents highlighted in blue]
+
The filters you applied in *Discover* are carried over to the context view.
+
[role="screenshot"]
kertal marked this conversation as resolved.
Show resolved Hide resolved
image::images/discover-context-filters-active.png[Disabled filter in main view]
+
Pinned filters remain active, while normal filters are copied in a disabled state.
+
[role="screenshot"]
image::images/discover-context-filters-inactive.png[Filter in context view]

. To find the documents of interest, add filters.

. To increase the number of documents that surround the anchor document, click *Load*.
By default, five documents are added with each click.
+
[role="screenshot"]
image::images/discover-context-load-newer-documents.png[Load button and the number of documents to load]


[float]
[[configure-context-ContextView]]
=== Configure the context view

Configure the appearance and behavior in *Advanced Settings*.

. Open the main menu, then click *Stack Management > Advanced Settings*.
. Search for context, then edit the settings.
+
[horizontal]
`context:defaultSize`:: The number of documents to display by default.
`context:step`:: The default number of documents to load with each button click. The default is 5.
`context:tieBreakerFields`:: The field to use for tiebreaking in case of equal time field values.
The default is the `_doc` field.
+
You can enter a comma-separated list of field
names, which is checked in sequence for suitability when a context is
displayed. The first suitable field is used as the tiebreaking
field. A field is suitable if the field exists and is sortable in the index
pattern the context is based on.
+
Although not required, it is recommended to only
use fields that have {ref}/doc-values.html[doc values] enabled to achieve
good performance and avoid unnecessary {ref}/modules-fielddata.html[field
data] usage. Common examples for suitable fields include log line numbers,
monotonically increasing counters and high-precision timestamps.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion docs/user/discover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,8 @@ 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,
hover of its name for filters and other controls.

. To view documents that occurred before or after the event you are looking at, click **View surrounding documents**.
. To view documents that occurred before or after the event you are looking at, click
<<discover-document-context, View surrounding documents>>.

. For direct access to a particular document, click **View single document**.
+
Expand Down Expand Up @@ -218,4 +219,10 @@ include::{kib-repo-dir}/discover/set-time-filter.asciidoc[]

include::{kib-repo-dir}/discover/search.asciidoc[]

include::{kib-repo-dir}/discover/context.asciidoc[]

include::{kib-repo-dir}/discover/search-for-relevance.asciidoc[]




kertal marked this conversation as resolved.
Show resolved Hide resolved