Skip to content

Commit 0b20d99

Browse files
(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.
1 parent 3091155 commit 0b20d99

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ preview::[]
99
The time series aggregation queries data created using a time series index. 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+
When you create a time series index, you must:
15+
16+
* Set `index.mode` to `"time_series"`.
17+
* Specify at least one dimension field by adding `"time_series_dimension": true` in your mapping.
18+
* Provide a `routing_path` array listing the dimension fields.
19+
20+
These fields ensure that documents sharing the same dimensions are routed to the same shard,
21+
and they allow the `time_series` aggregation to produce meaningful bucket results.
22+
====
23+
1224
//////////////////////////
1325
1426
Creating a time series mapping

0 commit comments

Comments
 (0)