Skip to content

Commit f2cde97

Browse files
authored
[ML] adding delayed_data_check_config to datafeed update docs (#42095)
* [ML] adding delayed_data_check_config to datafeed update docs * [DOCS] Edits delayed data configuration details
1 parent 69ef51d commit f2cde97

File tree

3 files changed

+29
-19
lines changed

3 files changed

+29
-19
lines changed

docs/reference/ml/apis/datafeedresource.asciidoc

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ A {dfeed} resource has the following properties:
6161

6262
`delayed_data_check_config`::
6363
(object) Specifies whether the data feed checks for missing data and
64-
and the size of the window. For example:
64+
the size of the window. For example:
6565
`{"enabled": true, "check_window": "1h"}` See
6666
<<ml-datafeed-delayed-data-check-config>>.
6767

6868
[[ml-datafeed-chunking-config]]
69-
==== Chunking Configuration Objects
69+
==== Chunking configuration objects
7070

7171
{dfeeds-cap} might be required to search over long time periods, for several months
7272
or years. This search is split into time chunks in order to ensure the load
@@ -88,31 +88,33 @@ A chunking configuration object has the following properties:
8888
For example: `3h`.
8989

9090
[[ml-datafeed-delayed-data-check-config]]
91-
==== Delayed Data Check Configuration Objects
91+
==== Delayed data check configuration objects
9292

9393
The {dfeed} can optionally search over indices that have already been read in
94-
an effort to find if any data has since been added to the index. If missing data
95-
is found, it is a good indication that the `query_delay` option is set too low and
96-
the data is being indexed after the {dfeed} has passed that moment in time. See
94+
an effort to determine whether any data has subsequently been added to the index.
95+
If missing data is found, it is a good indication that the `query_delay` option
96+
is set too low and the data is being indexed after the {dfeed} has passed that
97+
moment in time. See
9798
{stack-ov}/ml-delayed-data-detection.html[Working with delayed data].
9899

99-
This check only runs on real-time {dfeeds}
100+
This check runs only on real-time {dfeeds}.
100101

101102
The configuration object has the following properties:
102103

103104
`enabled`::
104-
(boolean) Should the {dfeed} periodically check for data being indexed after reading.
105-
Defaults to `true`
105+
(boolean) Specifies whether the {dfeed} periodically checks for delayed data.
106+
Defaults to `true`.
106107

107108
`check_window`::
108-
(time units) The window of time before the latest finalized bucket that should be searched
109-
for late data. Defaults to `null` which causes an appropriate `check_window` to be calculated
110-
when the real-time {dfeed} runs.
111-
The default `check_window` span calculation is the max between `2h` or `8 * bucket_span`.
109+
(time units) The window of time that is searched for late data. This window of
110+
time ends with the latest finalized bucket. It defaults to `null`, which
111+
causes an appropriate `check_window` to be calculated when the real-time
112+
{dfeed} runs. In particular, the default `check_window` span calculation is
113+
based on the maximum of `2h` or `8 * bucket_span`.
112114

113115
[float]
114116
[[ml-datafeed-counts]]
115-
==== {dfeed-cap} Counts
117+
==== {dfeed-cap} counts
116118

117119
The get {dfeed} statistics API provides information about the operational
118120
progress of a {dfeed}. All of these properties are informational; you cannot

docs/reference/ml/apis/put-datafeed.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
4545
(object) Specifies how data searches are split into time chunks.
4646
See <<ml-datafeed-chunking-config>>.
4747

48+
`delayed_data_check_config`::
49+
(object) Specifies whether the data feed checks for missing data and
50+
the size of the window. See
51+
<<ml-datafeed-delayed-data-check-config>>.
52+
4853
`frequency`::
4954
(time units) The interval at which scheduled queries are made while the {dfeed}
5055
runs in real time. The default value is either the bucket span for short
@@ -82,10 +87,6 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
8287
(unsigned integer) The `size` parameter that is used in {es} searches.
8388
The default value is `1000`.
8489

85-
`delayed_data_check_config`::
86-
(object) Specifies if and with how large a window should the data feed check
87-
for missing data. See <<ml-datafeed-delayed-data-check-config>>.
88-
8990
For more information about these properties,
9091
see <<ml-datafeed-resource>>.
9192

docs/reference/ml/apis/update-datafeed.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ Updates certain properties of a {dfeed}.
1414

1515
`POST _ml/datafeeds/<feed_id>/_update`
1616

17-
//===== Description
17+
===== Description
18+
19+
NOTE: If you update the `delayed_data_check_config` property, you must stop and
20+
start the {dfeed} for the change to be applied.
1821

1922
==== Path Parameters
2023

@@ -32,6 +35,10 @@ The following properties can be updated after the {dfeed} is created:
3235
`chunking_config`::
3336
(object) Specifies how data searches are split into time chunks.
3437
See <<ml-datafeed-chunking-config>>.
38+
39+
`delayed_data_check_config`::
40+
(object) Specifies whether the data feed checks for missing data and
41+
the size of the window. See <<ml-datafeed-delayed-data-check-config>>.
3542

3643
`frequency`::
3744
(time units) The interval at which scheduled queries are made while the

0 commit comments

Comments
 (0)