github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 17:34:17 -04:00
Code Issues Projects Releases Packages Wiki Activity
elasticsearch/docs/reference
History
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
..
aggregations (Doc+) Clarify dimension field requirements for time_series aggregation (#119442) 2025-01-29 13:03:11 +01:00
analysis [DOCS] Add full-text search overview (#119462) 2025-01-06 17:56:35 +00:00
autoscaling [DOCS] Link to new API site (#119038) 2024-12-30 16:52:16 +00:00
behavioral-analytics/apis [DOCS] Link to new API site (#119038) 2024-12-30 16:52:16 +00:00
cat Metrics for indexing failures due to version conflicts (#119067) 2025-01-08 12:34:37 +00:00
ccr [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
cluster Add ESQL telemetry collection (#119474) 2025-01-02 14:05:21 -07:00
commands [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
connector Clarify need to submit for authorization (#119460) 2025-01-28 11:09:15 +01:00
data-management [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
data-streams [DOCS] Update documentation for index sorting and routing for logsdb (#120721) 2025-01-27 16:21:28 +02:00
docs [DOCS] Upsert documentation clarification (#120684) 2025-01-29 09:46:01 +01:00
eql EQL: set allow_partial_search_results=true by default (#120267) 2025-01-27 10:23:34 +00:00
esql ESQL - Allow full text functions disjunctions for non-full text functions (#120291) 2025-01-28 14:08:13 +01:00
features/apis [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
fleet [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
graph [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
health [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
high-availability [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
how-to (Doc+) Flush out Slow Logs (#118518) 2024-12-27 10:12:00 -07:00
ilm Add a replicate_for option to the ILM searchable_snapshot action (#119003) 2025-01-27 14:32:46 -05:00
images [DOCS] RAG overview (#119590) 2025-01-07 15:18:39 +01:00
index-modules [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
indices Document that disabling stack templates is not recommended (#120963) 2025-01-27 15:17:48 -07:00
inference [DOCS] Fixes max_chunk_size parameter name. (#121052) 2025-01-28 17:10:08 +01:00
ingest [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
licensing [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
mapping Fix typo in synthetic source docs (#120685) 2025-01-23 07:51:58 -08:00
migration Add docs for reindex data stream REST endpoints (#120653) 2025-01-28 19:44:56 -06:00
ml [DOCS] Move ML function reference out of appendix (#121111) 2025-01-28 23:56:24 +01:00
modules Document that disabling stack templates is not recommended (#120963) 2025-01-27 15:17:48 -07:00
monitoring [AutoOps] Reference AutoOps solution on troubleshooting pages (#119630) 2025-01-09 16:24:20 +01:00
query-dsl [DOCS] Documents that deployment_id can be used as inference_id in certain cases. (#121055) 2025-01-28 17:01:18 +01:00
query-rules/apis [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
quickstart Fix typo in tutorial (#120928) 2025-01-28 10:54:20 +01:00
release-notes Bump 8.x to 8.18.0 2024-11-21 14:37:05 -05:00
repositories-metering-api [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
reranking [DOCS] Add Elastic Rerank usage docs (#117625) 2024-11-28 08:23:28 +01:00
rest-api Adding linear retriever to support weighted sums of sub-retrievers (#120222) 2025-01-28 19:33:12 +02:00
rollup Emit deprecation warning when executing one of the rollup APIs (#113131) 2025-01-29 08:48:53 +01:00
scripting [DOCS] Improve/fix documentation on stored scripts (#119921) 2025-01-10 16:13:09 +00:00
search [DOCS] Added additional context to page (#120569) 2025-01-29 09:48:25 +01:00
search-application/apis [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
searchable-snapshots [DOCS] More links to new API site (#119380) 2024-12-31 12:02:59 -08:00
security Deprecating data_frame_transforms roles (#117519) 2025-01-06 11:00:16 -05:00
settings [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
setup Minor fix in documentation (#119385) 2025-01-28 10:56:33 +01:00
shutdown/apis [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
slm/apis [DOCS] More links to new API site (#119380) 2024-12-31 12:02:59 -08:00
snapshot-restore [DOCS] Fix link in repository-s3.asciidoc (#119719) 2025-01-08 12:02:36 -08:00
sql Remove unfreeze REST endpoint (#119227) 2025-01-14 10:34:46 +00:00
synonyms/apis [DOCS] More links to new API site (#119380) 2024-12-31 12:02:59 -08:00
tab-widgets Changes elser service to elasticsearch service in the Semantic search with the inference API page (#118536) 2024-12-12 12:15:17 +01:00
text-structure/apis [DOCS] More links to new API site (#119380) 2024-12-31 12:02:59 -08:00
transform [DOCS] Improve/fix documentation on stored scripts (#119921) 2025-01-10 16:13:09 +00:00
troubleshooting Added additional entries for troubleshooting unhealthy cluster (#119914) (#120233) 2025-01-16 07:25:57 +11:00
upgrade [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
vectors Correct bit * byte and bit * float script comparisons (#117404) 2024-11-26 03:38:06 +11:00
watcher Update email.asciidoc (#117867) 2024-12-03 09:10:02 -05:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc Adjusted alias doc for clarity (#120437) (#121064) 2025-01-29 03:52:52 +11:00
analysis.asciidoc [DOCS] Add full-text search overview (#119462) 2025-01-06 17:56:35 +00:00
api-conventions.asciidoc (Doc+) System Index definition (#120327) 2025-01-29 11:14:36 +01:00
cat.asciidoc [DOCS] Link to new API site (#119038) 2024-12-30 16:52:16 +00:00
cluster.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
data-management.asciidoc Fix line spacing on ILM docs (#119807) 2025-01-09 08:52:54 -08:00
data-rollup-transform.asciidoc [DOCS] Deprecate rollups (#101265) 2023-10-25 16:52:25 -04:00
data-store-architecture.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
datatiers.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
dependencies-versions.asciidoc [DOCS] Replace dependencies list with a link. Closes #84863 (#90694) 2022-11-09 14:37:55 -08:00
docs.asciidoc [DOCS] Concept cleanup (extracting conceptual docs from reference content pt I of ?) (#119016) 2025-01-02 15:05:08 +00:00
geospatial-analysis.asciidoc Make spatial search functions not preview (#117489) 2024-11-25 17:04:48 +01:00
gs-index.asciidoc
high-availability.asciidoc [DOCS] Concept cleanup (extracting conceptual docs from reference content pt I of ?) (#119016) 2025-01-02 15:05:08 +00:00
how-to.asciidoc [DOCS] Rename how-to subsection, move recipes to search relevance (#117044) 2024-11-19 18:27:05 +01:00
index-modules.asciidoc Fix invalid index mode (#118579) 2024-12-12 10:59:47 -05:00
index.asciidoc [DOCS] Concept cleanup (extracting conceptual docs from reference content pt I of ?) (#119016) 2025-01-02 15:05:08 +00:00
index.x.asciidoc
indices.asciidoc Remove unfreeze REST endpoint (#119227) 2025-01-14 10:34:46 +00:00
ingest.asciidoc [DOCS] Port connector docs from Enterprise Search guide (#112953) 2024-09-30 10:22:37 +02:00
intro.asciidoc [DOCS] Add full-text search overview (#119462) 2025-01-06 17:56:35 +00:00
landing-page.asciidoc Adds hands-on learning for Search link to the landing page (#116007) 2024-10-31 14:49:11 +01:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc [DOCS][101] Update first quick start with mappings examples (#113558) 2024-10-02 20:00:09 +02:00
node-roles.asciidoc Fix broken anchors (#119802) 2025-01-09 09:15:00 -05:00
nodes-shards.asciidoc [DOCS] Concept cleanup (extracting conceptual docs from reference content pt I of ?) (#119016) 2025-01-02 15:05:08 +00:00
path-settings-overview.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
query-dsl.asciidoc Group vector queries into new section (#110722) 2024-07-11 14:45:35 +02:00
redirects.asciidoc Update redirects.asciidoc (#120249) 2025-01-15 21:58:01 -05:00
release-notes.asciidoc Prep docs for v9 (#115375) 2024-10-31 09:46:19 -05:00
run-elasticsearch-locally.asciidoc Update quickstart overview, add local install instructions (#115746) 2024-10-28 14:13:14 +01:00
scripting.asciidoc [DOCS] Add documentation for Painless field API (#83388) 2022-02-03 15:15:38 -05:00
search.asciidoc [DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
setup.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
shard-request-cache.asciidoc [DOCS] Concept cleanup 2 - ES settings (#119373) 2025-01-06 12:07:15 -05:00
troubleshooting.asciidoc [AutoOps] Reference AutoOps solution on troubleshooting pages (#119630) 2025-01-09 16:24:20 +01:00
upgrade.asciidoc [DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413) 2024-04-17 14:37:07 +02:00