data-stream-lifecycle-settings.asciidoc 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. [role="xpack"]
  2. [[data-stream-lifecycle-settings]]
  3. === Data stream lifecycle settings in {es}
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>Data stream lifecycle settings</titleabbrev>
  7. ++++
  8. preview::[]
  9. These are the settings available for configuring <<data-stream-lifecycle, data stream lifecycle>>.
  10. ==== Cluster level settings
  11. [[data-streams-lifecycle-poll-interval]]
  12. `data_streams.lifecycle.poll_interval`::
  13. (<<dynamic-cluster-setting,Dynamic>>, <<time-units, time unit value>>)
  14. How often {es} checks what is the next action for all data streams with a built-in lifecycle. Defaults to `5m`.
  15. [[cluster-lifecycle-default-rollover]]
  16. `cluster.lifecycle.default.rollover`::
  17. (<<dynamic-cluster-setting,Dynamic>>, string)
  18. This property accepts a key value pair formatted string and configures the conditions that would trigger a data stream
  19. to <<index-rollover,rollover>> when it has `lifecycle` configured. This property is an implementation detail and subject to
  20. change. Currently, it defaults to `max_age=auto,max_primary_shard_size=50gb,min_docs=1,max_primary_shard_docs=200000000`,
  21. this means that your data stream will rollover if any of the following conditions are met:
  22. * Either any primary shard reaches the size of 50GB,
  23. * or any primary shard contains 200.000.000 documents
  24. * or the index reaches a certain age which depends on the retention time of your data stream,
  25. * **and** has at least one document.
  26. [[data-streams-lifecycle-target-merge-factor]]
  27. `data_streams.lifecycle.target.merge.policy.merge_factor`::
  28. (<<dynamic-cluster-setting,Dynamic>>, integer)
  29. Data stream lifecycle implements <<data-streams-lifecycle-how-it-works, tail merging>> by
  30. updating the lucene merge policy factor for the target backing index. The merge factor
  31. is both the number of segments that should be merged together, and the maximum number
  32. of segments that we expect to find on a given tier.
  33. This setting controls what value does <<data-stream-lifecycle, Data stream lifecycle>>
  34. configures on the target index. It defaults to `16`.
  35. The value will be visible under the `index.merge.policy.merge_factor` index setting
  36. on the target index.
  37. [[data-streams-lifecycle-target-floor-segment]]
  38. `data_streams.lifecycle.target.merge.policy.floor_segment`::
  39. (<<dynamic-cluster-setting,Dynamic>>)
  40. Data stream lifecycle implements <<data-streams-lifecycle-how-it-works, tail merging>> by
  41. updating the lucene merge policy floor segment for the target backing index. This floor
  42. segment size is a way to prevent indices from having a long tail of very small segments.
  43. This setting controls what value does <<data-stream-lifecycle, data stream lifecycle>>
  44. configures on the target index. It defaults to `100MB`.
  45. ==== Index level settings
  46. The following index-level settings are typically configured on the backing indices of a data stream.
  47. [[index-lifecycle-prefer-ilm]]
  48. `index.lifecycle.prefer_ilm`::
  49. (<<indices-update-settings,Dynamic>>, boolean)
  50. This setting determines which feature is managing the backing index of a data stream if, and only if, the backing index
  51. has an <<index-lifecycle-management,{ilm}>> ({ilm-init}) policy and the data stream has also a built-in lifecycle. When
  52. `true` this index is managed by {ilm-init}, when `false` the backing index is managed by the data stream lifecycle.
  53. Defaults to `true`.
  54. [[index-data-stream-lifecycle-origination-date]]
  55. `index.lifecycle.origination_date`::
  56. (<<indices-update-settings,Dynamic>>, long)
  57. If specified, this is the timestamp used to calculate the backing index generation age after this backing index has been
  58. <<index-rollover,rolled over>>. The generation age is used to determine data retention, consequently, you can use this
  59. setting if you create a backing index that contains older data and want to ensure that the retention period or
  60. other parts of the lifecycle will be applied based on the data's original timestamp and not the timestamp they got
  61. indexed. Specified as a Unix epoch value in milliseconds.