Skip to content

Commit 9ecd7a9

Browse files
authored
Update keyword documentation for logsdb (elastic#126652) (elastic#126662)
This commit adds a note that ignore_above has a different limit for logsdb indices to the documentation. Also specifies that ignore_above applies to all types of the keyword family. Relates elastic/sdh-elasticsearch#8892
1 parent 55fce5d commit 9ecd7a9

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

docs/reference/data-streams/logs.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,9 @@ can be indexed without causing ingestion failures.
170170
==== `ignore_above`
171171

172172
In `logsdb` index mode, the `index.mapping.ignore_above` setting is applied by default at the index level to ensure
173-
efficient storage and indexing of large keyword fields.The index-level default for `ignore_above` is 8191
174-
_characters._ Using UTF-8 encoding, this results in a limit of 32764 bytes, depending on character encoding.
173+
efficient storage and indexing of large keyword fields. This applies to all members of the keyword type family (keyword,
174+
constant_keyword, and wildcard). The index-level default for `ignore_above` is 8191 _characters._ Using UTF-8 encoding,
175+
this results in a limit of 32764 bytes, depending on character encoding.
175176

176177
The mapping-level `ignore_above` setting takes precedence. If a specific field has an `ignore_above` value
177178
defined in its mapping, that value overrides the index-level `index.mapping.ignore_above` value. This default

docs/reference/mapping/types/keyword.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,10 @@ The following parameters are accepted by `keyword` fields:
7474
<<ignore-above,`ignore_above`>>::
7575

7676
Do not index any string longer than this value. Defaults to `2147483647`
77-
so that all values would be accepted. Please however note that default
78-
dynamic mapping rules create a sub `keyword` field that overrides this
79-
default by setting `ignore_above: 256`.
77+
in standard indices so that all values would be accepted, and `8191` in logsdb
78+
indices to protect against Lucene's term byte-length limit of `32766`. Please
79+
however note that default dynamic mapping rules create a sub `keyword` field
80+
that overrides this default by setting `ignore_above: 256`.
8081

8182
<<mapping-index,`index`>>::
8283

docs/reference/mapping/types/wildcard.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ The following parameters are accepted by `wildcard` fields:
123123
<<ignore-above,`ignore_above`>>::
124124

125125
Do not index any string longer than this value. Defaults to `2147483647`
126-
so that all values would be accepted.
126+
in standard indices so that all values would be accepted, and `8191` in
127+
logsdb indices to protect against Lucene's term byte-length limit of `32766`.
127128

128129
[discrete]
129130
==== Limitations

0 commit comments

Comments
 (0)