Skip to content

Commit 9aa6c19

Browse files
authored
Document ILM waits for tsds end_time to lapse in some actions (#100204) (#100267)
(cherry picked from commit 632c97b) Signed-off-by: Andrei Dan <[email protected]>
1 parent 07650dd commit 9aa6c19

File tree

3 files changed

+26
-6
lines changed

3 files changed

+26
-6
lines changed

docs/reference/data-streams/downsampling-ilm.asciidoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,17 @@ To enable downsampling, add a <<ilm-downsample,Downsample action>> and set
3737
which you want to aggregate the original time series data.
3838

3939
In this example, an ILM policy is configured for the `hot` phase. The downsample
40-
takes place after the initial index rollover, which for demonstration
41-
purposes is set to run after five minutes.
40+
takes place after the index is rolled over and the <<index-time-series-end-time, index time series end time>>
41+
has lapsed as the source index is still expected to receive major writes until then.
42+
{ilm-cap} will not proceed with any action that expects the index to not receive
43+
writes anymore until the <<index-time-series-end-time, index's end time>> has
44+
passed. The {ilm-cap} actions that wait on the end time before proceeding are:
45+
- <<ilm-delete>>
46+
- <<ilm-downsample>>
47+
- <<ilm-forcemerge>>
48+
- <<ilm-readonly>>
49+
- <<ilm-searchable-snapshot>>
50+
- <<ilm-shrink>>
4251

4352
[source,console]
4453
----

docs/reference/data-streams/tsds-index-settings.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ days). Only indices with an `index.mode` of `time_series` support this setting.
3333
For more information, refer to <<tsds-look-ahead-time>>. Additionally this setting
3434
can not be less than `time_series.poll_interval` cluster setting.
3535

36+
NOTE: Increasing the `look_ahead_time` will also increase the amount of time {ilm-cap}
37+
waits before being able to proceed with executing the actions that expect the
38+
index to not receive any writes anymore. For more information, refer to <<time-bound-indices>>.
39+
3640
[[index-routing-path]] `index.routing_path`::
3741
(<<_static_index_settings,Static>>, string or array of strings) Plain `keyword`
3842
fields used to route documents in a TSDS to index shards. Supports wildcards

docs/reference/data-streams/tsds.asciidoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,10 +218,17 @@ if the index isn't the most recent backing index.
218218

219219
image::images/data-streams/time-bound-indices.svg[align="center"]
220220

221-
TIP: Some {ilm-init} actions, such as <<ilm-forcemerge,`forcemerge`>>,
222-
<<ilm-shrink,`shrink`>>, and <<ilm-searchable-snapshot,`searchable_snapshot`>>,
223-
make a backing index read-only. You cannot add documents to read-only indices.
224-
Keep this in mind when defining the index lifecycle policy for your TSDS.
221+
TIP: Some {ilm-init} actions mark the source index as read-only, or expect the index
222+
to not be actively written anymore in order to provide good performance. These actions are:
223+
- <<ilm-delete>>
224+
- <<ilm-downsample>>
225+
- <<ilm-forcemerge>>
226+
- <<ilm-readonly>>
227+
- <<ilm-searchable-snapshot>>
228+
- <<ilm-shrink>>
229+
{ilm-cap} will **not** proceed with executing these actions until the upper time-bound
230+
for accepting writes, represented by the <<index-time-series-end-time,`index.time_series.end_time`>>
231+
index setting, has lapsed.
225232

226233
If no backing index can accept a document's `@timestamp` value, {es} rejects the
227234
document.

0 commit comments

Comments
 (0)