Skip to content

(Doc+) Clarify dimension field requirements for time_series aggregation #119442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 29, 2025
Merged

(Doc+) Clarify dimension field requirements for time_series aggregation #119442

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b20d99
(Doc+) Clarify dimension field requirements for time_series aggregation
jihyunjeongme Jan 2, 2025
bdee582
Apply suggestions from code review
leemthompo Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/reference/aggregations/bucket/time-series-aggregation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ preview::[]
The time series aggregation queries data created using a time series index. 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]
====
When you create a time series index, you must:

* Set `index.mode` to `"time_series"`.
* Specify at least one dimension field by adding `"time_series_dimension": true` in your mapping.
* Provide a `routing_path` array listing the dimension fields.

These fields ensure that documents sharing the same dimensions are routed to the same shard,
and they allow the `time_series` aggregation to produce meaningful bucket results.
====

//////////////////////////

Creating a time series mapping
Expand Down
Loading