-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathilm.html
553 lines (531 loc) · 28.7 KB
/
ilm.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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Custom index lifecycle management with APM Server | APM Server Reference [7.15] | Elastic</title>
<meta class="elastic" name="content" content="Custom index lifecycle management with APM Server | APM Server Reference [7.15]">
<link rel="home" href="index.html" title="APM Server Reference [7.15]"/>
<link rel="up" href="howto-guides.html" title="How-to guides"/>
<link rel="prev" href="sourcemaps.html" title="How to apply source maps to error stack traces when using minified bundles"/>
<link rel="next" href="jaeger.html" title="Jaeger integration"/>
<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="sourcemaps.html">« How to apply source maps to error stack traces when using minified bundles</a>
</span>
<span class="next">
<a href="jaeger.html">Jaeger integration »</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="howto-guides.html">How-to guides</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Custom index lifecycle management with APM Server</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.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"></a>Custom index lifecycle management with APM Server</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.asciidoc">edit</a></div>
</div></div></div>
<p>The <a class="xref" href="ilm-reference.html#ilm-default" title="Default policy">default ILM policy</a> can be customized to match the needs of your data.
APM Server will assist you in creating a custom index lifecycle policy,
but you must first ensure that ILM and ILM setup are enabled.
Then create a custom policy and map it to APM event types.
All of this can be done directly from the <code class="literal">apm-server.yml</code> file.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a class="xref" href="ilm.html#ilm-enable" title="Enable ILM">Enable ILM</a>
</li>
<li class="listitem">
<a class="xref" href="ilm.html#ilm-setup" title="Set up ILM with APM Server">Set up ILM with APM Server</a>
</li>
<li class="listitem">
<a class="xref" href="ilm.html#custom-ilm-index-suffix" title="Create a custom ILM index_suffix">Create a custom ILM <code class="literal">index_suffix</code></a>
</li>
<li class="listitem">
<a class="xref" href="ilm.html#custom-ilm-policy" title="Create a custom ILM policy">Create a custom ILM policy</a>
</li>
<li class="listitem">
<a class="xref" href="ilm.html#example-ilm-config" title="Example ILM configuration">Example ILM configuration</a>
</li>
<li class="listitem">
<a class="xref" href="ilm.html#map-ilm-policy" title="Map ILM policies to an event type">Map ILM policies to an event type</a>
</li>
</ul>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>If you do not want APM Server to create policies and templates,
or if you want to use unmanged indices, see the <a class="xref" href="ilm-reference.html#ilm-config-reference" title="Configuration reference">ILM configuration reference</a>
for a full list of configuration settings.</p>
</div>
</div>
<div class="position-relative"><h4><a id="ilm-enable"></a>Enable ILM</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>Before enabling ILM, ensure 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>Enable ILM by setting <code class="literal">ilm.enabled</code> to <code class="literal">"auto"</code> (the default):</p>
<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"</pre>
</div>
<div class="position-relative"><h4><a id="ilm-setup"></a>Set up ILM with APM Server</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>Enable APM Server to create managed indices,
and customized polices and templates that are written to Elasticsearch, by setting <code class="literal">apm-server.ilm.setup.enabled</code>
to <code class="literal">true</code>.</p>
<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:
setup:
enabled: true</pre>
</div>
<p>ILM can now be customized via the remaining <code class="literal">apm-server.ilm.setup.*</code> configuration options.</p>
<div class="position-relative"><h4><a id="custom-ilm-index-suffix"></a>Create a custom ILM <code class="literal">index_suffix</code></h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>You can define a custom index suffix for each event type. The index suffix is limited to variables
concerning <code class="literal">observer.*</code>; if other variables are configured, the server will refuse to start.
The resulting rollover alias and index name will be of type <code class="literal">apm-{version}-{event_type}-{custom_index_suffix},
e.g., `apm-7.9.0-span-foo</code>.
The mapped ILM policy can specify a rollover action, e.g., when an index reaches a size of 50GB,
it should roll over to create a new index. The rollover alias abstracts away the concrete write index, while
automatically being updated and keeping track of the current write index.
This allows you to use the rollover alias instead of specific indices in queries.</p>
<p>For example, the default rollover alias for event type <code class="literal">transaction</code> would be <code class="literal">apm-7.8.0-transaction</code>. This alias points
to a write index named <code class="literal">apm-7.8.0-transaction-000001</code>. When this index reaches its defined size or age, it will roll over to
a new index named <code class="literal">apm-7.8.0-transaction-000002</code>. The rollover alias of <code class="literal">apm-7.8.0-transaction</code> keeps
track of which index is the current write index while ingesting data.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Manually ensure that templates containing customized index information do not conflict with each other
or the default templates.</p>
</div>
</div>
<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.
A conflicting behavior could occur when an index matches multiple templates with the same <code class="literal">order</code>.
For example, the APM Server was started without any customization, leading to a default index setup. Afterward, the
Server configuration is customized to add the index suffix <code class="literal">production</code> for the event type <code class="literal">span</code>.
When the Server restarts, it will set up a new index template based on the new custom index suffix.
A newly created index named <code class="literal">apm-server-7.9.0-span-production</code> would now match the default template with the index pattern of
<code class="literal">apm-server-7.9.0-span*</code>, but also the new template with the index pattern <code class="literal">apm-server-7.9.0-span-production*</code>.
In this case, the old template needs to be manually deleted,
or the <code class="literal">index_pattern</code> or <code class="literal">order</code> need to be changed to avoid conflicts.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>If you customize <code class="literal">setup.template.pattern</code>, ensure that the configured pattern
still matches the rollover aliases. If it doesn’t, the Elasticsearch index template with the predefined mappings will
not match against created indices, leading to indexing issues.</p>
</div>
</div>
<p>The example below shows how to change the <code class="literal">index_suffix</code> to a custom value.</p>
<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:
mapping:
- event_type: "error"
index_suffix: "dev"
- event_type: "span"
index_suffix: "dev"
- event_type: "transaction"
index_suffix: "dev"
- event_type: "metric"
index_suffix: "dev"</pre>
</div>
<div class="position-relative"><h4><a id="custom-ilm-policy"></a>Create a custom ILM policy</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>You can define as many policies as you’d like, but they only need to be created once,
and will persist through version upgrades.
Any change in existing ILM policies will only take place once the next phase is entered.</p>
<p>APM Server doesn’t do any validation on policies.
Instead, if something is incorrectly defined, Elasticsearch will respond with <code class="literal">400</code> and APM Server won’t connect.</p>
<p>The default ILM policy can be viewed and edited in two places:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
In your <code class="literal">apm-server.yml</code> configuration file.
</li>
<li class="listitem">
On the <span class="strong strong"><strong><a href="/guide/en/kibana/7.15/index-lifecycle-policies.html" class="ulink" target="_top">Index lifecycle policies</a></strong></span> page in Kibana.
</li>
</ul>
</div>
<p>Here’s an example of a custom ILM policy, named <code class="literal">apm-error-span-policy</code>,
that applies all four phases to its index lifecycle, including a cold phase with frozen indices,
and a delete phase after 30 days.</p>
<div class="pre_wrapper lang-yml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yml"> ilm:
setup:
policies:
- name: "apm-error-span-policy"
policy:
phases:
hot:
actions:
rollover:
max_size: "50gb"
max_age: "1d"
set_priority:
priority: 100
warm:
min_age: "7d"
actions:
set_priority:
priority: 50
readonly: {}
cold:
min_age: "30d"
actions:
set_priority:
priority: 0
freeze: {}
delete:
min_age: "60d"
actions:
delete: {}</pre>
</div>
<p>Here’s an example of different policy, named <code class="literal">apm-transaction-metric-policy</code>,
that keeps data in the hot, warm, and cold phases for a longer period of time,
and does not delete any data.</p>
<div class="pre_wrapper lang-yml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yml"> ilm:
setup:
policies:
- name: "apm-transaction-metric-policy"
policy:
phases:
hot:
actions:
rollover:
max_size: "50gb"
max_age: "30d"
set_priority:
priority: 100
warm:
min_age: "60d"
actions:
set_priority:
priority: 50
readonly: {}
cold:
min_age: "90d"
actions:
set_priority:
priority: 0
freeze: {}</pre>
</div>
<p>Head on over to the Elasticsearch documentation to learn more about all available policy
<a href="/guide/en/elasticsearch/reference/7.15/ilm-policy-definition.html" class="ulink" target="_top">phases</a> and <a href="/guide/en/elasticsearch/reference/7.15/_actions.html" class="ulink" target="_top">actions</a>.</p>
<p>After starting up APM Server, you can confirm the policy was created by using the GET lifecycle policy API:</p>
<div class="pre_wrapper lang-js">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-js">GET _ilm/policy</pre>
</div>
<div class="position-relative"><h4><a id="map-ilm-policy"></a>Map ILM policies to an event type</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>If your policy isn’t mapped to an event type, it will not be sent to Elasticsearch.
Policies are mapped to event types using the <code class="literal">ilm.setup.mapping</code> configuration.</p>
<p>Using the example from the previous step, we can map the <code class="literal">apm-error-span-policy</code>
to <code class="literal">errors</code> and <code class="literal">spans</code>, and the <code class="literal">apm-transaction-metric-policy</code> to <code class="literal">transactions</code> and <code class="literal">metrics</code>.</p>
<div class="pre_wrapper lang-yml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yml"> ilm:
enabled: "auto"
setup:
mapping:
- event_type: "error"
policy_name: "apm-error-span-policy"
- event_type: "span"
policy_name: "apm-error-span-policy"
- event_type: "transaction"
policy_name: "apm-transaction-metric-policy"
- event_type: "metric"
policy_name: "apm-transaction-metric-policy"</pre>
</div>
<div class="position-relative"><h4><a id="example-ilm-config"></a>Example ILM configuration</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/ilm.asciidoc">edit</a></div>
<p>Now that we have all of the puzzle pieces,
we can put them together to see what a custom ILM configuration might look like.</p>
<p>As a reminder, the example below creates two different policies, one for <code class="literal">errors</code> and <code class="literal">spans</code>,
and another for <code class="literal">transactions</code> and <code class="literal">metrics</code>.</p>
<p>The <code class="literal">apm-error-span-policy</code> applies all four phases to its index lifecycle, including a cold phase with frozen indices,
and a delete phase after 30 days.
The <code class="literal">apm-transaction-metric-policy</code> keeps data in the hot, warm, and cold phases for a longer period of time,
and does not delete any data.</p>
<p>Additionally this example shows how to set custom rollover aliases.</p>
<div class="pre_wrapper lang-yml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yml"> ilm:
enabled: "auto"
setup:
mapping:
- event_type: "error"
policy_name: "apm-error-span-policy"
index_suffix: "development"
- event_type: "span"
policy_name: "apm-error-span-policy"
index_suffix: "development"
- event_type: "transaction"
policy_name: "apm-transaction-metric-policy"
index_suffix: "development"
- event_type: "metric"
policy_name: "apm-transaction-metric-policy"
index_suffix: "development"
enabled: true
policies:
- name: "apm-error-span-policy"
policy:
phases:
hot:
actions:
rollover:
max_size: "50gb"
max_age: "1d"
set_priority:
priority: 100
warm:
min_age: "7d"
actions:
set_priority:
priority: 50
readonly: {}
cold:
min_age: "30d"
actions:
set_priority:
priority: 0
freeze: {}
delete:
min_age: "60d"
actions:
delete: {}
- name: "apm-transaction-metric-policy"
policy:
phases:
hot:
actions:
rollover:
max_size: "50gb"
max_age: "30d"
set_priority:
priority: 100
warm:
min_age: "60d"
actions:
set_priority:
priority: 50
readonly: {}
cold:
min_age: "90d"
actions:
set_priority:
priority: 0
freeze: {}</pre>
</div>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="sourcemaps.html">« How to apply source maps to error stack traces when using minified bundles</a>
</span>
<span class="next">
<a href="jaeger.html">Jaeger integration »</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>