elasticsearch/docs/reference
Luca Cavanna d45b19db18
Add support for dots in field names for metrics usecases (#86166)
This PR adds support for a new mapping parameter to the configuration of the object mapper (root as well as individual fields), that makes it possible to store metrics data where it's common to have fields with dots in their names in the following format:

```
{
  "metrics.time" : 10,
  "metrics.time.min" : 1,
  "metrics.time.max" : 500
}
```

Instead of expanding dotted paths the their corresponding object structure, objects can be configured to preserve dots in field names, in which case they can only hold leaf sub-fields and no further objects.

The mapping parameter is called subobjects and controls whether an object can hold other objects (defaults to true) or not. The following example shows how it can be configured in the mappings:

```
{
  "mappings" : {
    "properties" : {
      "metrics" : {
        "type" : "object", 
        "subobjects" : false
      }
    }
  }
}
```

Closes #63530
2022-05-17 16:34:39 +02:00
..
aggregations Clarify risks around ordering terms aggregation (#86528) 2022-05-16 11:05:22 -04:00
analysis Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00
autoscaling [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
cat correct way of getting node heap size (#85045) 2022-05-11 09:59:34 -04:00
ccr [DOCS] Clarify when changes are replicated in CCR (#83863) 2022-02-11 16:07:38 -05:00
cluster Add master_timeout support to voting config exclusions APIs (#86670) 2022-05-11 13:56:50 +01:00
commands Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00
data-management [DOC] auto migrate only for default template (#82043) 2022-05-10 11:35:19 -04:00
data-streams [DOCS] Fix ordered list formatting in data stream docs (#81667) 2021-12-13 12:53:48 -05:00
docs [Docs] Document apiKey usage in remote reindex (#85209) 2022-05-10 14:31:42 -04:00
eql [DOCS] Fix ignore_unavailable parameter definition (#84071) 2022-02-17 08:24:06 -05:00
features/apis Make feature reset API response more informative (#71240) 2021-04-27 13:47:10 -04:00
fleet Fix some typos in plugins & reference docs (#84667) 2022-03-07 12:29:58 -05:00
graph [DOCS] Fix typos (#83895) 2022-02-15 12:42:17 -05:00
health How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
high-availability [DOCS] Overhaul snapshot and restore docs (#79081) 2021-11-15 12:45:07 -05:00
how-to correct way of getting node heap size (#85045) 2022-05-11 09:59:34 -04:00
ilm [DOCS] Remove unnecessary link. (#86205) 2022-04-27 15:44:43 -07:00
images SQL: Update DbVisualizer connection steps (#85167) 2022-03-31 16:48:24 +02:00
index-modules Docs: Fixing formatting on slow log page (#84509) 2022-03-01 14:05:34 -05:00
indices Rectified the "Add lifecycle policy" hyperlink. (#86717) (#86735) 2022-05-12 10:22:40 -04:00
ingest [DOC] Air gapped environments and GEOIP (#85637) 2022-05-10 16:34:28 -04:00
licensing [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
mapping Add support for dots in field names for metrics usecases (#86166) 2022-05-17 16:34:39 +02:00
migration [Docs] Fix url for feature migration APIs (#86330) 2022-05-03 10:05:02 +10:00
ml [DOCS] Updates example output for start trained model deployment API (#86824) 2022-05-17 07:27:44 -07:00
modules Reduce resource needs of join validation (#85380) 2022-04-26 12:15:54 +01:00
monitoring Update setting deprecation messages to remove major release references (#83528) 2022-02-04 13:53:20 -05:00
query-dsl fixed typo (#84694) (#84726) 2022-03-07 14:30:51 -05:00
release-notes Update8.2.0 BC4 docs (#86084) (#86213) 2022-04-27 14:09:40 +02:00
repositories-metering-api [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
rest-api [Transform] Support range aggregation in transform (#86501) 2022-05-16 15:21:00 +02:00
rollup [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
scripting [DOCS] Add documentation for Painless field API (#83388) 2022-02-03 15:15:38 -05:00
search Support geo label position through REST vector tiles API (#86458) 2022-05-17 15:33:29 +02:00
searchable-snapshots Add note that searchable snapshots indices cannot be snapshotted into source-only repositories (#86208) 2022-05-06 11:33:50 +02:00
settings [DOCS] Document when security auto configuration is skipped (#86575) 2022-05-17 08:27:48 -04:00
setup [doc] update deprecation logging (#83723) 2022-05-17 16:17:54 +02:00
shutdown/apis [doc] Explicitly mention about node shutdown remove for cluster shrink (#86173) 2022-05-09 10:24:54 +02:00
slm/apis [DOCS] Remove soft limit for snapshot repositories (#80745) 2021-11-16 12:24:18 -05:00
snapshot-restore Small additions to the register-repo docs (#86122) 2022-05-09 07:37:20 +01:00
sql SQ: Allow partial results in SQL queries (#85897) 2022-04-21 18:12:50 +02:00
tab-widgets How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
text-structure/apis [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
transform [DOCS] Edits transform secondary auth header details (#86815) 2022-05-17 07:25:23 -07:00
troubleshooting/data How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
upgrade Permit removal of archived index settings (#86107) 2022-04-26 08:27:16 +01:00
vectors [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
aggregations.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
alias.asciidoc [DOCS] Fix default for is_write_index (#77006) (#77362) 2021-09-07 11:34:53 -04:00
analysis.asciidoc Update Lucene analysis base url (#84094) 2022-02-17 12:44:12 +01:00
api-conventions.asciidoc [DOCS] System indices no longer accessible 8.0 (#84377) (#84438) 2022-02-28 12:02:54 -05:00
cat.asciidoc [DOCS] Remove unneeded escapes 2021-04-26 12:14:45 -04:00
cluster.asciidoc How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
data-management.asciidoc reorder and merge data management and ILM doc pages (#84679) 2022-03-07 18:33:28 -05:00
data-rollup-transform.asciidoc [DOCS] Remove ifdefs for rollup refactor 2021-08-05 09:08:04 -04:00
datatiers.asciidoc [DOCS] Fix duplicate anchor (#85424) 2022-03-28 15:16:08 -07:00
dependencies-versions.asciidoc [DOCS] Added appendix to show dependencies (#67962) 2021-01-26 16:16:05 -08:00
docs.asciidoc [DOCS] Update single index APIs reference (#73103) 2021-05-14 11:53:34 -04:00
getting-started.asciidoc [DOCS] Update ES quick start for security ON by default (#80735) 2021-11-17 17:48:07 -05:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
high-availability.asciidoc [DOCS] Overhaul snapshot and restore docs (#79081) 2021-11-15 12:45:07 -05:00
how-to.asciidoc How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
index-extra-title-page.html [DOCS] Add index-extra-title-page.html for direct HTML migration (#50189) 2019-12-13 12:44:12 -05:00
index-modules.asciidoc shards allocation health indicator services (#83513) 2022-03-07 09:31:33 +01:00
index.asciidoc How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc Remove endpoint for freezing indices (#78918) 2021-10-26 06:37:56 -05:00
ingest.asciidoc [DOCS] Update screenshots for ingest pipeline docs (#83845) 2022-02-23 10:50:02 -05:00
intro.asciidoc [DOCS] Update ES intro for stretched clusters (#77651) 2021-09-13 16:50:08 -04:00
links.asciidoc [DOCS] Rename ES Reference to ES Guide (#71198) 2021-04-01 15:38:41 -04:00
mapping.asciidoc Minor revision missed in merge. (#67282) 2021-01-11 13:50:06 -05:00
query-dsl.asciidoc Allow doc-values only search on geo_point fields (#83395) 2022-02-02 11:56:19 +01:00
redirects.asciidoc [DOCS] Removes infer trained model deployment API (#86497) 2022-05-10 09:56:36 -07:00
release-notes.asciidoc [DOCS] Add docs for v8.2.0 release (#86007) 2022-04-21 10:49:38 +02:00
scripting.asciidoc [DOCS] Add documentation for Painless field API (#83388) 2022-02-03 15:15:38 -05:00
search.asciidoc [DOCS] Add high-level guide for kNN search (#80857) 2021-11-30 14:17:39 -05:00
setup.asciidoc [DOCS] Overhaul snapshot and restore docs (#79081) 2021-11-15 12:45:07 -05:00
troubleshooting.asciidoc How-to docs for increasing the total number of shards per node (#86214) 2022-05-10 09:13:27 +01:00
upgrade.asciidoc [DOCS] Fix upgrade docs for 8.x (#84076) 2022-02-23 10:53:18 -05:00