elasticsearch/docs/reference/aggregations/bucket
Jihyun(Brian) Jeong e1207398c7
(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 <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>
2025-01-29 13:03:11 +01:00
..
adjacency-matrix-aggregation.asciidoc [ML] Improve categorize_text docs (#90765) 2022-10-13 10:46:53 +01:00
autodatehistogram-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
categorize-text-aggregation.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00
children-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
composite-aggregation.asciidoc Use CLDR locale provider on JDK 23+ (#110222) 2024-09-04 13:42:40 +01:00
datehistogram-aggregation.asciidoc Use CLDR locale provider on JDK 23+ (#110222) 2024-09-04 13:42:40 +01:00
daterange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
diversified-sampler-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
filter-aggregation.asciidoc Update docs for filter agg (#72508) 2021-05-06 14:51:16 -04:00
filters-aggregation.asciidoc Add keyed param to allow named filters agg return buckets as an array of objects (#89256) 2023-04-10 13:53:26 -04:00
frequent-item-sets-aggregation.asciidoc [ML] rename frequent_items to frequent_item_sets and make it GA (#93421) 2023-02-02 09:25:00 +01:00
geodistance-aggregation.asciidoc Soft-deprecation of point/geo_point formats (#86835) 2022-05-17 23:46:43 +02:00
geohashgrid-aggregation.asciidoc [DOCS] Update geohash_grid agg field description (#98494) 2023-08-15 15:59:16 +02:00
geohexgrid-aggregation.asciidoc Documentation for geohex_grid over geo_shape (#92999) 2023-01-24 16:03:27 +01:00
geotilegrid-aggregation.asciidoc Documentation for geohex_grid over geo_shape (#92999) 2023-01-24 16:03:27 +01:00
global-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
histogram-aggregation.asciidoc Deprecate legacy params from range query (#113286) 2024-09-25 14:48:45 -04:00
ipprefix-aggregation.asciidoc Add an aggregator for IPv4 and IPv6 subnets (#82410) 2022-01-28 11:59:07 +01:00
iprange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
missing-aggregation.asciidoc Update JSON parser and snippets (#77983) 2021-09-20 11:08:26 +01:00
multi-terms-aggregation.asciidoc [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
nested-aggregation.asciidoc [DOCS] Add filter example to nested agg docs (#76118) 2021-08-05 09:48:28 -04:00
parent-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
random-sampler-aggregation.asciidoc Add note about random sampler consistency (#107479) 2024-04-16 08:28:24 -04:00
range-aggregation.asciidoc [DOCS] Update ramge aggregation example (#98059) 2023-08-01 09:35:07 +02:00
range-field-note.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
rare-terms-aggregation.asciidoc Correct rare-terms default precision in docs (#96887) 2023-06-18 21:51:31 +02:00
reverse-nested-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
sampler-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
significantterms-aggregation.asciidoc [ML] add new normalize_above parameter to p_value significant terms heuristic (#78833) 2021-10-12 10:38:09 -04:00
significanttext-aggregation.asciidoc fix: use the correct field name when reading data from multi fields (#84752) 2022-03-11 17:11:26 +01:00
terms-aggregation.asciidoc [DOCS] Remove redirect pages (#88738) 2023-05-24 12:32:46 +01:00
time-series-aggregation.asciidoc (Doc+) Clarify dimension field requirements for time_series aggregation (#119442) 2025-01-29 13:03:11 +01:00
variablewidthhistogram-aggregation.asciidoc Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00