Skip to content

Commit 65fc86e

Browse files
committed
Clarify routing strategies for TSDS backing indices in documentation
1 parent 86e5bd3 commit 65fc86e

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

manage-data/data-store/data-streams/time-series-data-stream-tsds.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -200,17 +200,16 @@ You can use the [get data stream API](https://www.elastic.co/docs/api/doc/elasti
200200

201201
Within each TSDS backing index, {{es}} uses one of the following strategies to route documents with the same dimensions to the same shards.
202202

203-
1. Based on the internally managed `index.dimensions` index setting (available as of stack version 9.2)
204-
2. Based on the [`index.routing_path`](elasticsearch://reference/elasticsearch/index-settings/time-series.md#index-routing-path) index setting
203+
1. Based on the internally managed `index.dimensions` index setting (preferred). Available as of stack version 9.2.
204+
2. Based on the [`index.routing_path`](elasticsearch://reference/elasticsearch/index-settings/time-series.md#index-routing-path) index setting (as a fallback).
205205

206206
The `index.dimensions`-based strategy uses a list of dimension paths that's automatically kept up-to-date and is not user-configurable.
207-
When active, the routing decision will be made based on all dimension fields, instead of only those defined statically via the `index.routing_path` setting,
208-
which can help to prevent shard hot-spotting issues.
207+
When active, the routing decision will be made based on all dimension fields, instead of only those defined statically via the `index.routing_path` setting.
209208
This strategy is only available on data streams with no dynamic templates setting `time_series_dimension: true`.
210209
It is used by default if applicable and improves the ingest performance as dimensions only need to be processed once for the purposes of routing and creating the `_tsid` field.
211210

212-
For more details including how to disable this strategy,
213-
see [`index.index_dimensions_tsid_strategy_enabled`](elasticsearch://reference/elasticsearch/index-settings/time-series.md#index-dimensions-tsid-strategy-enabled)
211+
This strategy can be disabled by setting [`index.index_dimensions_tsid_strategy_enabled`](elasticsearch://reference/elasticsearch/index-settings/time-series.md#index-dimensions-tsid-strategy-enabled) to `false`,
212+
or by manually setting `index.routing_path`.
214213

215214
To use the `index.routing_path`-based strategy,
216215
you must specify one or more dimensions in the `index.routing_path` setting. Each document in a TSDS must contain one or more dimensions that match the `index.routing_path` setting.

0 commit comments

Comments
 (0)