-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathilm-reference.html
451 lines (429 loc) · 27.2 KB
/
ilm-reference.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Configure Index lifecycle management (ILM) | APM Server Reference [7.15] | Elastic</title>
<meta class="elastic" name="content" content="Configure Index lifecycle management (ILM) | APM Server Reference [7.15]">
<link rel="home" href="index.html" title="APM Server Reference [7.15]"/>
<link rel="up" href="configuring-howto-apm-server.html" title="Configure APM Server"/>
<link rel="prev" href="configuration-template.html" title="Configure Elasticsearch index template loading"/>
<link rel="next" href="configuration-instrumentation.html" title="Configure APM instrumentation"/>
<link rel="canonical" href="https://www.elastic.co/guide/en/apm/guide/current/ilm-how-to.html"/>
<meta class="elastic" name="product_version" content="7.15"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/7.15"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.15"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
</head>
<!--© 2015-2025 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
The Elastic APM integration became generally available in 7.16 — see the <a href="https://www.elastic.co/guide/en/apm/guide/current/index.html">APM Guide</a> for updated documentation. Standalone APM Server users can see the <a href="https://www.elastic.co/guide/en/apm/guide/current/legacy-apm-overview.html" title="Legacy APM Overview">Legacy APM Overview</a> and <a href="https://www.elastic.co/guide/en/apm/guide/current/overview.html" title="Legacy APM Server Reference">Legacy APM Server Reference</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="configuration-template.html">« Configure Elasticsearch index template loading</a>
</span>
<span class="next">
<a href="configuration-instrumentation.html">Configure APM instrumentation »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
<div id="related-products" class="dropdown">
<div class="related-products-title">APM:</div>
<div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
<div class="dropdown-content">
<ul>
<li class="dropdown-category">APM</li>
<ul>
<li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
</ul>
<li class="dropdown-category">APM agents</li>
<ul>
<li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
</ul>
<li class="dropdown-category">APM extensions</li>
<ul>
<li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
<li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
</ul>
</ul>
</div>
</div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="configuring-howto-apm-server.html">Configure APM Server</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Configure Index lifecycle management (ILM)</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
<strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="chapter xpack">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="ilm-reference"></a>Configure Index lifecycle management (ILM)</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
</div></div></div>
<p>The <a href="/guide/en/elasticsearch/reference/7.15/getting-started-index-lifecycle-management.html" class="ulink" target="_top">index lifecycle management</a> (ILM)
feature in Elasticsearch allows you to automate the lifecycle of your APM Server indices as they grow and age.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>ILM policies are only applied to indices created after the policies have taken effect.
In other words, any indices present before ILM was configured still need to be managed manually.</p>
</div>
</div>
<p>To learn how to define your own index lifecycle policies or rollover aliases,
see <a class="xref" href="ilm.html" title="Custom index lifecycle management with APM Server">customize index lifecycle management</a>.</p>
<div class="position-relative"><h3><a id="ilm-default"></a>Default policy</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>ILM is enabled by default, and the default policy
will be applied to all APM indices as long as all of the following conditions are true:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The Elasticsearch instance supports ILM.
</li>
<li class="listitem">
<code class="literal">output.elasticsearch</code> is enabled.
</li>
<li class="listitem">
Custom <code class="literal">index</code> or <code class="literal">indices</code> settings are not configured.
</li>
</ul>
</div>
<p>The default ILM policy applies <span class="strong strong"><strong>hot</strong></span> and <span class="strong strong"><strong>warm</strong></span> phases to all APM events:
<code class="literal">span</code>, <code class="literal">transaction</code>, <code class="literal">error</code>, and <code class="literal">metric</code>.
<span class="strong strong"><strong>Cold</strong></span> and <span class="strong strong"><strong>delete</strong></span> phases are not defined.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<span class="strong strong"><strong>Hot</strong></span> — Rollover data when the index reaches a maximum size of 50gb or a maximum age of 30 days:
<code class="literal">max_size: 50gb</code>, <code class="literal">max_age: 30d</code>
</li>
<li class="listitem">
<span class="strong strong"><strong>Warm</strong></span> — Move to warm phase after 30 days: <code class="literal">min_age: 30d</code>
</li>
</ul>
</div>
<div class="position-relative"><h3><a id="ilm-default-config"></a>Default configuration</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<div class="pre_wrapper lang-yml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yml">apm-server:
ilm:
enabled: "auto"
setup:
enabled: true
overwrite: false
require_policy: true
mapping:
- event_type: "error"
policy_name: "apm-rollover-30-days"
index_suffix: ""
- event_type: "span"
policy_name: "apm-rollover-30-days"
index_suffix: ""
- event_type: "transaction"
policy_name: "apm-rollover-30-days"
index_suffix: ""
- event_type: "metric"
policy_name: "apm-rollover-30-days"
index_suffix: ""
policies:
- name: "apm-rollover-30-days"
policy:
phases:
hot:
actions:
rollover:
max_size: "50gb"
max_age: "30d"
set_priority:
priority: 100
warm:
min_age: "30d"
actions:
set_priority:
priority: 50
readonly: {}</pre>
</div>
<div class="position-relative"><h3><a id="ilm-config-scenarios"></a>Configuration scenarios</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>The following table can help you determine which options to configure when enabling,
setting up, or disabling ILM:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1"/>
<col class="col_2"/>
</colgroup>
<tbody>
<tr>
<td align="left" colspan="2" valign="top"><p><span class="strong strong"><strong>Enable ILM and Enable ILM setup.</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><em>Details:</em>
Create managed indices. Default policies and templates are written to Elasticsearch.</p>
<p><em>Successful if:</em> A policy and template do not exist.</p>
<p><em>Example:</em> Starting APM Server for the first time.</p></td>
<td align="left" valign="top"><p><em>Configure these options:</em></p>
<p> <a class="xref" href="ilm-reference.html#ilm-enabled-config" title="ilm.enabled"><code class="literal">ilm.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-config" title="apm-server.ilm.setup.enabled"><code class="literal">ilm.setup.enabled:true</code></a></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><em>Details:</em>
Create managed indices. Customized policies and templates are written to Elasticsearch.</p>
<p><em>Successful if:</em> A policy and template already exists.</p>
<p><em>Example:</em> You’re customizing a policy that’s already been sent to Elasticsearch.</p></td>
<td align="left" valign="top"><p><em>Configure these options:</em></p>
<p> <a class="xref" href="ilm-reference.html#ilm-enabled-config" title="ilm.enabled"><code class="literal">ilm.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-config" title="apm-server.ilm.setup.enabled"><code class="literal">ilm.setup.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-overwrite-config" title="apm-server.ilm.setup.overwrite"><code class="literal">ilm.setup.overwrite:true</code></a></p></td>
</tr>
<tr>
<td align="left" colspan="2" valign="top"><p><span class="strong strong"><strong>Enable ILM and Disable ILM setup.</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><em>Details:</em>
Use managed indices. No policies, rollover aliases and templates will be created by APM Server.</p>
<p><em>Example:</em> You’re creating your policies, rollover aliases and templates elsewhere, e.g., with Elasticsearch APIs.</p></td>
<td align="left" valign="top"><p><em>Configure these options:</em></p>
<p> <a class="xref" href="ilm-reference.html#ilm-enabled-config" title="ilm.enabled"><code class="literal">ilm.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-config" title="apm-server.ilm.setup.enabled"><code class="literal">ilm.setup.enabled:false</code></a></p></td>
</tr>
<tr>
<td align="left" colspan="2" valign="top"><p><span class="strong strong"><strong>Disable ILM to create unmanaged default indices.</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><em>Details:</em>
Disable ILM to create unmanaged indices with default names. Ensure event specific templates are set up accordingly.</p></td>
<td align="left" valign="top"><p><em>Configure these options:</em></p>
<p> <a class="xref" href="ilm-reference.html#ilm-enabled-config" title="ilm.enabled"><code class="literal">ilm.enabled:false</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-config" title="apm-server.ilm.setup.enabled"><code class="literal">ilm.setup.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-overwrite-config" title="apm-server.ilm.setup.overwrite"><code class="literal">ilm.setup.overwrite:true</code></a></p></td>
</tr>
<tr>
<td align="left" colspan="2" valign="top"><p><span class="strong strong"><strong>Create unmanaged custom Indices</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><em>Details:</em>
Disable ILM to create unmanaged indices with custom names. Ensure event specific templates are set up accordingly.</p></td>
<td align="left" valign="top"><p><em>Configure these options:</em></p>
<p> <a class="xref" href="ilm-reference.html#ilm-enabled-config" title="ilm.enabled"><code class="literal">ilm.enabled:auto</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-config" title="apm-server.ilm.setup.enabled"><code class="literal">ilm.setup.enabled:true</code></a>
<a class="xref" href="ilm-reference.html#ilm-setup-overwrite-config" title="apm-server.ilm.setup.overwrite"><code class="literal">ilm.setup.overwrite:true</code></a>
<code class="literal">output.elasticsearch.index: "my-custom-index"</code></p></td>
</tr>
</tbody>
</table>
</div>
<div class="position-relative"><h3><a id="ilm-config-reference"></a>Configuration reference</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<div class="position-relative"><h5><a id="ilm-enabled-config"></a><code class="literal">ilm.enabled</code></h5><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>Can be <code class="literal">"auto"</code>, <code class="literal">"true"</code>, or <code class="literal">"false"</code>. Defaults to <code class="literal">"auto"</code>.</p>
<p><span class="strong strong"><strong><code class="literal">"auto"</code></strong></span>:
APM Server will enable ILM only if all three of the conditions below are true.
If any of the conditions are not met, ILM will be disabled.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The Elasticsearch instance supports ILM.
</li>
<li class="listitem">
<code class="literal">output.elasticsearch</code> is enabled.
</li>
<li class="listitem">
Custom <code class="literal">index</code> or <code class="literal">indices</code> settings are not configured.
</li>
</ul>
</div>
<p><span class="strong strong"><strong><code class="literal">"true"</code></strong></span>:
APM Server will ignore any configured index settings and enable ILM if both of the conditions below are true.
If any of the conditions are not met, APM Server will disable ILM, create unmanaged indices, and an error will be logged.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">output.elasticsearch</code> is enabled.
</li>
<li class="listitem">
The Elasticsearch instance supports ILM.
</li>
</ul>
</div>
<p><span class="strong strong"><strong><code class="literal">"false"</code></strong></span>:
Explicitly disables ILM.</p>
<div class="position-relative"><h5><a id="ilm-setup-config"></a><code class="literal">apm-server.ilm.setup.enabled</code></h5><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>Defaults to <code class="literal">true</code>.</p>
<p>When <code class="literal">true</code>, APM Server will create an ILM specific index template for each APM event type.
This is required to map ILM aliases and policies to indices.</p>
<p>When <code class="literal">false</code>, ILM setup is disabled. No policies, templates, or aliases will be created by APM Server.
Only disable <code class="literal">ilm.setup</code> if you want to set up index management on your own.
If you simply want to disable ILM, use <code class="literal">apm-server.ilm.enabled: false</code> instead.</p>
<div class="position-relative"><h5><a id="ilm-setup-overwrite-config"></a><code class="literal">apm-server.ilm.setup.overwrite</code></h5><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>Defaults to <code class="literal">false</code>. When <code class="literal">false</code>, APM Server will not overwrite any existing policies or ILM related templates.
When first setting up ILM, your initial template and policy will be applied.
You must set this to <code class="literal">true</code> when customizing your policies and template for them to be applied,
or if you want to switch between managed and unmanaged indices.</p>
<div class="position-relative"><h5><a id="ilm-setup-policy-config"></a><code class="literal">apm-server.ilm.setup.require_policy</code></h5><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>Defaults to <code class="literal">true</code>, which means that an ILM policy must be defined in <code class="literal">apm-server.yml</code>.
Changing this to <code class="literal">false</code> allows you to manually set up ILM policies and templates outside of APM Server,
e.g., with Elasticsearch APIs.
APM Server will still make use of ILM and connect your template with the defined mapping.</p>
<div class="position-relative"><h5><a id="ilm-setup-mapping-config"></a><code class="literal">apm-server.ilm.setup.mapping</code></h5><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm-reference.asciidoc">edit</a></div>
<p>Maps each event type to a corresponding <code class="literal">policy_name</code> and <code class="literal">index_suffix</code>.
APM event types can only be <code class="literal">error</code>, <code class="literal">span</code>, <code class="literal">transaction</code>, and <code class="literal">metric</code>.
If you attempt to map an index lifecycle policy to a different event type, APM Server will not start.
If you only map a subset of APM event types, the default values will be used for omitted event types.
If a policy is defined, it must be mapped to an event type to take effect.</p>
<p>By default, the APM Server creates a template without a custom index suffix per event type. When defining custom
index suffixes, always ensure that templates, that might have been set up previously, are removed or do not conflict.
See <a class="xref" href="ilm.html#custom-ilm-index-suffix" title="Create a custom ILM index_suffix">customizing an index suffix</a> for more information.</p>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="configuration-template.html">« Configure Elasticsearch index template loading</a>
</span>
<span class="next">
<a href="configuration-instrumentation.html">Configure APM instrumentation »</a>
</span>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
<!-- Feedback widget -->
<div id="feedbackWidgetContainer"></div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<!-- Feedback modal -->
<div id="feedbackModalContainer"></div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs-v1.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>