honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarifies data frame transform frequency is also for retries (#44229) 

In data frame transforms the same scheduler controls both
retries in the event of search failures and gaps between
checks for changes when the transform is running continuously.

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
David Roberts 2019-07-22 17:52:39 +01:00
parent bcb3563dcf
commit 2a4380e0aa
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/data-frames/apis/put-transform.asciidoc
View File

@ -62,9 +62,11 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
(Optional, string) The unique identifier for a <<pipeline,pipeline>>. (Optional, string) The unique identifier for a <<pipeline,pipeline>>.
`frequency`:: `frequency`::
(Optional, time units) The interval between checks for changes in the source indices (Optional, time units) The interval between checks for changes in the source
when the {dataframe-transform} is running continuously. Defaults to `1m`. indices when the {dataframe-transform} is running continuously. Also determines
The lowest permitted value is `1s`; the highest `1h`. the retry interval in the event of transient failures while the {dataframe-transform} is
searching or indexing. The minimum value is `1s` and the maximum is `1h`. The
default value is `1m`.
`pivot`:: `pivot`::
(Required, object) Defines the pivot function `group by` fields and the aggregation to (Required, object) Defines the pivot function `group by` fields and the aggregation to

8
docs/reference/data-frames/apis/transformresource.asciidoc
View File

@ -21,8 +21,10 @@ For more information, see
`frequency`:: `frequency`::
(time units) The interval between checks for changes in the source indices (time units) The interval between checks for changes in the source indices
when the {dataframe-transform} is running continuously. The minimum value is when the {dataframe-transform} is running continuously. Also determines the
`1s` and the maximum is `1h`. The default value is `1m`. retry interval in the event of transient failures while the {dataframe-transform} is
searching or indexing. The minimum value is `1s` and the maximum is `1h`. The
default value is `1m`.
`id`:: `id`::
(string) A unique identifier for the {dataframe-transform}. (string) A unique identifier for the {dataframe-transform}.
@ -122,4 +124,4 @@ composite aggregations. See
==== {api-examples-title} ==== {api-examples-title}
See the See the
<<put-data-frame-transform-example,create {dataframe-transforms} API examples>>. <<put-data-frame-transform-example,create {dataframe-transforms} API examples>>.