-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[DOCS] Document any keyword in EQL syntax
#52821
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
Conversation
Adds documentation for the `any` keyword to the EQL syntax docs. Includes: * Definition of an event type and its relationship to the event type field. * Example matching all event types using `any` keyword * Example matching event types beginning with a digit * Example using `any` with `where true`
|
Pinging @elastic/es-search (:Search/EQL) |
|
Pinging @elastic/es-docs (>docs) |
astefan
left a comment
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.
LGTM.
Unrelated to the changes in this PR, is the in and not in lookup operator already supported?
docs/reference/eql/syntax.asciidoc
Outdated
| [[eql-syntax-event-types-starting-with-digits]] | ||
| ===== Event types starting with digits | ||
|
|
||
| EQL queries cannot start with a digit. To match event types starting with a |
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.
I think it's safe to drop this section, since we've never suggested anywhere else that this should be supported behavior.
There is an issue that was created for this (#51853), but I think that's more of a feature request than a bug.
My worry here is that the emphasis on digits could cause confusion. You also currently run into the same problem if there are hyphens or special characters in the event type.
One thing we could do, is reuse or merge this section with the previous mention that documents that don't have an "event type" and can't that be queried with the form <event type> where <condition>, can use any where. I think it's good that you show cases where any where ... is convenient, and also when it's necessary.
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.
Thanks for the feedback @rw-access. With ea38a56, I added a sentence to the previous section stating that any where can be used for documents without an event type field. Feels much less corner-case-y.
|
@astefan It appears that
|
matriv
left a comment
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.
LGTM
Adds documentation for the `any` keyword to the EQL syntax docs. Includes: * Definition of an event category and its relationship to the event category field. * Example matching all event categories using `any` keyword * Example using `any` with `where true`
Adds documentation for the
anykeyword to the EQL syntax docs.Includes:
field.
anykeywordanywithwhere trueDepends on #52526