github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Adds rollover information to 6.6 Docs (#33662)

Browse source 
* [DOCS] Adds rollover information to 6.6 Docs

* [DOCS] Adds section title for lifecycle phases
This commit is contained in:
gchaps 2019-03-21 10:08:30 -07:00 • committed by GitHub
parent 90923831fb
commit e0d4d817a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/management/index-lifecycle-policies/create-policy.asciidoc
View file

@ -21,18 +21,19 @@ disable *Index Management*, then *Index Lifecycle Policies* is also disabled.
[role="screenshot"]
image::images/index-lifecycle-policies-create.png[][UI for creating an index lifecycle policy]
==== Defining the phases of the index lifecycle
You can define up to four phases in the index lifecycle. For each phase, you
can enable actions to optimize performance for that phase. Transitioning
between phases is based on the age of the index.
can enable actions to optimize performance for that phase.
The four phases of an index lifecycle policy are:
* *Hot.* The index is actively being queried and written to. You can optionally
roll over to a new index when the
original index reaches a specified size or age. When a rollover occurs, a new
* *Hot.* The index is actively being queried and written to. You can
roll over to a new index when the original index reaches a specified size,
document count, or age. When a rollover occurs, a new
index is created, added to the index alias, and designated as the new “hot”
index. You can still query the previous indices, but you only ever write to
the “hot” index. See {ref}/indices-rollover-index.html[Rollover index] for more information.
the “hot” index. See <<setting-a-rollover-action>> for more information.
* *Warm.* The index is typically searched at a lower rate than when the data is
hot. The index is not used for storing for new data, but might occasionally add
@ -55,3 +56,26 @@ delete phases are optional. For example, you might define all four phases for
one policy and only a hot and delete phase for another. See {ref}/_actions.html[Actions]
for more information on the actions available in each phase.
[[setting-a-rollover-action]]
==== Setting a rollover action
The {ref}/indices-rollover-index.html[rollover] action enables you to automatically
roll over to a new index based on the index size, document count, or age. Rolling
over to a new index based on these criteria is preferable to time-based rollovers.
Rolling over at an arbitrary time often results in many small indices, which can
have a negative impact on performance and resource usage.
When you create an index lifecycle policy, the rollover action is enabled
by default. The default size for triggering the rollover is 50 gigabytes, and
the default age is 30 days. The rollover occurs when any of the criteria are met.
With the rollover action enabled, you can move to the warm phase on rollover or you can
time the move for a specified number of hours or days after the rollover. The
move to the cold and delete phases is based on the time from the rollover.
If you are using daily indices (created by Logstash or another client) and you
want to use the index lifecycle policy to manage aging data, you can
disable the rollover action in the hot phase. You can then
transition to the warm, cold, and delete phases based on the time of index creation.