Skip to content

Commit 1f47669

Browse files
Add applies_to label to logsdb message default sort setting (#137767)
This PR updates the docs for index.logsdb.default_sort_on_message_template to indicate that it is a preview feature in stack release 9.3.
1 parent 967c0cb commit 1f47669

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/reference/elasticsearch/mapping-reference/pattern-text.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,18 @@ In both cases, all queries return a constant score of 1.0.
4646

4747
## Index sorting for improved compression
4848
The compression provided by `pattern_text` can be significantly improved if the index is sorted by the `template_id` field.
49-
This sorting is not applied by default, but can be enabled for the `message` field of LogsDB indices (assuming it is of type `pattern_text`) by setting the index setting `index.logsdb.default_sort_on_message_template` to `true`.
49+
50+
51+
### Default sorting for LogsDB
52+
```{applies_to}
53+
serverless: preview
54+
stack: preview 9.3
55+
```
56+
This index sorting is not applied by default, but can be enabled for the `message` field of LogsDB indices (assuming it is of type `pattern_text`) by setting the index setting `index.logsdb.default_sort_on_message_template` to `true`.
5057
This will cause the index to be sorted by `host.name` (if present), then `message.template_id`, and finally by `@timestamp`.
58+
59+
60+
### Custom sorting
5161
If the index is not LogsDB or the `pattern_text` field is named something other than `message`, index sorting can still be manually applied as shown in the following example.
5262

5363
```console
@@ -73,6 +83,7 @@ PUT logs
7383
```
7484

7585

86+
7687
## Parameters for pattern text fields [pattern-text-params]
7788

7889
The following mapping parameters are accepted:

0 commit comments

Comments
 (0)