mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-05 20:48:22 +00:00
30a32040d3
Adds documentation for the EQL `substring` function. Supporting changes: * Creates a new "EQL function reference" page * Updates the title of the "EQL syntax reference" page for consistency * Adds a brief "Functions" section to the EQL syntax docs * Updates EQL limitations docs to state that only array functions are unsupported
43 lines
988 B
Plaintext
43 lines
988 B
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[eql]]
|
|
= EQL for event-based search
|
|
++++
|
|
<titleabbrev>EQL</titleabbrev>
|
|
++++
|
|
|
|
experimental::[]
|
|
|
|
{eql-ref}/index.html[Event Query Language (EQL)] is a query language used for
|
|
logs and other event-based data.
|
|
|
|
You can use EQL in {es} to easily express relationships between events and
|
|
quickly match events with shared properties. You can use EQL and query
|
|
DSL together to better filter your searches.
|
|
|
|
[float]
|
|
[[when-to-use-eql]]
|
|
=== When to use EQL
|
|
|
|
Consider using EQL if you:
|
|
|
|
* Use {es} for threat hunting or other security use cases
|
|
* Search time-series data or logs, such as network or system logs
|
|
* Want an easy way to explore relationships between events
|
|
|
|
[float]
|
|
[[eql-toc]]
|
|
=== In this section
|
|
|
|
* <<eql-requirements>>
|
|
* <<eql-search>>
|
|
* <<eql-syntax>>
|
|
* <<eql-function-ref>>
|
|
* <<eql-limitations>>
|
|
|
|
include::requirements.asciidoc[]
|
|
include::search.asciidoc[]
|
|
include::syntax.asciidoc[]
|
|
include::functions.asciidoc[]
|
|
include::limitations.asciidoc[]
|