[ECE] Document component template method to customize logging-and-metrics retention - #8120
[ECE] Document component template method to customize logging-and-metrics retention#8120eedugon wants to merge 2 commits into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
Elastic Docs Style Checker (Vale)Summary: 2 suggestions found 💡 Suggestions (2): Optional style improvements. Apply when helpful.
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
gigerdo
left a comment
There was a problem hiding this comment.
LGTM, thank you for adding more docs on this 👍
shainaraskas
left a comment
There was a problem hiding this comment.
general lgtm, with some suggestions to consider
| Before increasing retention, ensure the `logging-and-metrics` system deployment has sufficient resources and disk capacity. Longer retention increases storage usage and cluster workload, and can result in a busy or overloaded cluster if the deployment is not scaled appropriately. Refer to [ECE system deployments configuration](/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md) for more information. | ||
| :::: | ||
|
|
||
| To customize the retention period, create a new {{ilm-init}} policy with the required settings and apply it to the target data streams. On ECE 4.1.1 or later, apply it through a [component template](#customize-retention-component-templates), which is the recommended approach. On earlier versions, you can [clone the relevant index template](#customize-retention-index-templates) and configure it to use your custom {{ilm-init}} policy, though this requires repeating the procedure after upgrades that change template names. |
There was a problem hiding this comment.
if you expand the link target it will be clearer that you're linking down to a procedure specific to the retention period, rather than a definition of / more information on component templates generically
| To customize the retention period, create a new {{ilm-init}} policy with the required settings and apply it to the target data streams. On ECE 4.1.1 or later, apply it through a [component template](#customize-retention-component-templates), which is the recommended approach. On earlier versions, you can [clone the relevant index template](#customize-retention-index-templates) and configure it to use your custom {{ilm-init}} policy, though this requires repeating the procedure after upgrades that change template names. | |
| To customize the retention period, create a new {{ilm-init}} policy with the required settings and apply it to the target data streams. On ECE 4.1.1 or later, [apply it through a component template](#customize-retention-component-templates), which is the recommended approach. On earlier versions, you can [clone the relevant index template](#customize-retention-index-templates) and configure it to use your custom {{ilm-init}} policy, though this requires repeating the procedure after upgrades that change template names. |
| ```{applies_to} | ||
| deployment: | ||
| ece: ga 4.2+ | ||
| ``` | ||
|
|
||
| Starting from ECE 4.1.1, each index template in the `logging-and-metrics` cluster includes a `composed_of` array that references a set of reserved component template names. If you create a component template with one of these names, {{es}} merges its settings into new backing indices automatically. Because these names do not include a version tag, the customization persists across ECE upgrades without any additional action. |
There was a problem hiding this comment.
I think that having 4.2 and 4.1.1 here is not ideal
would prefer either
- no version in body, stay with 4.2 applicability
- 4.1 applicability, specify 4.1 in body
current version makes one seem wrong, rather than looking like we're adding precision by specifying a patch
re: the content, can we make the benefit statement a little punchier? right now it reads as implementation details
maybe
| ```{applies_to} | |
| deployment: | |
| ece: ga 4.2+ | |
| ``` | |
| Starting from ECE 4.1.1, each index template in the `logging-and-metrics` cluster includes a `composed_of` array that references a set of reserved component template names. If you create a component template with one of these names, {{es}} merges its settings into new backing indices automatically. Because these names do not include a version tag, the customization persists across ECE upgrades without any additional action. | |
| ```{applies_to} | |
| deployment: | |
| ece: ga 4.1+ | |
| ``` | |
| Create a component template with a reserved name to apply custom retention that remains in place after ECE upgrades. | |
| Each index template in the `logging-and-metrics` cluster includes a `composed_of` array that references these reserved names. If you create a matching component template, {{es}} merges its settings into new backing indices. The names do not include a version tag, so they continue to match after an ECE upgrade. | |
| ```{note} | |
| This functionality is only available in ECE 4.1.1 and higher. | |
| ``` | |
|
|
||
| Starting from ECE 4.1.1, each index template in the `logging-and-metrics` cluster includes a `composed_of` array that references a set of reserved component template names. If you create a component template with one of these names, {{es}} merges its settings into new backing indices automatically. Because these names do not include a version tag, the customization persists across ECE upgrades without any additional action. | ||
|
|
||
| The following component template names are reserved for customization. Define only the one that matches the scope you need: |
There was a problem hiding this comment.
I assume you can define as many as you want, right? this reads as you can only define one, but maybe a couple can coexist?
| The following component template names are reserved for customization. Define only the one that matches the scope you need: | |
| The following component template names are reserved for customization. Define only the templates that match the scope you need: |
Summary
logging-and-metricscluster, available from ECE 4.1.1 (applies_to set to 4.2 to avoid confusion in 4.1.0).@customcomponent template names with their scope (index-specific, all logs, all metrics, all data streams).Related
Closes https://github.com/elastic/docs-content-internal/issues/840
Test plan
ga 4.2+badge.applies_toblock on the new section displays the correct version badge.🤖 Generated with Claude Code