-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Add top-level EQL docs page. Adds EQL requirements page. #51334
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| [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 requirements>> | ||
|
|
||
| include::requirements.asciidoc[] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| [role="xpack"] | ||
| [testenv="basic"] | ||
| [[eql-requirements]] | ||
| == EQL requirements | ||
| ++++ | ||
| <titleabbrev>Requirements</titleabbrev> | ||
| ++++ | ||
|
|
||
| EQL is schemaless and works out-of-the-box with most common log formats. If you | ||
| use a standard log format and already know what fields in your index contain | ||
| event type and timestamp information, you can skip this page. | ||
|
|
||
| [discrete] | ||
| [[eql-required-fields]] | ||
| === Required fields | ||
|
|
||
| In {es}, EQL assumes each document in an index corresponds to an event. | ||
|
|
||
| To search an index using EQL, each document in the index must contain the | ||
| following field archetypes: | ||
|
|
||
| Event type:: | ||
| A field containing the event classification, such as `process`, `file`, or | ||
| `network`. This is typically mapped as a <<keyword,`keyword`>> field. | ||
|
|
||
| Timestamp:: | ||
| A field containing the date and/or time the event occurred. This is typically | ||
| mapped as a <<date,`date`>> field. | ||
|
|
||
| [TIP] | ||
| ==== | ||
| While no schema is required to use EQL in {es}, we recommend the | ||
| {ecs-ref}[Elastic Common Schema (ECS)]. {es}'s EQL search is designed to work | ||
| with core ECS fields by default. | ||
| ==== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sethpayne Do you think this covers most of our major use cases for EQL within ES?