Skip to content

Commit 3b5358f

Browse files
droberts195lcawl
andcommitted
[DOCS] Clarifies data frame transform frequency is also for retries (elastic#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 <[email protected]>
1 parent b4a7cac commit 3b5358f

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/reference/data-frames/apis/put-transform.asciidoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,11 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
6262
(Optional, string) The unique identifier for a <<pipeline,pipeline>>.
6363

6464
`frequency`::
65-
(Optional, time units) The interval between checks for changes in the source indices
66-
when the {dataframe-transform} is running continuously. Defaults to `1m`.
67-
The lowest permitted value is `1s`; the highest `1h`.
65+
(Optional, time units) The interval between checks for changes in the source
66+
indices when the {dataframe-transform} is running continuously. Also determines
67+
the retry interval in the event of transient failures while the {dataframe-transform} is
68+
searching or indexing. The minimum value is `1s` and the maximum is `1h`. The
69+
default value is `1m`.
6870

6971
`pivot`::
7072
(Required, object) Defines the pivot function `group by` fields and the aggregation to

docs/reference/data-frames/apis/transformresource.asciidoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ For more information, see
2121

2222
`frequency`::
2323
(time units) The interval between checks for changes in the source indices
24-
when the {dataframe-transform} is running continuously. The minimum value is
25-
`1s` and the maximum is `1h`. The default value is `1m`.
24+
when the {dataframe-transform} is running continuously. Also determines the
25+
retry interval in the event of transient failures while the {dataframe-transform} is
26+
searching or indexing. The minimum value is `1s` and the maximum is `1h`. The
27+
default value is `1m`.
2628

2729
`id`::
2830
(string) A unique identifier for the {dataframe-transform}.
@@ -122,4 +124,4 @@ composite aggregations. See
122124
==== {api-examples-title}
123125

124126
See the
125-
<<put-data-frame-transform-example,create {dataframe-transforms} API examples>>.
127+
<<put-data-frame-transform-example,create {dataframe-transforms} API examples>>.

0 commit comments

Comments
 (0)