Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document standard metadata entries. #63538

Merged
merged 1 commit into from
Oct 13, 2020
Merged

Document standard metadata entries. #63538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/reference/mapping/params/meta.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<<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. By default,
no metric type is associated with a field. Only valid for numeric fields.