From db372c335a4521915915f48a108fd64ed7fb81ce Mon Sep 17 00:00:00 2001 From: Adrien Grand Date: Mon, 12 Oct 2020 09:49:39 +0200 Subject: [PATCH] Document standard metadata entries. (#61941) We standardize on some metadata entries that we plan to later leverage in Kibana in order to provide a better out-of-the-box experience, e.g. different visualizations make sense on gauges and counters. --- docs/reference/mapping/params/meta.asciidoc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/reference/mapping/params/meta.asciidoc b/docs/reference/mapping/params/meta.asciidoc index d97c9c1a21420..16f4394ba57fb 100644 --- a/docs/reference/mapping/params/meta.asciidoc +++ b/docs/reference/mapping/params/meta.asciidoc @@ -29,3 +29,22 @@ than or equal to 50. NOTE: Field metadata is updatable by submitting a mapping update. The metadata of the update will override the metadata of the existing field. + +Elastic products use the following standard metadata entries for fields. You +can follow these same metadata conventions to get a better out-of-the-box +experience with your data. + +unit:: + + The unit associated with a numeric field: `"percent"`, `"byte"` or a + <>. By default, a field does not have a unit. + Only valid for numeric fields. The convention for percents is to use + value `1` to mean `100%`. + +metric_type:: + + The metric type of a numeric field: `"gauge"` or `"counter"`. A gauge is a + single-value measurement that can go up or down over time, such as a + temperature. A counter is a single-value cumulative counter that only goes + up, such as the number of requests processed by a web server. By default, + no metric type is associated with a field. Only valid for numeric fields.