-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
kertal
merged 17 commits into
elastic:master
from
kertal:kertal-pr-2020-02-09-discover-context-doc
Mar 4, 2021
Merged
Changes from 16 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
dbb3b55
Restore discover context doc
kertal 77a2bdd
Update docs/discover/context.asciidoc
kertal 8557a1d
Update docs/discover/context.asciidoc
kertal 4b7372a
Update docs/discover/context.asciidoc
kertal 463c1d7
Update docs/discover/context.asciidoc
kertal d1c3ea6
Update docs/discover/context.asciidoc
kertal 9090a21
Update docs/discover/context.asciidoc
kertal 18da67a
Update docs/discover/context.asciidoc
kertal ab55eda
Improve documentation
kertal 944c307
Improve filter section of Discover Context view
kertal 3784a1c
Update docs/discover/context.asciidoc
kertal f580893
Update docs/discover/context.asciidoc
kertal 8e9430d
Update docs/discover/context.asciidoc
kertal a5f127f
Update docs/discover/context.asciidoc
kertal 896ffd9
Merge master, apply changes by Gail
kertal 2479b2e
Merge master, apply changes by Gail
kertal ee9557d
Final changes
kertal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"] | ||
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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