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

[8.x](backport #4667) Reword ILM how to guide for revert to ILM policies #4681

Merged
merged 1 commit into from
Dec 12, 2024
Merged

[8.x](backport #4667) Reword ILM how to guide for revert to ILM policies #4681

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
34 changes: 10 additions & 24 deletions docs/en/observability/apm/manage-storage/ilm-how-to.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,21 @@
Lifecycle policies allow you to automate the lifecycle of your APM indices as they grow and age.
A default policy is applied to each APM data stream, but can be customized depending on your business needs.

[discrete]
[id="index-lifecycle-policies-default{append-legacy}"]
== Default policies
In the latest version of Elastic APM, clusters are managed by
{ref}/index-lifecycle-management.html[index lifecycle management (ILM)]
to provide the default data retention settings for APM data as well as allow
customization for lifecycle.

[NOTE]
====
// Explain what changed
// Before
Before 8.15, clusters used {ref}/index-lifecycle-management.html[index lifecycle management (ILM)] to provide the default data retention settings for APM data.
// After
As of 8.15, new clusters use {ref}/data-stream-lifecycle.html[data stream lifecycle (DSL)] to provide default data retention settings, but the customization for lifecycle is still performed using ILM policies, which are now configured to override the default DSL polices.

// What this means for existing clusters that are upgraded
For _existing_ clusters upgrading to 8.15, the default ILM policies should still work as expected.
You can can continue using ILM or switch the default to DSL explicitly using the {ref}/data-stream-apis.html[data stream API].

// What this means for new clusters that are created
For _new_ clusters created in 8.15 or later, if you prefer to continue using ILM,
follow the steps in this guide to create a custom ILM policy and add it to the `*@custom` component template for each data stream.
Some older indices might be managed by {ref}/data-stream-lifecycle.html[data stream lifecycle (DSL)] if a cluster is upgraded to 8.17.
More details are available in <<apm-release-notes-8.17>>.
====

[discrete]
[id="index-lifecycle-policies-default{append-legacy}"]
== Default policies

Each APM data stream has its own default lifecycle policy including a delete definition and a rollover definition.

The table below describes the delete definition for each APM data stream.
Expand Down Expand Up @@ -119,14 +113,6 @@ The delete phase permanently removes the index after a time threshold is met.

Rollover (writing to a new index) prevents a single index from growing too large and optimizes indexing and search performance.
Rollover occurs after either an age or size metric is met.
The default rollover definition for each APM data stream is applied based on {ref}/data-stream-lifecycle-settings.html#cluster-lifecycle-default-rollover[`cluster.lifecycle.default.rollover`].

The APM data stream lifecycle policies can be viewed in {kib}:

. To open **Index Management**, find **Stack Management** in the main menu or use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
. Select **Component Templates**.
. Search for `apm`.
. Look for templates with `@lifecycle` suffix.

TIP: Default lifecycle policies can change between minor versions. This is not considered a breaking change as index management should continually improve and adapt to new features.

Expand Down
Loading