Skip to content

Commit de815f2

Browse files
authored
[ML] adding delayed_data_check_config to datafeed update docs (#42095) (#42633)
* [ML] adding delayed_data_check_config to datafeed update docs * [DOCS] Edits delayed data configuration details
1 parent 7d81c6e commit de815f2

File tree

3 files changed

+30
-20
lines changed

3 files changed

+30
-20
lines changed

docs/reference/ml/apis/datafeedresource.asciidoc

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

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

7373
[[ml-datafeed-chunking-config]]
74-
==== Chunking Configuration Objects
74+
==== Chunking configuration objects
7575

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

9595
[[ml-datafeed-delayed-data-check-config]]
96-
==== Delayed Data Check Configuration Objects
96+
==== Delayed data check configuration objects
9797

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

104-
This check only runs on real-time {dfeeds}
105+
This check runs only on real-time {dfeeds}.
105106

106107
The configuration object has the following properties:
107108

108109
`enabled`::
109-
(boolean) Should the {dfeed} periodically check for data being indexed after reading.
110-
Defaults to `true`
110+
(boolean) Specifies whether the {dfeed} periodically checks for delayed data.
111+
Defaults to `true`.
111112

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

118120
[float]
119121
[[ml-datafeed-counts]]
120-
==== {dfeed-cap} Counts
122+
==== {dfeed-cap} counts
121123

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

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

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

46+
`delayed_data_check_config`::
47+
(object) Specifies whether the data feed checks for missing data and
48+
the size of the window. See
49+
<<ml-datafeed-delayed-data-check-config>>.
50+
4651
`frequency`::
4752
(time units) The interval at which scheduled queries are made while the {dfeed}
4853
runs in real time. The default value is either the bucket span for short
@@ -85,10 +90,6 @@ IMPORTANT: You must use {kib} or this API to create a {dfeed}. Do not put a {df
8590
For example: `[]`. This property is provided for backwards compatibility with
8691
releases earlier than 6.0.0. For more information, see <<removal-of-types>>.
8792

88-
`delayed_data_check_config`::
89-
(object) Specifies if and with how large a window should the data feed check
90-
for missing data. See <<ml-datafeed-delayed-data-check-config>>.
91-
9293
For more information about these properties,
9394
see <<ml-datafeed-resource>>.
9495

@@ -145,4 +146,4 @@ When the {dfeed} is created, you receive the following results:
145146
}
146147
----
147148
// TESTRESPONSE[s/"query_delay": "83474ms"/"query_delay": $body.query_delay/]
148-
// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/]
149+
// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/]

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 _xpack/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)