index.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[eql]]
  4. = EQL for event-based search
  5. ++++
  6. <titleabbrev>EQL</titleabbrev>
  7. ++++
  8. dev::[]
  9. {eql-ref}/index.html[Event Query Language (EQL)] is a query language used for
  10. logs and other event-based data.
  11. You can use EQL in {es} to easily express relationships between events and
  12. quickly match events with shared properties. You can use EQL and query
  13. DSL together to better filter your searches.
  14. [float]
  15. [[eql-advantages]]
  16. === Advantages of EQL
  17. * *EQL lets you express relationships between events.* +
  18. Many query languages allow you to match only single events. EQL lets you match a
  19. sequence of events across different event categories and time spans.
  20. * *EQL has a low learning curve.* +
  21. EQL syntax looks like other query languages. It lets you write and read queries
  22. intuitively, which makes for quick, iterative searching.
  23. * *We designed EQL for security use cases.* +
  24. While you can use EQL for any event-based data, we created EQL for threat
  25. hunting. EQL not only supports indicator of compromise (IOC) searching but
  26. makes it easy to describe activity that goes beyond IOCs.
  27. [float]
  28. [[when-to-use-eql]]
  29. === When to use EQL
  30. Consider using EQL if you:
  31. * Use {es} for threat hunting or other security use cases
  32. * Search time-series data or logs, such as network or system logs
  33. * Want an easy way to explore relationships between events
  34. [float]
  35. [[eql-toc]]
  36. === In this section
  37. * <<eql-requirements>>
  38. * <<eql-search>>
  39. * <<eql-syntax>>
  40. * <<eql-function-ref>>
  41. * <<eql-limitations>>
  42. include::requirements.asciidoc[]
  43. include::search.asciidoc[]
  44. include::syntax.asciidoc[]
  45. include::functions.asciidoc[]
  46. include::limitations.asciidoc[]