Skip to content

Commit c3aeda6

Browse files
committed
Clear up @Custom stuff; add screencap
1 parent bf31c71 commit c3aeda6

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed
295 KB
Loading

manage-data/lifecycle/index-lifecycle-management/tutorial-customize-built-in-policies.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,20 @@ Copies of managed {{ilm-init}} policies are also marked as **Managed**. You can
144144

145145
To apply your new {{ilm-init}} policy to the `logs` index template, create or edit the `logs@custom` component template.
146146

147-
A `*@custom` component template allows you to customize the mappings and settings of managed index templates, without having to override managed index templates or component templates. This type of component template is automatically picked up by the index template.
147+
148+
:::::{admonition} Using @custom component templates
149+
A `@custom` component template allows you to customize the mappings and settings of the managed index templates, without having to override them or their main component templates.
150+
151+
Many {{es}} managed index templates include one or more `@custom` component templates. A `@custom` component template must first be created before it can be used, and its name must exactly match the name specified in the managed index template in order to be applied automatically to indices as they're created.
152+
153+
For example, if you're ingesting OpenTelemetry (OTel) logs, any OTel log data streams and their backing indices are configured by the `logs-otel@template` managed index template. That index template automatically applies settings defined in the `logs@custom` or the `logs-otel@custom` template when they exist.
154+
155+
Go to **Index Management > Index Templates** and select any managed index to view the `@custom` component templates associated with it.
156+
157+
:::{image} /manage-data/images/elasticsearch-reference-tutorial-custom-policies-otel-template.png
158+
:alt: A screenshot showing the logs@custom and logs-otel@custom component templates associated with the logs-otel@template index template.
159+
:::
160+
:::::
148161

149162
:::{tip}
150163
If you want your {{ilm-init}} changes to apply only to specific indices, you can create a custom index template directly instead of modifying the custom component template. Use the **Index management** page in {{kib}} or the [index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) API to create a new template.

0 commit comments

Comments
 (0)