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

[DOCS] EQL: Update runs syntax #78922

Merged
merged 3 commits into from
Oct 11, 2021
Merged
Changes from all 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
17 changes: 8 additions & 9 deletions docs/reference/eql/syntax.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -695,17 +695,17 @@ until [ process where event.type == "stop" ]
====

[discrete]
[[eql-runs-keyword]]
=== `runs` keyword
[[eql-with-runs-statement]]
=== `with runs` statement

Use a `runs` statement to run the same event criteria successively within a
Use a `with runs` statement to run the same event criteria successively within a
sequence query. For example:

[source,eql]
----
sequence
[ process where event.type == "creation" ]
[ library where process.name == "regsvr32.exe" ] [runs=3]
[ library where process.name == "regsvr32.exe" ] with runs=3
[ registry where true ]
----

Expand All @@ -721,17 +721,16 @@ sequence
[ registry where true ]
----

A `runs` statement must be enclosed in square brackets (`[ ]`). The `runs` value
must be between `1` and `100` (inclusive).
The `runs` value must be between `1` and `100` (inclusive).

You can use a `runs` statement with the <<eql-by-keyword,`by` keyword>>. For
example:
You can use a `with runs` statement with the <<eql-by-keyword,`by` keyword>>.
For example:

[source,eql]
----
sequence
[ process where event.type == "creation" ] by process.executable
[ library where process.name == "regsvr32.exe" ] by dll.path [runs=3]
[ library where process.name == "regsvr32.exe" ] by dll.path with runs=3
----

[discrete]
Expand Down