Skip to content

Commit ae9bb90

Browse files
marciwleemthomposhainaraskaslkts
authored
Update and edit logsdb docs for logsdb / synthetic source GA (#118303)
* Update licensing; fix screenshots; edit generally * Small edit for clarity and style * Update docs/reference/index-modules.asciidoc Co-authored-by: Liam Thompson <[email protected]> * Apply changes from review Co-authored-by: Liam Thompson <[email protected]> * Address review comments * Match similar change from review * More changes from review * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Update docs/reference/data-streams/logs.asciidoc Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review Co-authored-by: shainaraskas <[email protected]> * Apply suggestions from review * Change to general subscription note * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review Co-authored-by: Oleksandr Kolomiiets <[email protected]> * Apply suggestions from review; additional edits * Apply suggestions from review; clarity tweaks * Restore previous paragraph structure and context --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Oleksandr Kolomiiets <[email protected]>
1 parent a8a4a7b commit ae9bb90

File tree

9 files changed

+112
-111
lines changed

9 files changed

+112
-111
lines changed

docs/reference/data-streams/logs.asciidoc

Lines changed: 103 additions & 94 deletions
Large diffs are not rendered by default.

docs/reference/data-streams/tsds.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ metrics data. Only use a TSDS if you typically add metrics data to {es} in near
1717
real-time and `@timestamp` order.
1818

1919
A TSDS is only intended for metrics data. For other timestamped data, such as
20-
logs or traces, use a regular data stream.
20+
logs or traces, use a <<logs-data-stream,logs data stream>> or regular data stream.
2121

2222
[discrete]
2323
[[differences-from-regular-data-stream]]
246 KB
Loading
-734 KB
Binary file not shown.
71.2 KB
Loading

docs/reference/index-modules.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,9 @@ Index mode supports the following values:
113113

114114
`standard`::: Standard indexing with default settings.
115115

116-
`time_series`::: Index mode optimized for storage of metrics documented in <<tsds-index-settings,TSDS Settings>>.
116+
`tsds`::: _(data streams only)_ Index mode optimized for storage of metrics. For more information, see <<tsds-index-settings>>.
117117

118-
`logsdb`::: Index mode optimized for storage of logs. It applies default sort settings on the `hostname` and `timestamp` fields and uses <<synthetic-source,synthetic `_source`>>. <<index-modules-index-sorting,Index sorting>> on different fields is still allowed.
119-
preview:[]
118+
`logsdb`::: _(data streams only)_ Index mode optimized for <<logs-data-stream,logs>>.
120119

121120
[[routing-partition-size]] `index.routing_partition_size`::
122121

docs/reference/indices/index-mgmt.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This value is the time period for which your data is guaranteed to be stored. Da
6767
Elasticsearch at a later time.
6868

6969
[role="screenshot"]
70-
image::images/index-mgmt/management-data-stream.png[Data stream details]
70+
image::images/index-mgmt/management-data-stream-fields.png[Data stream details]
7171

7272
* To view more information about a data stream, such as its generation or its
7373
current index lifecycle policy, click the stream's name. From this view, you can navigate to *Discover* to

docs/reference/indices/put-index-template.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ See <<create-index-template,create an index template>>.
115115
116116
`index_mode`::
117117
(Optional, string) Type of data stream to create. Valid values are `null`
118-
(regular data stream) and `time_series` (<<tsds,time series data stream>>).
118+
(standard data stream), `time_series` (<<tsds,time series data stream>>) and `logsdb`
119+
(<<logs-data-stream,logs data stream>>).
119120
+
120-
If `time_series`, each backing index has an `index.mode` index setting of
121-
`time_series`.
121+
The template's `index_mode` sets the `index.mode` of the backing index.
122122
=====
123123

124124
`index_patterns`::

docs/reference/mapping/fields/synthetic-source.asciidoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
[[synthetic-source]]
22
==== Synthetic `_source`
33

4-
IMPORTANT: Synthetic `_source` is Generally Available only for TSDB indices
5-
(indices that have `index.mode` set to `time_series`). For other indices,
6-
synthetic `_source` is in technical preview. Features in technical preview may
7-
be changed or removed in a future release. Elastic will work to fix
8-
any issues, but features in technical preview are not subject to the support SLA
9-
of official GA features.
10-
114
Though very handy to have around, the source field takes up a significant amount
125
of space on disk. Instead of storing source documents on disk exactly as you
136
send them, Elasticsearch can reconstruct source content on the fly upon retrieval.
14-
Enable this by using the value `synthetic` for the index setting `index.mapping.source.mode`:
7+
To enable this https://www.elastic.co/subscriptions[subscription] feature, use the value `synthetic` for the index setting `index.mapping.source.mode`:
158

169
[source,console,id=enable-synthetic-source-example]
1710
----
@@ -30,7 +23,7 @@ PUT idx
3023
----
3124
// TESTSETUP
3225

33-
While this on the fly reconstruction is *generally* slower than saving the source
26+
While this on-the-fly reconstruction is _generally_ slower than saving the source
3427
documents verbatim and loading them at query time, it saves a lot of storage
3528
space. Additional latency can be avoided by not loading `_source` field in queries when it is not needed.
3629

0 commit comments

Comments
 (0)