[DOCS] Updates field formatters (#82667)

* [DOCS] Updates field formatters

* Update docs/management/managing-fields.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Minor edits

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
This commit is contained in:
gchaps 2020-11-05 12:37:58 -08:00 committed by GitHub
parent ca04175ae9
commit 2287376aeb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 59 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

View file

@ -1,71 +1,30 @@
[[managing-fields]]
== Index patterns and fields
== Field management
The *Index patterns* UI helps you create and manage
the index patterns that retrieve your data from {es}.
Whenever possible,
{kib} uses the same field type for display as {es}. However, a few field types
{es} supports are not available in {kib}. Use field formatters to customize how your
fields are displayed in Kibana, regardless of how they are stored in {es}.
[role="screenshot"]
image::images/management-index-patterns.png[]
[float]
=== Required permissions
The `Index Pattern Management` {kib} privilege is required to access the *Index patterns* UI.
To add the privilege, open the menu, then click *Stack Management > Roles*.
[float]
=== Create an index pattern
An index pattern is the glue that connects {kib} to your {es} data. Create an
index pattern whenever you load your own data into {kib}. To get started,
click *Create index pattern*, and then follow the guided steps. Refer to
<<index-patterns, Creating an index pattern>> for the types of index patterns
that you can create.
[float]
=== Manage your index pattern
To view the fields and associated data types in an index pattern, click its name in
the *Index patterns* overview.
[role="screenshot"]
image::management/index-patterns/images/new-index-pattern.png["Index files and data types"]
Use the icons to perform the following actions:
* [[set-default-pattern]]*Set the default index pattern.* {kib} uses a badge to make users
aware of which index pattern is the default. The first pattern
you create is automatically designated as the default pattern. The default
index pattern is loaded when you open *Discover*.
* *Refresh the index fields list.* You can refresh the index fields list to
pick up any newly-added fields. Doing so also resets the {kib} popularity counters
for the fields. The popularity counters are used in *Discover* to sort fields in lists.
* [[delete-pattern]]*Delete the index pattern.* This action removes the pattern from the list of
Saved Objects in {kib}. You will not be able to recover field formatters,
scripted fields, source filters, and field popularity data associated with the index pattern.
Deleting an index pattern does
not remove any indices or data documents from {es}.
+
WARNING: Deleting an index pattern breaks all visualizations, saved searches, and
other saved objects that reference the pattern.
[float]
=== Edit a field
To edit a field's properties, click the edit icon
image:management/index-patterns/images/edit_icon.png[] in the detail view.
You can set the field's format and popularity value.
Kibana has field formatters for the following field types:
Kibana provides these field formatters:
* <<field-formatters-string, Strings>>
* <<field-formatters-date, Dates>>
* <<field-formatters-geopoint, Geopoints>>
* <<field-formatters-numeric, Numbers>>
To format a field:
. Open the main menu, and click *Stack Management > Index Patterns*.
. Click the index pattern that contains the field you want to format.
. Find the field you want to format and click the edit icon (image:management/index-patterns/images/edit_icon.png[]).
. Select a format and fill in the details.
+
[role="screenshot"]
image:management/index-patterns/images/edit-field-format.png["Edit field format"]
[[field-formatters-string]]
=== String field formatters