From 2a4380e0aae7b72daaf2bde0906a43f77653a796 Mon Sep 17 00:00:00 2001 From: David Roberts Date: Mon, 22 Jul 2019 17:52:39 +0100 Subject: [PATCH] [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 --- docs/reference/data-frames/apis/put-transform.asciidoc | 8 +++++--- .../reference/data-frames/apis/transformresource.asciidoc | 8 +++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index ef66abaf3b8..252cf0450c5 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -62,9 +62,11 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. (Optional, string) The unique identifier for a <>. `frequency`:: - (Optional, time units) The interval between checks for changes in the source indices - when the {dataframe-transform} is running continuously. Defaults to `1m`. - The lowest permitted value is `1s`; the highest `1h`. + (Optional, time units) The interval between checks for changes in the source + indices when the {dataframe-transform} is running continuously. Also determines + 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`:: (Required, object) Defines the pivot function `group by` fields and the aggregation to diff --git a/docs/reference/data-frames/apis/transformresource.asciidoc b/docs/reference/data-frames/apis/transformresource.asciidoc index b68ef6fe9a3..4f6b43c43bc 100644 --- a/docs/reference/data-frames/apis/transformresource.asciidoc +++ b/docs/reference/data-frames/apis/transformresource.asciidoc @@ -21,8 +21,10 @@ For more information, see `frequency`:: (time units) The interval between checks for changes in the source indices - when the {dataframe-transform} is running continuously. The minimum value is - `1s` and the maximum is `1h`. The default value is `1m`. + when the {dataframe-transform} is running continuously. Also determines 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`. `id`:: (string) A unique identifier for the {dataframe-transform}. @@ -122,4 +124,4 @@ composite aggregations. See ==== {api-examples-title} See the -<>. \ No newline at end of file +<>.