From ea67b55c98d94eadc4747ca078c4b77bb6838125 Mon Sep 17 00:00:00 2001 From: "Jihyun(Brian) Jeong" Date: Wed, 29 Jan 2025 23:03:11 +1100 Subject: [PATCH] (Doc+) Clarify dimension field requirements for time_series aggregation (#119442) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * (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 <58563081+shainaraskas@users.noreply.github.com> --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> (cherry picked from commit e1207398c72fe930dceab40e6d995ae220ad0c71) --- .../aggregations/bucket/time-series-aggregation.asciidoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/reference/aggregations/bucket/time-series-aggregation.asciidoc b/docs/reference/aggregations/bucket/time-series-aggregation.asciidoc index 1fb527cd645f0..86e8355b69882 100644 --- a/docs/reference/aggregations/bucket/time-series-aggregation.asciidoc +++ b/docs/reference/aggregations/bucket/time-series-aggregation.asciidoc @@ -6,9 +6,14 @@ preview::[] -The time series aggregation queries data created using a time series index. This is typically data such as metrics +The time series aggregation queries data created using a <>. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode. +[NOTE] +==== +Refer to the <> to learn more about the key differences from regular data streams. +==== + ////////////////////////// Creating a time series mapping