mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 09:28:55 -04:00
1f40ced134
Update definition of metric type counter to include it resets to zero. Just like is defined on the tsdb page: https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html#time-series-metric
52 lines
1.7 KiB
Text
52 lines
1.7 KiB
Text
[[mapping-field-meta]]
|
|
=== `meta`
|
|
|
|
Metadata attached to the field. This metadata is opaque to Elasticsearch, it is
|
|
only useful for multiple applications that work on the same indices to share
|
|
meta information about fields such as units
|
|
|
|
[source,console]
|
|
------------
|
|
PUT my-index-000001
|
|
{
|
|
"mappings": {
|
|
"properties": {
|
|
"latency": {
|
|
"type": "long",
|
|
"meta": {
|
|
"unit": "ms"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
------------
|
|
// TEST
|
|
|
|
NOTE: Field metadata enforces at most 5 entries, that keys have a length that
|
|
is less than or equal to 20, and that values are strings whose length is less
|
|
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.
|
|
|
|
NOTE: Field metadata is not supported on object or nested fields.
|
|
|
|
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
|
|
<<time-units,time unit>>. 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, or resets to 0 (zero).
|
|
By default, no metric type is associated with a field. Only valid for numeric fields.
|