requirements.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[eql-requirements]]
  4. == EQL requirements
  5. ++++
  6. <titleabbrev>Requirements</titleabbrev>
  7. ++++
  8. experimental::[]
  9. EQL is schema-less and works well with most common log formats.
  10. [TIP]
  11. ====
  12. While no schema is required to use EQL in {es}, we recommend the
  13. {ecs-ref}[Elastic Common Schema (ECS)]. The EQL search API is designed to work
  14. with core ECS fields by default.
  15. ====
  16. [discrete]
  17. [[eql-required-fields]]
  18. === Required fields
  19. In {es}, EQL assumes each document in an index corresponds to an event.
  20. To search an index using EQL, each document in the index must contain the
  21. following field archetypes:
  22. Event category::
  23. A field containing the event classification, such as `process`, `file`, or
  24. `network`. This is typically mapped as a <<keyword,`keyword`>> field.
  25. Timestamp::
  26. A field containing the date and/or time the event occurred. This is typically
  27. mapped as a <<date,`date`>> field.
  28. [NOTE]
  29. ====
  30. You cannot use a <<nested,`nested`>> field datatype or the sub-fields of a
  31. `nested` field dataype as the timestamp or event category field. See
  32. <<eql-nested-fields>>.
  33. ====