-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathapm-integration.html
403 lines (378 loc) · 20.9 KB
/
apm-integration.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>APM integration for Elastic Agent | APM Server Reference [7.15] | Elastic</title>
<meta class="elastic" name="content" content="APM integration for Elastic Agent | APM Server Reference [7.15]">
<link rel="home" href="index.html" title="APM Server Reference [7.15]"/>
<link rel="up" href="index.html" title="APM Server Reference [7.15]"/>
<link rel="prev" href="release-notes-6.1.html" title="APM Server version 6.1"/>
<link rel="next" href="apm-integration-data-streams.html" title="Data streams"/>
<link rel="canonical" href="https://www.elastic.co/guide/en/apm/guide/current/upgrade-to-apm-integration.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="release-notes-6.1.html">« APM Server version 6.1</a>
</span>
<span class="next">
<a href="apm-integration-data-streams.html">Data streams »</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>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>APM integration for Elastic Agent</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.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="part">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="apm-integration"></a>APM integration for Elastic Agent</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
</div></div></div>
<div class="openblock partintro">
<div class="content">
<div class="sidebar">
<div class="titlepage"></div>
<p>This documentation is for a previous release of Elastic APM.
To upgrade to the current version, see <a href="/guide/en/apm/guide/current/upgrade.html" class="ulink" target="_top">Upgrade Elastic APM</a>.</p>
</div>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.</p>
</div>
</div>
<p>Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to each host.
The APM integration for Elastic Agent assigns the APM input to a specified policy,
and installs Elasticsearch templates and ingest node pipelines for APM data.
When Elastic Agent is assigned a policy with an APM input,
Elastic Agent will run the APM Server binary locally and listen for APM data.</p>
<div class="position-relative"><h3><a id="apm-integration-get-started"></a>Get started</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<p>Ready to jump in?
Read through the <a class="xref" href="apm-integration.html#apm-integration-limitations" title="Limitations">APM integration limitations</a>, then head over to the
quick start guide: <a href="/guide/en/fleet/7.15/fleet-quick-start-traces.html" class="ulink" target="_top">Get application traces into the Elastic Stack</a>.</p>
<div class="position-relative"><h3><a id="apm-integration-architecture"></a>Architecture</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<p>If RUM is enabled, you must run Elastic Agent centrally.
If RUM is disabled, Elastic Agent can be run on edge machines. To do this,
download and enroll an Elastic Agent on the same machines that your instrumented services run on.</p>
<div class="position-relative"><h3><a id="apm-integration-limitations"></a>Limitations</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>This integration is still in beta and does not have feature parity with standalone APM.
Do not migrate production deployments.</p>
</div>
</div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
Data steams migration
</span>
</dt>
<dd>
Existing APM users will need to migrate to data streams to use the APM integration.
This change cannot be reverted, and impacts how APM Server and its indices are configured — see <a class="xref" href="apm-integration-data-streams.html#apm-integration-naming-scheme" title="Data stream naming scheme">Data stream naming scheme</a> and <a class="xref" href="apm-integration-configure.html" title="Configure APM integration"><em>Configure</em></a>.
Additionally, users on Elastic Cloud Enterprise require additional steps prior to migrating, like configuring TLS certificates for the connection between APM Server and Elasticsearch.
</dd>
<dt>
<span class="term">
Stack monitoring
</span>
</dt>
<dd>
<a class="xref" href="monitoring.html" title="Monitor APM Server">Stack monitoring</a> is not yet available.
</dd>
<dt>
<span class="term">
Index lifecycle management (ILM)
</span>
</dt>
<dd>
A default ILM policy, named <code class="literal">traces-apm.traces-default_policy</code> is created for all event types.
This policy moves indices to a warm data tier after 30 days.
No default cold or delete data tier is defined.
It is not possible to configure this policy in APM Server or Elastic Agent–
it must be configured with Elasticsearch or Kibana.
See <a href="/guide/en/elasticsearch/reference/7.15/example-using-index-lifecycle-policy.html" class="ulink" target="_top">Customize built-in ILM policies</a> for more information.
</dd>
<dt>
<span class="term">
Onboarding
</span>
</dt>
<dd>
APM Server no longer writes an onboarding document when setting up.
</dd>
<dt>
<span class="term">
Standalone mode
</span>
</dt>
<dd>
<a href="/guide/en/fleet/7.15/run-elastic-agent-standalone.html" class="ulink" target="_top">Standalone mode</a> is not currently supported.
An Elastic Agent with the APM integration enabled must be managed by fleet.
</dd>
<dt>
<span class="term">
Service names
</span>
</dt>
<dd>
Service names are case-insensitive and must be unique.
See <a class="xref" href="apm-integration-data-streams.html#apm-integration-service-name" title="Service names">Service names</a> for more information.
</dd>
<dt>
<span class="term">
Upgrading from prior Elastic Agent versions
</span>
</dt>
<dd>
Due to changing API key permissions, an Elastic Agent enrolled before version 7.12 is not compatible with the APM integration.
You must enroll a new Elastic Agent to use the integration.
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="apm-integration-terminology"></a>Terminology</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
Agents
</span>
</dt>
<dd>
<p>
Elastic Agent and APM agents are different components:
</p>
<p><a href="/guide/en/fleet/7.15/fleet-overview.html" class="ulink" target="_top"><span class="strong strong"><strong>Elastic Agent</strong></span></a> is a single,
unified agent that you can deploy to hosts or containers to collect data and send it to the Elastic Stack.
Behind the scenes, Elastic Agent runs APM Server to listen for <code class="literal">apm</code> data.</p>
<p><a href="/guide/en/apm/get-started/7.15/components.html" class="ulink" target="_top"><span class="strong strong"><strong>APM agents</strong></span></a> are open source libraries written in the same language as your service.
You may only need one, or you might use all of them.
You install them into your service as you would install any other library.
They instrument your code and collect performance data and errors at runtime.
This data is sent to APM Server.</p>
</dd>
<dt>
<span class="term">
Central management/configuration
</span>
</dt>
<dd>
<p>
Fleet central management and APM agent central configuration are two different features
that can be accessed in Kibana:
</p>
<p><span class="strong strong"><strong>Fleet central management</strong></span> serves as the communication channel with your Elastic Agents;
agents check in for the latest updates on a regular basis.</p>
<p><span class="strong strong"><strong>APM agent central configuration</strong></span> allows you to fine-tune your agent configuration from within the APM app.
Changes are automatically propagated to your APM agents, so there’s no need to redeploy your services.</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="apm-integration-versioning"></a>Package versioning</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<p>The APM package is versioned separately from the Elastic Stack.
In the future, we may align with Elastic Stack versioning.</p>
<div class="position-relative"><h3><a id="apm-integration-learn-more"></a>Learn more</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.15/docs/apm-package/apm-integration.asciidoc">edit</a></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a class="xref" href="input-apm.html" title="APM input settings"><em>Input settings</em></a>
</li>
<li class="listitem">
<a class="xref" href="apm-integration-data-streams.html" title="Data streams"><em>Data streams</em></a>
</li>
<li class="listitem">
<a href="/guide/en/fleet/7.15/fleet-overview.html" class="ulink" target="_top">Fleet overview</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="release-notes-6.1.html">« APM Server version 6.1</a>
</span>
<span class="next">
<a href="apm-integration-data-streams.html">Data streams »</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>