Skip to content

Conversation

@romseygeek
Copy link
Contributor

Summary

Update TSDS docs to mention the use of doc values skippers, and cross-link to the internal ES docs.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

@romseygeek romseygeek requested review from a team as code owners December 18, 2025 12:24
@romseygeek romseygeek self-assigned this Dec 18, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 18, 2025

✅ Vale Linting Results

No issues found on modified lines!

…ds.md

Co-authored-by: Liam Thompson <leemthompo@gmail.com>
@github-actions
Copy link
Contributor

github-actions bot commented Dec 18, 2025

🔍 Preview links for changed docs

* **Dimension-based routing:** The routing logic uses dimension fields to map all data points of a time series to the same shard, improving storage efficiency and query performance. Duplicate data points are rejected.
* **Sorting:** A TSDS uses internal [index sorting](elasticsearch://reference/elasticsearch/index-settings/sorting.md) to order shard segments by `_tsid` and `@timestamp`, for better compression. Time series data streams do not use `index.sort.*` settings.
* **Source field:** A TSDS uses [synthetic `_source`](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source), and as a result is subject to some [restrictions](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source-restrictions) and [modifications](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md#synthetic-source-modifications) applied to the `_source` field.
* {applies_to}`stack: ga 9.3` **Docvalue Skippers:** A TSDS enables [docvalue skippers](elasticsearch://reference/elasticsearch/mapping-reference/doc-values.md#doc-values-skippers) on its `_tsid`, `@timestamp`, [dimension](#time-series-dimension) and [metric](#time-series-metric) fields. Because `tsid` and `@timestamp` are part of the index sort, this allows {{es}} to avoid building backing indexes for these fields, meaning lower disk usage and faster ingest speed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* {applies_to}`stack: ga 9.3` **Docvalue Skippers:** A TSDS enables [docvalue skippers](elasticsearch://reference/elasticsearch/mapping-reference/doc-values.md#doc-values-skippers) on its `_tsid`, `@timestamp`, [dimension](#time-series-dimension) and [metric](#time-series-metric) fields. Because `tsid` and `@timestamp` are part of the index sort, this allows {{es}} to avoid building backing indexes for these fields, meaning lower disk usage and faster ingest speed.
* {applies_to}`stack: ga 9.3` **Doc values skippers:** A TSDS enables [docvalue skippers](elasticsearch://reference/elasticsearch/mapping-reference/doc-values.md#doc-values-skippers) on its `_tsid`, `@timestamp`, [dimension](#time-series-dimension) and [metric](#time-series-metric) fields. Because `tsid` and `@timestamp` are part of the index sort, this allows {{es}} to avoid building backing indexes for these fields, meaning lower disk usage and faster ingest speed.

Updating to sentence case capitalization + they're called "doc values skippers" in the page you are linking to

Copy link
Contributor

@wajihaparvez wajihaparvez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @romseygeek! Just two minor suggestions

@romseygeek romseygeek enabled auto-merge (squash) December 19, 2025 17:14
@romseygeek romseygeek merged commit c0ccae9 into main Dec 19, 2025
7 of 8 checks passed
@romseygeek romseygeek deleted the tsds/skippers branch December 19, 2025 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants