Commit Graph

47 Commits

Author SHA1 Message Date
James Rodewig 4e005c041c
[DOCS] EQL: Fix delete async EQL search snippet (#75093)
The delete async EQL search API doesn't support the `keep_alive` query parameter.
2021-07-07 16:49:22 -04:00
James Rodewig 3971522c65
[DOCS] EQL: Document cross-cluster search support (#74995) (#75045)
Closes #74842.
2021-07-07 09:41:07 -04:00
Marios Trivyzas dd302dcfef
EQL: [Docs] Add documentation for the CircuitBreaker (#74897)
Add documentation for the newly introduced CircuitBreaker, which is
used to restrict the memory usage for an EQL sequence query to avoid
OutOfMemory exceptions.

Follows: #74381
2021-07-07 09:20:25 +02:00
James Rodewig 845446aec3 [DOCS] EQL: Remove erroneous CSS reference 2021-07-01 17:05:44 -04:00
James Rodewig 965baad5c4
[DOCS] EQL: Update tiebreaker docs for implicit tiebreaker (#72808) 2021-05-06 14:48:46 -04:00
James Rodewig 889197f8d0 [DOCS] Fix formatting 2021-04-28 11:40:33 -04:00
James Rodewig 13179c71b6
[DOCS] EQL: Shorten response snippets (#72330)
Shortens several lengthy response snippets to better highlight the
relevant parts.
2021-04-27 16:02:45 -04:00
James Rodewig 3f2eb32afc
[DOCS] Sync EQL docs with `fields` param updates (#72008) 2021-04-21 09:13:27 -04:00
Adam Locke 6dfd92c46f
[DOCS] Focus retrieving selected fields on fields parameter (#71506)
* [DOCS] Focus retrieving selected fields on fields parameter

* Incorporating changes from reviews

* Adding clarifications from review feedback

* Slight wording revisions.

* Clarify language around format parameter and move text out of callout.
2021-04-20 15:11:35 -04:00
James Rodewig 07fade1d27
[DOCS] EQL/SQL: Document `runtime_fields` parameter (#71487) 2021-04-19 09:15:12 -04:00
James Rodewig de228ee153
[DOCS] Reorder EQL sections. Remove duplicated content. (#71477) 2021-04-08 10:45:33 -04:00
James Rodewig 6504b541e9
[DOCS] EQL: Use data streams in docs (#70822) 2021-03-25 09:41:06 -04:00
James Rodewig 75b0917ca1
[DOCS] Fix EQL heading levels (#70255)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-10 14:20:22 -05:00
James Rodewig 5bf7a0a995 [DOCS] Add fields param xref 2021-03-08 16:40:11 -05:00
James Rodewig 783769d8d9
[DOCS] Add `fields` parameter to EQL search API (#69634) 2021-03-01 12:00:27 -05:00
James Rodewig 593cac391d [DOCS] Make whitespace consistent in JSON snippets 2021-02-25 16:12:47 -05:00
James Rodewig 31fc59efdf
[DOCS] Fix capitalization for Query DSL (#69236) 2021-02-18 18:57:19 -05:00
Mayya Sharipova 6521d2af27
Introduce eql search status API (#68065)
Introduce eql search status API,
that reports the status of eql stored or async search.

GET _eql/search/status/<id>

The API is restricted to the monitoring_user role.

For a running eql search, a response has the following format:

{
  "id" : <id>,
  "is_running" : true,
  "is_partial" : true,
  "start_time_in_millis" : 1611690235000,
  "expiration_time_in_millis" : 1611690295000
}

For a completed eql search, a response has the following format:

{
  "id" : <id>,
  "is_running" : false,
  "is_partial" : false,
  "expiration_time_in_millis" : 1611690295000,
  "completion_status" : 200
}

Closes #66955
2021-02-11 09:30:13 -05:00
James Rodewig 6378c57ca0
[DOCS] EQL: Add `filter_path` param to EQL search API docs (#68537) 2021-02-04 13:39:01 -05:00
James Rodewig c4ab89f3f7
[DOCS] EQL: Add security privileges to EQL search docs (#68017) 2021-01-27 16:25:05 -05:00
James Rodewig 14b381a2ad
[DOCS] EQL: Change `result_position` default to `tail` (#66550) 2020-12-18 08:38:45 -05:00
James Rodewig 9b3bb56179
[DOCS] EQL: Move to GA (#65955) 2020-12-09 08:48:23 -05:00
James Rodewig 36d308bc23
[DOCS] EQL: Update docs for null tiebreakers (#65078) 2020-11-17 09:31:49 -05:00
James Rodewig fb1936bed1
[DOCS] EQL: Fix tiebreaker field docs (#64671)
Corrects the EQL docs to remove `event.sequence` as the default `tiebreaker_field` value.
2020-11-06 09:05:18 -05:00
James Rodewig 5953a90505 [DOCS] Remove unneeded words in EQL docs 2020-10-24 20:27:34 -04:00
James Rodewig 4c22ca3eed
[DOCS] Tighten async EQL copy (#64106) 2020-10-24 14:14:30 -04:00
James Rodewig f6bce6194f
[DOCS] Tighten EQL copy (#64081) 2020-10-24 10:49:05 -04:00
James Rodewig 505b03768a [DOCS] Reword EQL intro 2020-10-14 10:02:45 -04:00
James Rodewig 8527183f91
[DOCS] EQL: Remove Endgame EQL refs (#63636) 2020-10-14 08:34:11 -04:00
James Rodewig 04c8ad3ced
[DOCS] EQL: Move to beta (#63284) 2020-10-12 08:55:16 -04:00
Andrei Stefan 7550e0664c
Remove case_sensitive request option (#63218)
Make EQL case sensitive by default and adapt some of the string functions
Remove the case sensitive option from Between string function
Add case_insensitive option to term and wildcard queries usage
2020-10-05 16:53:25 +03:00
James Rodewig cb9e61fae5
[DOCS] EQL: Update grammary for escaped event categories (#63202) 2020-10-02 15:03:29 -04:00
James Rodewig 15d4d9597c
[DOCS] EQL: date_nanos timestamp is not supported (#63101) 2020-09-30 17:31:24 -04:00
James Rodewig 844558069b
[DOCS] EQL: Clarify EQL docs (#62961) 2020-09-28 15:29:35 -04:00
James Rodewig 7630064a25 [DOCS] EQL: Add xrefs to EQL intro 2020-09-16 10:41:56 -04:00
James Rodewig 09547886b0
[DOCS] EQL: Update keyword family field types (#62254)
Updates several keyword/constant keyword references to use any field type in the
keyword family.
2020-09-14 09:35:23 -04:00
James Rodewig f881a695e1
[DOCS] Add redirects for wildcard and constant keyword (#61815) 2020-09-01 15:32:35 -04:00
James Rodewig 35b35148b9
[DOCS] Remove response params for #61428 (#61524) 2020-08-25 09:30:38 -04:00
Costin Leau 997376fbe6
EQL: Replace SearchHit in response with Event (#61428)
The building block of the eql response is currently the SearchHit. This
is a problem since it is tied to an actual search, and thus has scoring,
highlighting, shard information and a lot of other things that are not
relevant for EQL.
This becomes a problem when doing sequence queries since the response is
not generated from one search query and thus there are no SearchHits to
speak of.
Emulating one is not just conceptually incorrect but also problematic
since most of the data is missed or made-up.

As such this PR introduces a simple class, Event, that maps nicely to
the terminology while hiding the ES internals (the use of SearchHit or
GetResult/GetResponse depending on the API used).

Fix #59764
Fix #59779

Co-authored-by: Igor Motov <igor@motovs.org>
2020-08-25 14:27:56 +03:00
James Rodewig c688cb6bfd
[DOCS] Fix hyphenation for "time series" (#61472) 2020-08-24 10:34:41 -04:00
Andrei Stefan d54957d61f
EQL: Return sequence join keys in the original type (#61268) 2020-08-18 18:20:43 +03:00
James Rodewig a94e5cb7c4
[DOCS] Replace Wikipedia links with attribute (#61171) 2020-08-17 09:44:24 -04:00
James Rodewig e8a907e34a
[DOCS] EQL: Add threat detection example (#59105) 2020-08-14 13:00:34 -04:00
James Rodewig fcc3b6c80c [DOCS] Fix EQL required fields language 2020-08-12 09:47:37 -04:00
James Rodewig 7c494434d6 [DOCS] Remove unneeded word in EQL docs 2020-08-11 12:18:46 -04:00
James Rodewig d09a6cfc7c
[DOCS] Make EQL example snippets more realistic (#60971) 2020-08-11 11:38:46 -04:00
James Rodewig dca46c29ff
[DOCS] Refactor EQL docs (#60700)
Changes:

* Moves sample data to reusable rest test
* Combines EQL index, requirements, and run a search pages
* Combines EQL syntax and limitations pages
* Adds related redirects
2020-08-05 10:11:02 -04:00