-
Notifications
You must be signed in to change notification settings - Fork 190
Mention use of docvalue skippers in TSDS documentation #4412
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.
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
Conversation
✅ Vale Linting ResultsNo issues found on modified lines! |
manage-data/data-store/data-streams/time-series-data-stream-tsds.md
Outdated
Show resolved
Hide resolved
…ds.md Co-authored-by: Liam Thompson <[email protected]>
🔍 Preview links for changed docs |
manage-data/data-store/data-streams/time-series-data-stream-tsds.md
Outdated
Show resolved
Hide resolved
| * **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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * {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
wajihaparvez
left a comment
There was a problem hiding this 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
Summary
Update TSDS docs to mention the use of doc values skippers, and cross-link to the internal ES docs.
Generative AI disclosure