Skip to content

Commit b362402

Browse files
jihyunjeongmeleemthomposhainaraskas
committed
(Doc+) Clarify dimension field requirements for time_series aggregation (#119442)
* (Doc+) Clarify dimension field requirements for time_series aggregation 👋 howdy, team! This PR adds a note explaining that time series indices require: - index.mode set to "time_series" - at least one dimension field with time_series_dimension: true - a routing_path array listing those dimension fields Without these settings, the time_series aggregation may return empty buckets or behave unexpectedly. By emphasizing the dimension field requirement, we help users configure their time series indices correctly and see meaningful aggregation results. * Apply suggestions from code review Co-authored-by: shainaraskas <[email protected]> --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> (cherry picked from commit e120739)
1 parent 1db1c20 commit b362402

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/reference/aggregations/bucket/time-series-aggregation.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66

77
preview::[]
88

9-
The time series aggregation queries data created using a time series index. This is typically data such as metrics
9+
The time series aggregation queries data created using a <<tsds,Time series data stream (TSDS)>>. This is typically data such as metrics
1010
or other data streams with a time component, and requires creating an index using the time series mode.
1111

12+
[NOTE]
13+
====
14+
Refer to the <<differences-from-regular-data-stream, TSDS documentation>> to learn more about the key differences from regular data streams.
15+
====
16+
1217
//////////////////////////
1318
1419
Creating a time series mapping

0 commit comments

Comments
 (0)