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.

Sign up for GitHub

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

[DOCS] EQL: Change result_position default to tail #66550

Merged
merged 2 commits into from
Dec 18, 2020
Merged

[DOCS] EQL: Change result_position default to tail #66550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c5a5ea
[DOCS] EQL: Change `result_position` default to `tail`
jrodewig Dec 15, 2020
70f48b3
Merge branch 'master' into docs__update-eql-result_pos
elasticmachine Dec 17, 2020
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
8 changes: 4 additions & 4 deletions docs/reference/eql/eql-search-api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,13 +235,13 @@ Set of matching events or sequences to return.
.Valid values for `result_position`
[%collapsible%open]
====
`head`::
`tail`::
(Default)
Return the earliest matches, similar to the {wikipedia}/Head_(Unix)[Unix head
Return the most recent matches, similar to the {wikipedia}/Tail_(Unix)[Unix tail
command].

`tail`::
Return the most recent matches, similar to the {wikipedia}/Tail_(Unix)[Unix tail
`head`::
Return the earliest matches, similar to the {wikipedia}/Head_(Unix)[Unix head
command].
====
+
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/eql/eql.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ GET /my-index-000001/_eql/search
----
// TEST[setup:sec_logs]

By default, basic EQL queries return the top 10 matching events in the
By default, basic EQL queries return the 10 most recent matching events in the
`hits.events` property. These hits are sorted by timestamp, converted to
milliseconds since the {wikipedia}/Unix_time[Unix epoch], in ascending order.

Expand Down Expand Up @@ -155,7 +155,8 @@ GET /my-index-000001/_eql/search
----
// TEST[setup:sec_logs]

Matching sequences are returned in the `hits.sequences` property.
The response's `hits.sequences` property contains the 10 most recent matching
sequences.

[source,console-result]
----
Expand Down