Skip to content

Commit a7818e0

Browse files
authored
[DOCS] Add collapsible section to TSDB mapping parameters + index setting (#80230) (#80278) (#80279)
1 parent 3dd18f9 commit a7818e0

File tree

6 files changed

+86
-19
lines changed

6 files changed

+86
-19
lines changed

docs/reference/index-modules.asciidoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,12 +331,19 @@ pipeline attempts to change the `_index` field, the indexing request will fail.
331331

332332
[[index-mapping-dimension-fields-limit]]
333333
`index.mapping.dimension_fields.limit`::
334-
experimental:[]
335-
For internal use by Elastic only. Maximum number of time series dimensions for
336-
the index. Defaults to `16`.
337334
+
335+
--
336+
experimental:[]
337+
338+
.For internal use by Elastic only.
339+
[%collapsible]
340+
====
341+
Maximum number of time series dimensions for the index. Defaults to `16`.
342+
338343
You can mark a field as a dimension using the `time_series_dimension` mapping
339344
parameter.
345+
====
346+
--
340347

341348
[[index-hidden]] `index.hidden`::
342349

docs/reference/mapping/types/aggregate-metric-double.asciidoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,21 @@ specify at least one value.
5757
Default metric sub-field to use for queries, scripts, and aggregations that
5858
don't use a sub-field. Must be a value from the `metrics` array.
5959

60-
include::numeric.asciidoc[tag=time_series_metric]
60+
`time_series_metric`::
6161
+
62+
--
63+
experimental:[]
64+
(Optional, string)
65+
66+
.For internal use by Elastic only.
67+
[%collapsible]
68+
====
69+
include::numeric.asciidoc[tag=time_series_metric]
70+
6271
For `aggregate_metric_double` fields, this parameter accepts `counter`, `gauge`,
6372
and `summary`. You can't update this parameter for existing fields.
73+
====
74+
--
6475

6576
[[aggregate-metric-double-uses]]
6677
==== Uses

docs/reference/mapping/types/histogram.asciidoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,21 @@ per document. Nested arrays are not supported.
2727
[[histogram-params]]
2828
==== Parameters
2929

30-
include::numeric.asciidoc[tag=time_series_metric]
30+
`time_series_metric`::
3131
+
32+
--
33+
experimental:[]
34+
(Optional, string)
35+
36+
.For internal use by Elastic only.
37+
[%collapsible]
38+
====
39+
include::numeric.asciidoc[tag=time_series_metric]
40+
3241
For `histogram` fields, this parameter accepts `histogram`. You can't update
3342
this parameter for existing fields.
43+
====
44+
--
3445

3546
[[histogram-uses]]
3647
==== Uses

docs/reference/mapping/types/ip.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,18 @@ The following parameters are accepted by `ip` fields:
9191
the <<mapping-source-field,`_source`>> field. Accepts `true` or `false`
9292
(default).
9393

94+
`time_series_dimension`::
95+
+
96+
--
97+
experimental:[]
98+
(Optional, Boolean)
99+
100+
.For internal use by Elastic only.
101+
[%collapsible]
102+
====
94103
include::keyword.asciidoc[tag=dimension]
104+
====
105+
--
95106

96107
[[query-ip-fields]]
97108
==== Querying `ip` fields

docs/reference/mapping/types/keyword.asciidoc

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,22 +147,30 @@ The following parameters are accepted by `keyword` fields:
147147
when building a query for this field.
148148
Accepts `true` or `false` (default).
149149

150-
// tag::dimension[]
151150
`time_series_dimension`::
152-
experimental:[]
153-
(Optional, Boolean) For internal use by Elastic only. Marks the field as a time
154-
series dimension. Defaults to `false`.
155151
+
152+
--
153+
experimental:[]
154+
(Optional, Boolean)
155+
156+
.For internal use by Elastic only.
157+
[%collapsible]
158+
====
159+
// tag::dimension[]
160+
Marks the field as a time series dimension. Defaults to `false`.
161+
156162
The <<index-mapping-dimension-fields-limit,`index.mapping.dimension_fields.limit`>>
157163
index setting limits the number of dimensions in an index.
158-
+
164+
159165
Dimension fields have the following constraints:
160-
+
166+
161167
* The `doc_values` and `index` mapping parameters must be `true`.
162168
* Field values cannot be an <<array,array or multi-value>>.
163169
// end::dimension[]
164170
* Field values cannot be larger than 1024 bytes.
165171
* The field cannot use a <<normalizer,`normalizer`>>.
172+
====
173+
--
166174

167175
include::constant-keyword.asciidoc[]
168176

docs/reference/mapping/types/numeric.asciidoc

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -170,26 +170,45 @@ The following parameters are accepted by numeric types:
170170
the <<mapping-source-field,`_source`>> field. Accepts `true` or `false`
171171
(default).
172172

173-
include::keyword.asciidoc[tag=dimension]
173+
`time_series_dimension`::
174174
+
175+
--
176+
experimental:[]
177+
(Optional, Boolean)
178+
179+
.For internal use by Elastic only.
180+
[%collapsible]
181+
====
182+
include::keyword.asciidoc[tag=dimension]
183+
175184
Of the numeric field types, only `byte`, `short`, `integer`, `long`, and
176185
`unsigned_long` fields support this parameter.
177-
+
186+
178187
A numeric field can't be both a time series dimension and a time series metric.
188+
====
189+
--
179190

180-
// tag::time_series_metric[]
181191
`time_series_metric`::
192+
+
193+
--
182194
experimental:[]
183-
(Optional, string) For internal use by Elastic only. Marks the field as a time
184-
series metric. The value is the metric type. Defaults to `null` (Not a time
185-
series metric).
195+
(Optional, string)
196+
197+
.For internal use by Elastic only.
198+
[%collapsible]
199+
====
200+
// tag::time_series_metric[]
201+
Marks the field as a time series metric. The value is the metric type. Defaults
202+
to `null` (Not a time series metric).
186203
// end::time_series_metric[]
187-
+
204+
188205
For numeric fields, this parameter accepts `gauge` and `counter`. You can't
189206
update this parameter for existing fields.
190-
+
207+
191208
For a numeric time series metric, the `doc_values` parameter must be `true`. A
192209
numeric field can't be both a time series dimension and a time series metric.
210+
====
211+
--
193212

194213
[[scaled-float-params]]
195214
==== Parameters for `scaled_float`

0 commit comments

Comments
 (0)