parent
76bba601ab
commit
a8bf9a6a91
|
@ -131,11 +131,6 @@ used.
|
||||||
[[eql-search-api-request-body]]
|
[[eql-search-api-request-body]]
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
||||||
`case_sensitive`::
|
|
||||||
(Optional, boolean)
|
|
||||||
If `true`, matching for the <<eql-search-api-request-query-param,EQL query>> is
|
|
||||||
case sensitive. Defaults to `false`.
|
|
||||||
|
|
||||||
`event_category_field`::
|
`event_category_field`::
|
||||||
(Required*, string)
|
(Required*, string)
|
||||||
Field containing the event classification, such as `process`, `file`, or
|
Field containing the event classification, such as `process`, `file`, or
|
||||||
|
|
|
@ -8,7 +8,8 @@
|
||||||
|
|
||||||
experimental::[]
|
experimental::[]
|
||||||
|
|
||||||
{es} supports the following <<eql-functions,EQL functions>>.
|
{es} supports the following <<eql-functions,EQL functions>>. Most EQL functions
|
||||||
|
are case-sensitive by default.
|
||||||
|
|
||||||
[discrete]
|
[discrete]
|
||||||
[[eql-fn-add]]
|
[[eql-fn-add]]
|
||||||
|
@ -62,7 +63,7 @@ If using a field as the argument, this parameter supports only
|
||||||
=== `between`
|
=== `between`
|
||||||
|
|
||||||
Extracts a substring that's between a provided `left` and `right` text in a
|
Extracts a substring that's between a provided `left` and `right` text in a
|
||||||
source string.
|
source string. Matching is case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
@ -77,12 +78,6 @@ between(file.path, "\\\\", "\\\\", false) // returns "Windows"
|
||||||
// Sets greedy matching to true
|
// Sets greedy matching to true
|
||||||
between(file.path, "\\\\", "\\\\", true) // returns "Windows\\System32"
|
between(file.path, "\\\\", "\\\\", true) // returns "Windows\\System32"
|
||||||
|
|
||||||
// Case sensitivity defaults to false.
|
|
||||||
between(file.path, "system32\\\\", ".exe", false, false) // returns "cmd"
|
|
||||||
// Sets case sensitivity to true
|
|
||||||
between(file.path, "system32\\\\", ".exe", false, true) // returns ""
|
|
||||||
between(file.path, "System32\\\\", ".exe", false, true) // returns "cmd"
|
|
||||||
|
|
||||||
// empty source string
|
// empty source string
|
||||||
between("", "system32\\\\", ".exe") // returns ""
|
between("", "system32\\\\", ".exe") // returns ""
|
||||||
between("", "", "") // returns ""
|
between("", "", "") // returns ""
|
||||||
|
@ -94,7 +89,7 @@ between(null, "system32\\\\", ".exe") // returns null
|
||||||
*Syntax*
|
*Syntax*
|
||||||
[source,txt]
|
[source,txt]
|
||||||
----
|
----
|
||||||
between(<source>, <left>, <right>[, <greedy_matching>, <case_sensitive>])
|
between(<source>, <left>, <right>[, <greedy_matching>])
|
||||||
----
|
----
|
||||||
|
|
||||||
*Parameters*
|
*Parameters*
|
||||||
|
@ -147,10 +142,6 @@ If `true`, match the longest possible substring, similar to `.*` in regular
|
||||||
expressions. If `false`, match the shortest possible substring, similar to `.*?`
|
expressions. If `false`, match the shortest possible substring, similar to `.*?`
|
||||||
in regular expressions. Defaults to `false`.
|
in regular expressions. Defaults to `false`.
|
||||||
|
|
||||||
`<case_sensitive>`::
|
|
||||||
(Optional, boolean)
|
|
||||||
If `true`, matching is case-sensitive. Defaults to `false`.
|
|
||||||
|
|
||||||
*Returns:* string or `null`
|
*Returns:* string or `null`
|
||||||
|
|
||||||
[discrete]
|
[discrete]
|
||||||
|
@ -352,7 +343,8 @@ If using a field as the argument, this parameter supports only
|
||||||
[[eql-fn-endswith]]
|
[[eql-fn-endswith]]
|
||||||
=== `endsWith`
|
=== `endsWith`
|
||||||
|
|
||||||
Returns `true` if a source string ends with a provided substring.
|
Returns `true` if a source string ends with a provided substring. Matching is
|
||||||
|
case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
@ -416,7 +408,8 @@ field data types:
|
||||||
[[eql-fn-indexof]]
|
[[eql-fn-indexof]]
|
||||||
=== `indexOf`
|
=== `indexOf`
|
||||||
|
|
||||||
Returns the first position of a provided substring in a source string.
|
Returns the first position of a provided substring in a source string. Matching
|
||||||
|
is case-sensitive.
|
||||||
|
|
||||||
If an optional start position is provided, this function returns the first
|
If an optional start position is provided, this function returns the first
|
||||||
occurrence of the substring at or after the start position.
|
occurrence of the substring at or after the start position.
|
||||||
|
@ -561,7 +554,7 @@ field data types:
|
||||||
=== `match`
|
=== `match`
|
||||||
|
|
||||||
Returns `true` if a source string matches one or more provided regular
|
Returns `true` if a source string matches one or more provided regular
|
||||||
expressions.
|
expressions. Matching is case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
@ -818,7 +811,8 @@ Fields are not supported as arguments.
|
||||||
[[eql-fn-startswith]]
|
[[eql-fn-startswith]]
|
||||||
=== `startsWith`
|
=== `startsWith`
|
||||||
|
|
||||||
Returns `true` if a source string begins with a provided substring.
|
Returns `true` if a source string begins with a provided substring. Matching is
|
||||||
|
case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
@ -917,7 +911,8 @@ If using a field as the argument, this parameter does not support the
|
||||||
[[eql-fn-stringcontains]]
|
[[eql-fn-stringcontains]]
|
||||||
=== `stringContains`
|
=== `stringContains`
|
||||||
|
|
||||||
Returns `true` if a source string contains a provided substring.
|
Returns `true` if a source string contains a provided substring. Matching is
|
||||||
|
case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
@ -1077,7 +1072,7 @@ If using a field as the argument, this parameter supports only
|
||||||
=== `wildcard`
|
=== `wildcard`
|
||||||
|
|
||||||
Returns `true` if a source string matches one or more provided wildcard
|
Returns `true` if a source string matches one or more provided wildcard
|
||||||
expressions.
|
expressions. Matching is case-sensitive.
|
||||||
|
|
||||||
*Example*
|
*Example*
|
||||||
[source,eql]
|
[source,eql]
|
||||||
|
|
|
@ -108,7 +108,8 @@ my`field -> `my``field`
|
||||||
==== Conditions
|
==== Conditions
|
||||||
|
|
||||||
A condition consists of one or more criteria an event must match.
|
A condition consists of one or more criteria an event must match.
|
||||||
You can specify and combine these criteria using the following operators:
|
You can specify and combine these criteria using the following operators. Most
|
||||||
|
EQL operators are case-sensitive by default.
|
||||||
|
|
||||||
[discrete]
|
[discrete]
|
||||||
[[eql-syntax-comparison-operators]]
|
[[eql-syntax-comparison-operators]]
|
||||||
|
@ -217,11 +218,13 @@ user.name in ("Administrator", "SYSTEM", "NETWORK SERVICE")
|
||||||
user.name not in ("Administrator", "SYSTEM", "NETWORK SERVICE")
|
user.name not in ("Administrator", "SYSTEM", "NETWORK SERVICE")
|
||||||
----
|
----
|
||||||
|
|
||||||
`in`::
|
`in` (case-sensitive)::
|
||||||
Returns `true` if the value is contained in the provided list.
|
Returns `true` if the value is contained in the provided list. For strings,
|
||||||
|
matching is case-sensitive.
|
||||||
|
|
||||||
`not in`::
|
`not in` (case-sensitive)::
|
||||||
Returns `true` if the value is not contained in the provided list.
|
Returns `true` if the value is not contained in the provided list. For strings,
|
||||||
|
matching is case-sensitive.
|
||||||
|
|
||||||
[discrete]
|
[discrete]
|
||||||
[[eql-syntax-math-operators]]
|
[[eql-syntax-math-operators]]
|
||||||
|
@ -597,7 +600,8 @@ until [ process where event.type == "stop" ]
|
||||||
=== Functions
|
=== Functions
|
||||||
|
|
||||||
{es} supports several of EQL's built-in functions. You can use these functions
|
{es} supports several of EQL's built-in functions. You can use these functions
|
||||||
to convert data types, perform math, manipulate strings, and more.
|
to convert data types, perform math, manipulate strings, and more. Most
|
||||||
|
functions are case-sensitive by default.
|
||||||
|
|
||||||
For a list of supported functions, see <<eql-function-ref>>.
|
For a list of supported functions, see <<eql-function-ref>>.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue