127 Commits

Author SHA1 Message Date
James Rodewig
988e8c8fc6
[DOCS] Swap [float] for [discrete] ()
Changes instances of `[float]` in our docs for `[discrete]`.

Asciidoctor prefers the `[discrete]` tag for floating headings:
https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 12:42:33 -04:00
James Rodewig
828aa6f640
[DOCS] EQL: Remove collapsible sections from EQL search docs () () 2020-07-20 09:26:32 -04:00
James Rodewig
43481441e9
[DOCS] EQL: Update EQL search response format () () 2020-07-15 17:23:48 -04:00
James Rodewig
e30af2fc35
[DOCS] Fix syntax and wording in EQL docs () () 2020-07-15 14:45:56 -04:00
James Rodewig
8cac702171 [DOCS] Note that EQL timestamp field can also be date_nanos 2020-07-15 09:55:55 -04:00
Costin Leau
679619c798 EQL: Improve retrieval of results ()
Instead of retrieving an entire SearchHit, get just a reference and
postpone the document retrieval when assembling the final results.
Remove sort information from results to make them consistent.
Move TumblingWindow under the sequence package.

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
(cherry picked from commit bccfbcd81f2f1d3552e95e4a9ee2618fb3059bd9)
2020-07-14 23:53:57 +03:00
James Rodewig
2629a95e14
[DOCS] EQL: Document until keyword support () () 2020-07-13 09:05:47 -04:00
James Rodewig
896d0ffd9b
[DOCS] EQL: Prepare docs for release () ()
Changes:

* Swaps the `dev` admonitions for `experimental` admonitions
* Removes `ifdef` statements preventing the docs from appearing in
  released branches
2020-07-13 09:04:15 -04:00
James Rodewig
9d5c091f7a
[DOCS] Add data streams to EQL search docs () () 2020-07-13 09:03:55 -04:00
Andrei Stefan
c0e0bca84c
Remove search_after and implicit_join_key_field () ()
(cherry picked from commit 6ede6c59eff321b9fedad30e19508b9e4f788b54)
2020-07-09 12:34:01 +03:00
James Rodewig
93a5eb0688
[DOCS] EQL: Document size limit for pipes () ()
Changes:
* Documents the `size` default as `10`.
* Updates `size` param def to note its relation to pipes.
* Updates the `head` and `tail` pipe docs to modify sequences.
* Documents the `fetch_size` parameter.

Relates to  and 
2020-07-08 12:22:57 -04:00
James Rodewig
b27de36b5d
[DOCS] EQL: Document maxspan keyword () () 2020-07-08 11:04:28 -04:00
James Rodewig
37be56ab97
[DOCS] EQL: Document unsupported var comparison () ()
ES EQL queries do not support the comparison of a variable, such as
a field value, to another variable.

This adds a related para and example to the EQL syntax docs.
2020-07-08 11:04:05 -04:00
James Rodewig
6ed356ffc3
[DOCS] Replace datatype with data type () () 2020-07-07 14:59:35 -04:00
DeDe Morton
2c43421208 [DOCS] Change Beats links to refactored getting started docs () 2020-07-02 17:11:25 -07:00
James Rodewig
770f9f11af [DOCS] Fix xref format in async EQL search docs 2020-06-30 09:37:47 -04:00
James Rodewig
d8731853a3
[DOCS] EQL: Document head and tail pipes () () 2020-06-30 09:12:54 -04:00
James Rodewig
735a3f344d
[DOCS] EQL: Remove fields from EQL search response () () 2020-06-29 09:34:20 -04:00
Costin Leau
3c81b91474 EQL: Add Head/Tail pipe support ()
Introduce pipe support, in particular head and tail
(which can also be chained).

(cherry picked from commit 4521ca3367147d4d6531cf0ab975d8d705f400ea)
(cherry picked from commit d6731d659d012c96b19879d13cfc9e1eaf4745a4)
2020-06-27 09:49:14 +03:00
James Rodewig
b37b318d0d
[DOCS] EQL: Remove references to partial async EQL results () ()
Removes references to partial results from the async EQL search docs.
If an EQL search does not complete during the `wait_for_completion_timeout`
timeout period, it returns no results.
2020-06-26 11:11:55 -04:00
James Rodewig
c613e0915a
[DOCS] EQL: Document search API's tiebreaker_field param () () 2020-06-26 09:25:24 -04:00
Igor Motov
20af856abd
[7.x] EQL: Adds an ability to execute an asynchronous EQL search ()
Adds async support to EQL searches

Closes 

