Skip to content

Commit 8527183

Browse files
authored
[DOCS] EQL: Remove Endgame EQL refs (#63636)
1 parent 2df47b8 commit 8527183

File tree

4 files changed

+50
-54
lines changed

4 files changed

+50
-54
lines changed

docs/reference/eql/eql-search-api.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ beta::[]
1111

1212
Returns search results for an <<eql,Event Query Language (EQL)>> query.
1313

14-
In {es}, EQL assumes each document in a data stream or index corresponds to an
14+
EQL assumes each document in a data stream or index corresponds to an
1515
event.
1616

1717
[source,console]
@@ -210,9 +210,6 @@ If both parameters are specified, only the query parameter is used.
210210
`query`::
211211
(Required, string)
212212
<<eql-syntax,EQL>> query you wish to run.
213-
+
214-
IMPORTANT: This parameter supports a subset of EQL syntax. See
215-
<<eql-unsupported-syntax>>.
216213

217214
`size`::
218215
(Optional, integer or float)

docs/reference/eql/eql.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
beta::[]
1010

11-
{eql-ref}/index.html[Event Query Language (EQL)] is a query language for
12-
event-based, time series data, such as logs.
11+
Event Query Language (EQL) is a query language for event-based, time series
12+
data, such as logs.
1313

1414
[discrete]
1515
[[eql-advantages]]
@@ -32,9 +32,9 @@ makes it easy to describe activity that goes beyond IOCs.
3232
[[eql-required-fields]]
3333
== Required fields
3434

35-
TIP: While no schema is required to use EQL in {es}, we recommend using the
36-
{ecs-ref}[Elastic Common Schema (ECS)]. EQL search is designed to work
37-
with core ECS fields by default.
35+
TIP: While no schema is required to use EQL, we recommend using the
36+
{ecs-ref}[Elastic Common Schema (ECS)]. EQL searches are designed to work with
37+
core ECS fields by default.
3838

3939
EQL assumes each document in a data stream or index corresponds to an event. To
4040
run an EQL search, each document must contain a _timestamp_ and _event category_

docs/reference/eql/functions.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,10 +247,8 @@ Returns the quotient of a provided dividend and divisor.
247247
[WARNING]
248248
====
249249
If both the dividend and divisor are integers, the `divide` function _rounds
250-
down_ any returned floating point numbers to the nearest integer.
251-
252-
EQL queries in {es} should account for this rounding. To avoid rounding, convert
253-
either the dividend or divisor to a float.
250+
down_ any returned floating point numbers to the nearest integer. To avoid
251+
rounding, convert either the dividend or divisor to a float.
254252
255253
[%collapsible]
256254
.**Example**

docs/reference/eql/syntax.asciidoc

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88

99
beta::[]
1010

11-
IMPORTANT: {es} supports a subset of {eql-ref}/index.html[EQL syntax]. See
12-
<<eql-syntax-limitations>>.
13-
1411
[discrete]
1512
[[eql-basic-syntax]]
1613
=== Basic syntax
@@ -35,7 +32,7 @@ process where process.name == "svchost.exe"
3532
[[eql-syntax-event-categories]]
3633
==== Event categories
3734

38-
In {es}, an event category is a valid, indexed value of the
35+
An event category is a valid, indexed value of the
3936
<<eql-required-fields,event category field>>. You can set the event category
4037
field using the `event_category_field` parameter of the EQL search API.
4138

@@ -251,10 +248,8 @@ Divides the value to the left of the operator by the value to the right.
251248
[WARNING]
252249
====
253250
If both the dividend and divisor are integers, the divide (`\`) operation
254-
_rounds down_ any returned floating point numbers to the nearest integer.
255-
256-
EQL queries in {es} should account for this rounding. To avoid rounding, convert
257-
either the dividend or divisor to a float.
251+
_rounds down_ any returned floating point numbers to the nearest integer. To
252+
avoid rounding, convert either the dividend or divisor to a float.
258253
259254
*Example* +
260255
The `process.args_count` field is a <<number,`long`>> integer field containing a
@@ -599,9 +594,8 @@ until [ process where event.type == "stop" ]
599594
[[eql-functions]]
600595
=== Functions
601596

602-
{es} supports several of EQL's built-in functions. You can use these functions
603-
to convert data types, perform math, manipulate strings, and more. Most
604-
functions are case-sensitive by default.
597+
You can use EQL functions to convert data types, perform math, manipulate
598+
strings, and more. Most functions are case-sensitive by default.
605599

606600
For a list of supported functions, see <<eql-function-ref>>.
607601

@@ -682,21 +676,21 @@ For a list of supported pipes, see <<eql-pipe-ref>>.
682676
[[eql-syntax-limitations]]
683677
=== Limitations
684678

685-
{es} EQL does not support the following features and syntax.
679+
EQL does not support the following features and syntax.
686680

687681
[discrete]
688682
[[eql-compare-fields]]
689683
==== Comparing fields
690684

691-
In {es} EQL, you cannot use comparison operators to compare a field to
685+
You cannot use EQL comparison operators to compare a field to
692686
another field. This applies even if the fields are changed using a
693687
<<eql-functions,function>>.
694688

695689
[discrete]
696690
[[eql-array-fields]]
697691
==== Array field values are not supported
698692

699-
{es} EQL does not support <<array,array>> field values, also known as
693+
EQL does not support <<array,array>> field values, also known as
700694
_multi-value fields_. EQL searches on array field values may return inconsistent
701695
results.
702696

@@ -709,38 +703,45 @@ sub-fields of a `nested` field. However, data streams and indices containing
709703
`nested` field mappings are otherwise supported.
710704

711705
[discrete]
712-
[[single-quote-strings]]
713-
==== Single quote strings
706+
[[eql-unsupported-syntax]]
707+
==== Differences from Endgame EQL syntax
714708

715-
In {es} EQL, the single quote (`'`) character is reserved for future use.
716-
Strings enclosed in single quotes are not supported. Enclose strings in
717-
double quotes (`"`) instead.
709+
{es} EQL differs from the {eql-ref}/index.html[Elastic Endgame EQL syntax] as
710+
follows:
718711

719-
You cannot use an escaped single quote (`\'`) for literal strings. Use an
720-
escaped double quote (`\"`) instead.
712+
* Most operators and functions in {es} EQL are case-sensitive. For
713+
case-insensitive equality comparisons, use the `:` operator.
721714

722-
[discrete]
723-
[[eql-unsupported-syntax]]
724-
==== Unsupported syntax
715+
* Comparisons using the `==` and `!=` operators do not expand wildcard
716+
characters. For example, `process_name == "cmd*.exe"` interprets `*` as a
717+
literal asterisk, not a wildcard. For case-sensitive wildcard matching, use the
718+
<<eql-fn-wildcard,`wildcard`>> function.
719+
720+
* `=` cannot be substituted for the `==` operator.
721+
722+
* Strings enclosed in single quotes (`'`) are not supported. Enclose strings in
723+
double quotes (`"`) instead.
724+
725+
* `?"` and `?'` do not indicate raw strings. Enclose raw strings in
726+
three double quotes (`"""`) instead.
725727

726-
{es} supports a subset of {eql-ref}/index.html[EQL syntax]. {es} cannot run EQL
727-
queries that contain:
728+
* {es} EQL does not support:
728729

729-
* Array functions:
730-
** {eql-ref}/functions.html#arrayContains[`arrayContains`]
731-
** {eql-ref}/functions.html#arrayCount[`arrayCount`]
732-
** {eql-ref}/functions.html#arraySearch[`arraySearch`]
730+
** Array functions:
731+
*** {eql-ref}/functions.html#arrayContains[`arrayContains`]
732+
*** {eql-ref}/functions.html#arrayCount[`arrayCount`]
733+
*** {eql-ref}/functions.html#arraySearch[`arraySearch`]
733734

734-
* {eql-ref}/joins.html[Joins]
735+
** {eql-ref}/joins.html[Joins]
735736

736-
* {eql-ref}/basic-syntax.html#event-relationships[Lineage-related keywords]:
737-
** `child of`
738-
** `descendant of`
739-
** `event of`
737+
** {eql-ref}/basic-syntax.html#event-relationships[Lineage-related keywords]:
738+
*** `child of`
739+
*** `descendant of`
740+
*** `event of`
740741

741-
* The following {eql-ref}/pipes.html[pipes]:
742-
** {eql-ref}/pipes.html#count[`count`]
743-
** {eql-ref}/pipes.html#filter[`filter`]
744-
** {eql-ref}/pipes.html#sort[`sort`]
745-
** {eql-ref}/pipes.html#unique[`unique`]
746-
** {eql-ref}/pipes.html#unique-count[`unique_count`]
742+
** The following {eql-ref}/pipes.html[pipes]:
743+
*** {eql-ref}/pipes.html#count[`count`]
744+
*** {eql-ref}/pipes.html#filter[`filter`]
745+
*** {eql-ref}/pipes.html#sort[`sort`]
746+
*** {eql-ref}/pipes.html#unique[`unique`]
747+
*** {eql-ref}/pipes.html#unique-count[`unique_count`]

0 commit comments

Comments
 (0)