1
0
Эх сурвалжийг харах

[DOCS] Add time range info to TSDS docs (#91291)

* [DOCS] Add time range info to TSDS docs

* Fixup
David Kilfoyle 2 жил өмнө
parent
commit
3295662697

+ 3 - 2
docs/reference/data-streams/set-up-tsds.asciidoc

@@ -279,8 +279,9 @@ To automatically create your TSDS, submit an indexing request that
 targets the TSDS's name. This name must match one of your index template's
 index patterns.
 
-To test the following example, update the timestamps to within the 24 hours after
-your current time.
+IMPORTANT: To test the following example, update the timestamps to within three hours of
+your current time. Data added to a TSDS must always fall within an
+<<tsds-accepted-time-range,accepted time range>>.
 
 [source,console]
 ----

+ 20 - 0
docs/reference/data-streams/tsds.asciidoc

@@ -242,6 +242,26 @@ value borders the `index.time_series.start_time` for the new write index. This
 ensures the `@timestamp` ranges for neighboring backing indices always border
 but never overlap.
 
+[discrete]
+[[tsds-accepted-time-range]]
+==== Accepted time range for adding data
+
+A TSDS is designed to ingest current metrics data. When the TSDS is first
+created the initial backing index has:
+
+* an `index.time_series.start_time` value set to `now - index.look_ahead_time`
+* an `index.time_series.end_time` value set to `now + index.look_ahead_time`
+
+Only data that falls inside that range can be indexed.
+
+In our <<tsds-create-index-settings-component-template,TSDS example>>,
+`index.look_ahead_time` is set to three hours, so only documents with a
+`@timestamp` value that is within three hours previous or subsequent to the
+present time are accepted for indexing.
+
+You can use the <<indices-get-data-stream,get data stream API>> to check the
+accepted time range for writing to any TSDS.
+
 [discrete]
 [[dimension-based-routing]]
 ==== Dimension-based routing