Co-authored-by: James Rodewig james.rodewig@elastic.co
2020-06-25 14:11:57 -04:00
James Rodewig
44c3bb29e2 [DOCS] EQL: Correct EQL search API's size param def
The `size` parameter can be used to limit matching events or sequences.
2020-06-10 10:12:54 -04:00
James Rodewig
641ed484d8
[DOCS] EQL: Add dev admonition to EQL pages () ()
Adds the `dev` admonition to EQL features, which are in development
under a feature flag.
2020-06-02 11:03:12 -04:00
James Rodewig
fd6dabf158
[DOCS] EQL: Fix hits param for sequences () () 2020-06-02 09:38:00 -04:00
Lisa Cawley
db5bf92acf
[7.x][DOCS] Replace docdir attribute with es-repo-dir () () 2020-06-01 16:42:53 -07:00
James Rodewig
cc12361a82 [DOCS] EQL: Fix whitespace in EQL snippet 2020-05-19 17:04:49 -04:00
James Rodewig
771ddbf083
[DOCS] EQL: Add sequence example to tutorial () ()
Adds an example using the sequence syntax to the 'Run an EQL search'
tutorial.

Supplements other examples added with 
2020-05-19 16:14:57 -04:00
James Rodewig
cc43d67eb1 [DOCS] Add leading slashes to EQL API examples 2020-05-19 15:38:37 -04:00
James Rodewig
22f54ba205 [DOCS] EQL: Fix API example headings 2020-05-18 16:29:29 -04:00
James Rodewig
c50f86fbba
[DOCS] EQL: Document case_sensitive param () () 2020-05-15 11:47:19 -04:00
James Rodewig
5e09762a27 [DOCS] EQL: Align comments in between fn examples 2020-05-15 09:20:45 -04:00
James Rodewig
24cd45345e [DOCS] EQL: Remove references to arrays/multi-value fields () 2020-05-15 09:09:07 -04:00
James Rodewig
2a943a58a4
[DOCS] EQL: Document number function ()
Co-authored-by: Ross Wolf <31489089+rw-access@users.noreply.github.com>
2020-05-14 15:44:04 -04:00
James Rodewig
2921747b23
[7.x] [DOCS] EQL: Document sequences () ()
Co-authored-by: Ross Wolf <31489089+rw-access@users.noreply.github.com>
2020-05-14 11:51:40 -04:00
James Rodewig
d247e8f7a6 [DOCS] Sort EQL search API params alphabetically 2020-05-12 13:52:18 -04:00
James Rodewig
8e005db3e6
[DOCS] EQL: Document math functions () ()
Documents the following EQL functions:

* `add`
* `divide`
* `module`
* `multiply`
* `subtract`
2020-05-07 09:18:43 -04:00
James Rodewig
8686200a32 [DOCS] EQL: Document concat function ()
Co-authored-by: Ross Wolf <31489089+rw-access@users.noreply.github.com>
2020-05-05 16:45:29 -04:00
James Rodewig
dac4ed282e [DOCS] EQL: Add collapsible sections to EQL tutorial docs ()
Adds collapsible sections to the snippet examples of the EQL tutorial
docs.

Also adds a leading slash to EQL API snippet examples.
2020-05-05 16:29:51 -04:00
James Rodewig
e7df8b388e [DOCS] EQL: Add collapsible sections to EQL search API response ()
Add collapsible sections to the response parameter docs
of the EQL search API.

Also clarifies some language regarding documents and
events.
2020-05-05 16:01:55 -04:00
James Rodewig
cd3663e5fa
[DOCS] EQL: Document match function () 2020-05-05 12:03:02 -04:00
James Rodewig
44414acd3b
[DOCS] EQL: Document nested field support ()
Notes that you cannot use EQL in ES to search the values of `nested`
fields or their sub-fields. However, indices containing `nested` field
mappings are otherwise supported.
2020-05-05 11:46:06 -04:00
James Rodewig
4dfdd46dc3 [DOCS] EQL: Remove case sensitivity from function docs ()
Per , we plan to handle case sensitivity via a parameter for the
EQL search API (with the possible exception of the `between` function).

This removes references and examples related to case sensitivity from
the EQL functions docs.
2020-05-05 09:26:49 -04:00
James Rodewig
61cf646f17
[DOCS] EQL: Add advantages to overview () ()
Adds a concise list of EQL advantages, based on the "EQL Advantages"
section in the [EQL for the masses][0] blog post.

The intent is to inform users how EQL could benefit at a high level.

[0]: https://www.elastic.co/blog/eql-for-the-masses

Co-Authored-By: Ross Wolf <31489089+rw-access@users.noreply.github.com>
2020-04-30 13:19:31 -04:00
James Rodewig
65b47d20a6 [DOCS] Update attribute for multi arg footnotes () 2020-04-29 10:25:36 -04:00
James Rodewig
1808a1f36b [DOCS] EQL: Correct cidrMatch function heading () 2020-04-29 10:02:06 -04:00
James Rodewig
c16b1edae0 [DOCS] EQL: Fix whitespace in stringContains docs 2020-04-27 15:53:59 -04:00
James Rodewig
c1b0548db0
[DOCS] Document EQL search REST API () 2020-04-24 15:36:01 -04:00
James Rodewig
5981412bf7
[DOCS] EQL: Document stringContains function () 2020-04-24 15:09:05 -04:00
James Rodewig
e4ebe55d04
[DOCS] EQL: Document cidrMatch function () () 2020-04-24 14:01:11 -04:00