-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathdoc-directory.html
350 lines (329 loc) · 19.6 KB
/
doc-directory.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
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Documentation directory | APM Overview [6.6] | Elastic</title>
<meta class="elastic" name="content" content="Documentation directory | APM Overview [6.6]">
<link rel="home" href="index.html" title="APM Overview [6.6]"/>
<link rel="up" href="index.html" title="APM Overview [6.6]"/>
<link rel="prev" href="index.html" title="APM Overview [6.6]"/>
<link rel="next" href="overview.html" title="Overview"/>
<meta class="elastic" name="product_version" content="6.6"/>
<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/6.6"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="6.6"/>
<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">
A newer version is available. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div class="navheader">
<span class="prev">
</span>
<span class="next">
<a href="overview.html">Overview »</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">Overview<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>Documentation directory</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.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">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="doc-directory"></a>Documentation directory</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
</div></div></div>
<p>The following sections are designed to guide you through the available Elastic APM documentation.</p>
<div class="position-relative"><h3><a id="_apm_overview"></a>APM Overview</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>You’re here!
The APM Overview is your launchpad for getting started with APM.
We recommend reading through this documentation to gain a deeper understanding of the Elastic APM ecosystem.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a class="xref" href="overview.html" title="Overview"><em>Overview</em></a>
</li>
<li class="listitem">
<a class="xref" href="install-and-run.html" title="Install and run"><em>Install and run</em></a>
</li>
<li class="listitem">
<a class="xref" href="apm-data-model.html" title="Data Model"><em>Data Model</em></a>
</li>
<li class="listitem">
<a class="xref" href="distributed-tracing.html" title="Distributed tracing"><em>Distributed tracing</em></a>
</li>
<li class="listitem">
<a class="xref" href="agent-server-compatibility.html" title="Agent/Server compatibility"><em>Agent/Server compatibility</em></a>
</li>
</ul>
</div>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>Want to skip straight to installation?
Simply use an existing cluster or grab a fresh installation of the Elastic Stack,
spin up an APM Server, and add a bit of code to instrument your app with agents.
Full details are available on the <a class="xref" href="install-and-run.html" title="Install and run">install and run</a> page.</p>
</div>
</div>
<div class="position-relative"><h3><a id="_apm_server"></a>APM Server</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>The APM Server receives data from APM agents and converts that data into Elasticsearch documents.
The <a href="/guide/en/apm/server/6.6/index.html" class="ulink" target="_top">APM Server reference</a> provides everything you need when it comes to working with the server.
Here you can learn about <a href="/guide/en/apm/server/6.6/installing.html" class="ulink" target="_top">installation</a>,
<a href="/guide/en/apm/server/6.6/configuring-howto-apm-server.html" class="ulink" target="_top">configuration</a>,
<a href="/guide/en/apm/server/6.6/securing-apm-server.html" class="ulink" target="_top">security</a>,
<a href="/guide/en/apm/server/6.6/monitoring.html" class="ulink" target="_top">monitoring</a>, and more.</p>
<div class="position-relative"><h3><a id="_apm_agents"></a>APM Agents</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>APM agents are open source libraries that you install into your services.
You may only need one, or you might use all of them.
Each agent has its own documentation:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a href="/guide/en/apm/agent/go/current/introduction.html" class="ulink" target="_top">Go agent</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/java/current/intro.html" class="ulink" target="_top">Java agent</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/nodejs/current/intro.html" class="ulink" target="_top">Node.js agent</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/python/current/getting-started.html" class="ulink" target="_top">Python agent</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/ruby/current/introduction.html" class="ulink" target="_top">Ruby agent</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/rum-js/current/intro.html" class="ulink" target="_top">JavaScript Real User Monitoring (RUM) agent</a>
</li>
</ul>
</div>
<div class="position-relative"><h3><a id="_apm_kibana_ui"></a>APM Kibana UI</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>Application performance monitoring is all about visualizing data and detecting bottlenecks, so it’s crucial you understand how to use the <a href="/guide/en/kibana/6.6/xpack-apm.html" class="ulink" target="_top">Kibana APM UI</a>. The following sections will help you get started:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a href="/guide/en/kibana/6.6/apm-getting-started.html" class="ulink" target="_top">Getting Started</a>
</li>
<li class="listitem">
<a href="/guide/en/kibana/6.6/apm-bottlenecks.html" class="ulink" target="_top">Visualizing application bottlenecks</a>
</li>
<li class="listitem">
<a href="/guide/en/kibana/6.6/apm-ui.html" class="ulink" target="_top">Using the APM UI</a>
</li>
</ul>
</div>
<p>APM also has built-in integrations with Machine Learning. To learn more about this feature, refer to the Kibana UI documentation for <a href="/guide/en/kibana/6.6/machine-learning-integration.html" class="ulink" target="_top">Machine learning integration</a>.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>If you’d like to dive deeper into Kibana, the general <a href="/guide/en/kibana/6.6/index.html" class="ulink" target="_top">Kibana documentation</a> is also helpful.</p>
</div>
</div>
<div class="position-relative"><h3><a id="_troubleshooting"></a>Troubleshooting</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>If you run into trouble, there are three places you can look for help:
Troubleshooting documentation, GitHub repositories, and our discussion forum.</p>
<div class="position-relative"><h4><a id="_troubleshooting_documentation"></a>Troubleshooting documentation</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>The APM Server and some of the APM agents have troubleshooting guides:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<a href="/guide/en/apm/server/6.6/troubleshooting.html" class="ulink" target="_top">Server troubleshooting</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/java/current/trouble-shooting.html" class="ulink" target="_top">Java agent troubleshooting</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/nodejs/current/troubleshooting.html" class="ulink" target="_top">Node.js agent troubleshooting</a>
</li>
<li class="listitem">
<a href="/guide/en/apm/agent/rum-js/current/troubleshooting.html" class="ulink" target="_top">RUM troubleshooting</a>
</li>
</ul>
</div>
<div class="position-relative"><h4><a id="_github_repositories"></a>GitHub repositories</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>Elastic APM is open source! Our <a href="https://github.com/elastic?utf8=%E2%9C%93&q=apm" class="ulink" target="_top">GitHub repositories</a> have a plethora of knowledge available in the form of code, issues, and PRs.</p>
<div class="position-relative"><h4><a id="_discussion_forum"></a>Discussion forum</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/6.6/docs/guide/apm-doc-directory.asciidoc">edit</a></div>
<p>For additional questions and feature requests,
visit our <a href="https://discuss.elastic.co/c/apm" class="ulink" target="_top">discussion forum</a>.</p>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
</span>
<span class="next">
<a href="overview.html">Overview »</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>