Skip to content

[DOCS] Adds note that default formatters use the meta.unit field #176857

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

Merged
amyjtechwriter merged 2 commits into from
Feb 19, 2024
Merged

[DOCS] Adds note that default formatters use the meta.unit field #176857

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c30cc93
Adds note that numeric default formatters use the meta.unit field
amyjtechwriter Feb 13, 2024
5a2dc7b
Merge branch 'main' into meta.unit.field
amyjtechwriter Feb 19, 2024
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
4 changes: 3 additions & 1 deletion docs/management/manage-data-views.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,8 @@ To customize how {kib} displays data fields, use the formatting options.

. Select *Set format*, then enter the *Format* for the field.

NOTE: For numeric fields the default field formatters are based on the `meta.unit` field. The unit is associated with a {ref}/api-conventions.html#time-units[time unit], percent, or byte. The convention for percents is to use value 1 to mean 100%.

[float]
[[string-field-formatters]]
==== String field formatters
Expand Down Expand Up @@ -278,7 +280,7 @@ include::field-formatters/string-formatter.asciidoc[]
Numeric fields support *Bytes*, *Color*, *Duration*, *Histogram*, *Number*, *Percentage*, *String*, and *Url* formatters.

The *Bytes*, *Number*, and *Percentage* formatters enable you to choose the display formats of numbers in the field using
the <<numeral, Elastic numeral pattern>> syntax that {kib} maintains.
the <<numeral, Elastic numeral pattern>> syntax that {kib} maintains.

The *Histogram* formatter is used only for the {ref}/histogram.html[histogram field type]. When you use the *Histogram* formatter,
you can apply the *Bytes*, *Number*, or *Percentage* format to aggregated data.
Expand Down