From bc37b1b2a7a47562288ca11e9d69b4f007bacab1 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 12 Aug 2020 09:42:45 -0400 Subject: [PATCH] [DOCS] Fix EQL required fields language --- docs/reference/eql/eql.asciidoc | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/reference/eql/eql.asciidoc b/docs/reference/eql/eql.asciidoc index 677cad6fbf1..dc61dadc066 100644 --- a/docs/reference/eql/eql.asciidoc +++ b/docs/reference/eql/eql.asciidoc @@ -32,15 +32,18 @@ makes it easy to describe activity that goes beyond IOCs. [[eql-required-fields]] == Required fields -EQL assumes each document in a data stream or index corresponds to an event. To -search using EQL, each document in the searched data stream or index must -include a _timestamp_ field and an _event category_ field. +TIP: While no schema is required to use EQL in {es}, we recommend using the +{ecs-ref}[Elastic Common Schema (ECS)]. EQL search is designed to work +with core ECS fields by default. -{es} EQL uses the `@timestamp` and `event.category` fields from the -{ecs-ref}[Elastic Common Schema (ECS)] as the default timestamp and event -category fields. If your searched documents use a different timestamp or event -category field, you must specify it in the search request. See -<>. +EQL assumes each document in a data stream or index corresponds to an event. To +run an EQL search, each document must contain a _timestamp_ and _event category_ +field. + +EQL uses the `@timestamp` and `event.category` fields from the {ecs-ref}[ECS] as +the default timestamp and event category fields. If your documents use a +different timestamp or event category field, you must specify it in the search +request. See <>. [discrete] [[run-an-eql-search]] @@ -404,10 +407,12 @@ GET /my-index-000001/_eql/search [[specify-a-timestamp-or-event-category-field]] === Specify a timestamp or event category field -By default, the EQL search API uses `@timestamp` and `event.category` as the -required timestamp and event category fields. If your searched documents use -a different timestamp or event category field, you must specify it in the search -request using the `timestamp_field` or `event_category_field` parameters. +To run an EQL search, each searched document must contain a timestamp and event +category field. The EQL search API uses the `@timestamp` and `event.category` +fields from the {ecs-ref}[Elastic Common Schema (ECS)] by default. If your +documents use a different timestamp or event category field, you must specify it +in the search request using the `timestamp_field` or `event_category_field` +parameters. The event category field is typically mapped as a <> or <> field. The timestamp field is typically