-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathdistributed-tracing.html
1217 lines (1184 loc) · 50.9 KB
/
distributed-tracing.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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Distributed tracing | APM Overview [7.10] | Elastic</title>
<meta class="elastic" name="content" content="Distributed tracing | APM Overview [7.10]">
<link rel="home" href="index.html" title="APM Overview [7.10]"/>
<link rel="up" href="apm-features.html" title="Elastic APM features"/>
<link rel="prev" href="apm-features.html" title="Elastic APM features"/>
<link rel="next" href="rum.html" title="Real User Monitoring (RUM)"/>
<meta class="elastic" name="product_version" content="7.10"/>
<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.10"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.10"/>
<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">
<a href="apm-features.html">« Elastic APM features</a>
</span>
<span class="next">
<a href="rum.html">Real User Monitoring (RUM) »</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>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="apm-features.html">Elastic APM features</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>Distributed tracing</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.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="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="distributed-tracing"></a>Distributed tracing</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
</div></div></div>
<style>
.tabs {
width: 100%;
}
[role="tablist"] {
margin: 0 0 -0.1em;
overflow: visible;
}
[role="tab"] {
position: relative;
padding: 0.3em 0.5em 0.4em;
border: 1px solid hsl(219, 1%, 72%);
border-radius: 0.2em 0.2em 0 0;
overflow: visible;
font-family: inherit;
font-size: inherit;
background: hsl(220, 20%, 94%);
}
[role="tab"]:hover::before,
[role="tab"]:focus::before,
[role="tab"][aria-selected="true"]::before {
position: absolute;
bottom: 100%;
right: -1px;
left: -1px;
border-radius: 0.2em 0.2em 0 0;
border-top: 3px solid hsl(219, 1%, 72%);
content: '';
}
[role="tab"][aria-selected="true"] {
border-radius: 0;
background: hsl(220, 43%, 99%);
outline: 0;
}
[role="tab"][aria-selected="true"]:not(:focus):not(:hover)::before {
border-top: 5px solid hsl(218, 96%, 48%);
}
[role="tab"][aria-selected="true"]::after {
position: absolute;
z-index: 3;
bottom: -1px;
right: 0;
left: 0;
height: 0.3em;
background: hsl(220, 43%, 99%);
box-shadow: none;
content: '';
}
[role="tab"]:hover,
[role="tab"]:focus,
[role="tab"]:active {
outline: 0;
border-radius: 0;
color: inherit;
}
[role="tab"]:hover::before,
[role="tab"]:focus::before {
border-color: hsl(218, 96%, 48%);
}
[role="tabpanel"] {
position: relative;
z-index: 2;
padding: 1em;
border: 1px solid hsl(219, 1%, 72%);
border-radius: 0 0.2em 0.2em 0.2em;
box-shadow: 0 0 0.2em hsl(219, 1%, 72%);
background: hsl(220, 43%, 99%);
margin-bottom: 1em;
}
[role="tabpanel"] p {
margin: 0;
}
[role="tabpanel"] * + p {
margin-top: 1em;
}
</style>
<script>
window.addEventListener("DOMContentLoaded", () => {
const tabs = document.querySelectorAll('[role="tab"]');
const tabList = document.querySelector('[role="tablist"]');
// Add a click event handler to each tab
tabs.forEach(tab => {
tab.addEventListener("click", changeTabs);
});
// Enable arrow navigation between tabs in the tab list
let tabFocus = 0;
tabList.addEventListener("keydown", e => {
// Move right
if (e.keyCode === 39 || e.keyCode === 37) {
tabs[tabFocus].setAttribute("tabindex", -1);
if (e.keyCode === 39) {
tabFocus++;
// If we're at the end, go to the start
if (tabFocus >= tabs.length) {
tabFocus = 0;
}
// Move left
} else if (e.keyCode === 37) {
tabFocus--;
// If we're at the start, move to the end
if (tabFocus < 0) {
tabFocus = tabs.length - 1;
}
}
tabs[tabFocus].setAttribute("tabindex", 0);
tabs[tabFocus].focus();
}
});
});
function setActiveTab(target) {
const parent = target.parentNode;
const grandparent = parent.parentNode;
// console.log(grandparent);
// Remove all current selected tabs
parent
.querySelectorAll('[aria-selected="true"]')
.forEach(t => t.setAttribute("aria-selected", false));
// Set this tab as selected
target.setAttribute("aria-selected", true);
// Hide all tab panels
grandparent
.querySelectorAll('[role="tabpanel"]')
.forEach(p => p.setAttribute("hidden", true));
// Show the selected panel
grandparent.parentNode
.querySelector(`#${target.getAttribute("aria-controls")}`)
.removeAttribute("hidden");
}
function changeTabs(e) {
// get the containing list of the tab that was just clicked
const tabList = e.target.parentNode;
// get all of the sibling tabs
const buttons = Array.apply(null, tabList.querySelectorAll('button'));
// loop over the siblings to discover which index thje clicked one was
const { index } = buttons.reduce(({ found, index }, button) => {
if (!found && buttons[index] === e.target) {
return { found: true, index };
} else if (!found) {
return { found, index: index + 1 };
} else {
return { found, index };
}
}, { found: false, index: 0 });
// get the tab container
const container = tabList.parentNode;
// read the data-tab-group value from the container, e.g. "os"
const { tabGroup } = container.dataset;
// get a list of all the tab groups that match this value on the page
const groups = document.querySelectorAll('[data-tab-group=' + tabGroup + ']');
// for each of the found tab groups, find the tab button at the previously discovered index and select it for each group
groups.forEach((group) => {
const target = group.querySelectorAll('button')[index];
setActiveTab(target);
});
}
</script>
<p>A <code class="literal">trace</code> is a group of <a class="xref" href="transactions.html" title="Transactions">transactions</a> and <a class="xref" href="transaction-spans.html" title="Spans">spans</a> with a common root.
Each <code class="literal">trace</code> tracks the entirety of a single request.
When a <code class="literal">trace</code> travels through multiple services, as is common in a microservice architecture,
it is known as a distributed trace.</p>
<div class="position-relative"><h3><a id="_why_is_distributed_tracing_important"></a>Why is distributed tracing important?</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>Distributed tracing enables you to analyze performance throughout your microservice architecture
by tracing the entirety of a request — from the initial web request on your front-end service
all the way to database queries made on your back-end services.</p>
<p>Tracking requests as they propagate through your services provides an end-to-end picture of
where your application is spending time, where errors are occurring, and where bottlenecks are forming.
Distributed tracing eliminates individual service’s data silos and reveals what’s happening outside of
service borders.</p>
<p>For supported technologies, distributed tracing works out-of-the-box, with no additional configuration required.</p>
<div class="position-relative"><h3><a id="_how_distributed_tracing_works"></a>How distributed tracing works</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>Distributed tracing works by injecting a custom <code class="literal">traceparent</code> HTTP header into outgoing requests.
This header includes information, like <code class="literal">trace-id</code>, which is used to identify the current trace,
and <code class="literal">parent-id</code>, which is used to identify the parent of the current span on incoming requests
or the current span on an outgoing request.</p>
<p>When a service is working on a request, it checks for the existence of this HTTP header.
If it’s missing, the service starts a new trace.
If it exists, the service ensures the current action is added as a child of the existing trace,
and continues to propagate the trace.</p>
<div class="position-relative"><h4><a id="_trace_propagation_examples"></a>Trace propagation examples</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>In this example, Elastic’s Ruby agent communicates with Elastic’s Java agent.
Both support the <code class="literal">traceparent</code> header, and trace data is successfully propagated.</p>
<div class="imageblock">
<div class="content">
<img src="images/dt-trace-ex1.png" alt="How traceparent propagation works">
</div>
</div>
<p>In this example, Elastic’s Ruby agent communicates with OpenTelemetry’s Java agent.
Both support the <code class="literal">traceparent</code> header, and trace data is successfully propagated.</p>
<div class="imageblock">
<div class="content">
<img src="images/dt-trace-ex2.png" alt="How traceparent propagation works">
</div>
</div>
<p>In this example, the trace meets a piece of middleware that doesn’t propagate the <code class="literal">traceparent</code> header.
The distributed trace ends and any further communication will result in a new trace.</p>
<div class="imageblock">
<div class="content">
<img src="images/dt-trace-ex3.png" alt="How traceparent propagation works">
</div>
</div>
<div class="position-relative"><h4><a id="w3c-tracecontext"></a>W3C Tracecontext spec</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>All Elastic agents now support the official W3C tracecontext spec and <code class="literal">traceparent</code> header.
See the table below for the minimum required agent version:</p>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1"/>
<col class="col_2"/>
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Agent name</th>
<th align="left" valign="top">Agent Version</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>Go Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">1.6</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>Java Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">1.14</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>.NET Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">1.3</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>Node.js Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">3.4</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>Python Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">5.4</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>Ruby Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">3.5</code></p></td>
</tr>
<tr>
<td align="left" valign="top"><p><span class="strong strong"><strong>RUM Agent</strong></span></p></td>
<td align="left" valign="top"><p>≥<code class="literal">5.0</code></p></td>
</tr>
</tbody>
</table>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>Older Elastic agents use a unique <code class="literal">elastic-apm-traceparent</code> header.
For backward-compatibility purposes, new versions of Elastic agents still support this header.</p>
</div>
</div>
<div class="position-relative"><h3><a id="_visualize_distributed_tracing"></a>Visualize distributed tracing</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>The APM app’s timeline visualization provides a visual deep-dive into each of your application’s traces:</p>
<div class="imageblock screenshot">
<div class="content">
<img src="images/apm-distributed-tracing.png" alt="Distributed tracing in the APM UI">
</div>
</div>
<div class="position-relative"><h3><a id="_manual_distributed_tracing"></a>Manual distributed tracing</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>Elastic agents automatically propagate distributed tracing context for supported technologies.
If your service communicates over a different, unsupported protocol,
you can manually propagate distributed tracing context from a sending service to a receiving service
with each agent’s API.</p>
<div class="position-relative"><h4><a id="_add_the_traceparent_header_to_outgoing_requests"></a>Add the <code class="literal">traceparent</code> header to outgoing requests</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>Sending services must add the <code class="literal">traceparent</code> header to outgoing requests.</p>
<div class="tabs" data-tab-group="apm-agent-distributed-trace">
<div role="tablist" aria-label="dt">
<button role="tab"
aria-selected="false"
aria-controls="go-tab-dt"
id="go-dt">
Go
</button>
<button role="tab"
aria-selected="true"
aria-controls="java-tab-dt"
id="java-dt"
tabindex="-1">
Java
</button>
<button role="tab"
aria-selected="false"
aria-controls="net-tab-dt"
id="net-dt"
tabindex="-1">
.NET
</button>
<button role="tab"
aria-selected="false"
aria-controls="node-tab-dt"
id="node-dt"
tabindex="-1">
Node.js
</button>
<button role="tab"
aria-selected="false"
aria-controls="python-tab-dt"
id="python-dt"
tabindex="-1">
Python
</button>
<button role="tab"
aria-selected="false"
aria-controls="ruby-tab-dt"
id="ruby-dt"
tabindex="-1">
Ruby
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="go-tab-dt"
aria-labelledby="go-dt"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Start a transaction with
<a href="/guide/en/apm/agent/go/current/api.html#tracer-api-start-transaction" class="ulink" target="_top"><code class="literal">StartTransaction</code></a> or a span with
<a href="/guide/en/apm/agent/go/current/api.html#transaction-start-span" class="ulink" target="_top"><code class="literal">StartSpan</code></a>.
</li>
<li class="listitem">
Get the active TraceContext.
</li>
<li class="listitem">
Send the TraceContext to the receiving service.
</li>
</ol>
</div>
<p>Example:</p>
<div class="pre_wrapper lang-go">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-go">transaction := apm.DefaultTracer.StartTransaction("GET /", "request") <a id="CO1-1"></a><i class="conum" data-value="1"></i>
traceContext := transaction.TraceContext() <a id="CO1-2"></a><i class="conum" data-value="2"></i>
// Send TraceContext to receiving service
traceparent := apmhttp.FormatTraceparentHeader(traceContext)) <a id="CO1-3"></a><i class="conum" data-value="3"></i>
tracestate := traceContext.State.String()</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO1-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Start a transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO1-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Get TraceContext from current Transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO1-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Format the TraceContext or tracestate as a traceparent header.</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="java-tab-dt"
aria-labelledby="java-dt">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Start a transaction with <a href="/guide/en/apm/agent/java/current/public-api.html#api-start-transaction" class="ulink" target="_top"><code class="literal">startTransaction</code></a>,
or a span with <a href="/guide/en/apm/agent/java/current/public-api.html#api-span-start-span" class="ulink" target="_top"><code class="literal">startSpan</code></a>.
</li>
<li class="listitem">
Inject the <code class="literal">traceparent</code> header into the request object with
<a href="/guide/en/apm/agent/java/current/public-api.html#api-transaction-inject-trace-headers" class="ulink" target="_top"><code class="literal">injectTraceHeaders</code></a>
</li>
</ol>
</div>
<p>Example of manually instrumenting an RPC framework:</p>
<div class="pre_wrapper lang-java">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-java">// Hook into a callback provided by the RPC framework that is called on outgoing requests
public Response onOutgoingRequest(Request request) throws Exception {
Span span = ElasticApm.currentSpan() <a id="CO2-1"></a><i class="conum" data-value="1"></i>
.startSpan("external", "http", null)
.setName(request.getMethod() + " " + request.getHost());
try (final Scope scope = transaction.activate()) {
span.injectTraceHeaders((name, value) -> request.addHeader(name, value)); <a id="CO2-2"></a><i class="conum" data-value="2"></i>
return request.execute();
} catch (Exception e) {
span.captureException(e);
throw e;
} finally {
span.end(); <a id="CO2-3"></a><i class="conum" data-value="3"></i>
}
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO2-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Create a span representing an external call</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO2-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Inject the <code class="literal">traceparent</code> header into the request object</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO2-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>End the span</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="net-tab-dt"
aria-labelledby="net-dt"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Serialize the distributed tracing context of the active transaction or span with
<a href="/guide/en/apm/agent/dotnet/current/public-api.html#api-current-transaction" class="ulink" target="_top"><code class="literal">CurrentTransaction</code></a> or
<a href="/guide/en/apm/agent/dotnet/current/public-api.html#api-current-span" class="ulink" target="_top"><code class="literal">CurrentSpan</code></a>.
</li>
<li class="listitem">
Send the serialized context the receiving service.
</li>
</ol>
</div>
<p>Example:</p>
<div class="pre_wrapper lang-csharp">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-csharp">string outgoingDistributedTracingData =
(Agent.Tracer.CurrentSpan?.OutgoingDistributedTracingData
?? Agent.Tracer.CurrentTransaction?.OutgoingDistributedTracingData)?.SerializeToString();
// Now send `outgoingDistributedTracingData` to the receiving service</pre>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="node-tab-dt"
aria-labelledby="node-dt"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Start a transaction with <a href="/guide/en/apm/agent/nodejs/current/agent-api.html#apm-start-transaction" class="ulink" target="_top"><code class="literal">apm.startTransaction()</code></a>,
or a span with <a href="/guide/en/apm/agent/nodejs/current/agent-api.html#apm-start-span" class="ulink" target="_top"><code class="literal">apm.startSpan()</code></a>.
</li>
<li class="listitem">
Get the serialized <code class="literal">traceparent</code> string of the started transaction/span with
<a href="/guide/en/apm/agent/nodejs/current/agent-api.html#apm-current-traceparent" class="ulink" target="_top"><code class="literal">currentTraceparent</code></a>.
</li>
<li class="listitem">
Encode the <code class="literal">traceparent</code> and send it to the receiving service inside your regular request.
</li>
</ol>
</div>
<p>Example using raw UDP to communicate between two services, A and B:</p>
<div class="pre_wrapper lang-js">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-js">agent.startTransaction('my-service-a-transaction'); <a id="CO3-1"></a><i class="conum" data-value="1"></i>
const traceparent = agent.currentTraceparent; <a id="CO3-2"></a><i class="conum" data-value="2"></i>
sendMetadata(`traceparent: ${traceparent}\n`); <a id="CO3-3"></a><i class="conum" data-value="3"></i></pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO3-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Start a transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO3-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Get the current <code class="literal">traceparent</code></p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO3-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Send the <code class="literal">traceparent</code> as a header to service B.</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="python-tab-dt"
aria-labelledby="python-dt"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Start a transaction with <a href="/guide/en/apm/agent/python/current/api.html#client-api-begin-transaction" class="ulink" target="_top"><code class="literal">begin_transaction()</code></a>.
</li>
<li class="listitem">
Get the <code class="literal">trace_parent</code> of the active transaction.
</li>
<li class="listitem">
Send the <code class="literal">trace_parent</code> to the receiving service.
</li>
</ol>
</div>
<p>Example:</p>
<div class="pre_wrapper lang-python">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-python">client.begin_transaction('new-transaction')<a id="CO4-1"></a><i class="conum" data-value="1"></i>
elasticapm.get_trace_parent_header('new-transaction') <a id="CO4-2"></a><i class="conum" data-value="2"></i>
# Send `trace_parent_str` to another service</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO4-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Start a new transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO4-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Return the string representation of the current transaction’s TraceParent object</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="ruby-tab-dt"
aria-labelledby="ruby-dt"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Start a span with <a href="/guide/en/apm/agent/ruby/current/api.html#api-agent-with_span" class="ulink" target="_top"><code class="literal">with_span</code></a>.
</li>
<li class="listitem">
Get the active <code class="literal">TraceContext</code>.
</li>
<li class="listitem">
Send the <code class="literal">TraceContext</code> to the receiving service.
</li>
</ol>
</div>
<div class="pre_wrapper lang-ruby">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-ruby">ElasticAPM.with_span "Name" do |span| <a id="CO5-1"></a><i class="conum" data-value="1"></i>
header = span.trace_context.traceparent.to_header <a id="CO5-2"></a><i class="conum" data-value="2"></i>
# send the TraceContext Header to a receiving service...
end</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO5-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Start a span</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO5-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Get the <code class="literal">TraceContext</code></p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="position-relative"><h4><a id="_add_the_traceparent_header_to_incoming_requests"></a>Add the <code class="literal">traceparent</code> header to incoming requests</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.10/docs/guide/distributed-tracing.asciidoc">edit</a></div>
<p>Receiving services must parse the incoming <code class="literal">traceparent</code> header,
and start a new transaction or span as a child of the received context.</p>
<div class="tabs" data-tab-group="apm-agent-distributed-trace">
<div role="tablist" aria-label="dt">
<button role="tab"
aria-selected="false"
aria-controls="go-tab-dt-r"
id="go-dt-r">
Go
</button>
<button role="tab"
aria-selected="true"
aria-controls="java-tab-dt-r"
id="java-dt-r"
tabindex="-1">
Java
</button>
<button role="tab"
aria-selected="false"
aria-controls="net-tab-dt-r"
id="net-dt-r"
tabindex="-1">
.NET
</button>
<button role="tab"
aria-selected="false"
aria-controls="node-tab-dt-r"
id="node-dt-r"
tabindex="-1">
Node.js
</button>
<button role="tab"
aria-selected="false"
aria-controls="python-tab-dt-r"
id="python-dt-r"
tabindex="-1">
Python
</button>
<button role="tab"
aria-selected="false"
aria-controls="ruby-tab-dt-r"
id="ruby-dt-r"
tabindex="-1">
Ruby
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="go-tab-dt-r"
aria-labelledby="go-dt-r"
hidden="">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Parse the incoming TraceContext with
<a href="https://godoc.org/go.elastic.co/apm/module/apmhttp#ParseTraceparentHeader" class="ulink" target="_top"><code class="literal">ParseTraceparentHeader</code></a> or
<a href="https://godoc.org/go.elastic.co/apm/module/apmhttp#ParseTracestateHeader" class="ulink" target="_top"><code class="literal">ParseTracestateHeader</code></a>.
</li>
<li class="listitem">
Start a new transaction or span as a child of the incoming transaction with
<a href="/guide/en/apm/agent/go/current/api.html#tracer-api-start-transaction-options" class="ulink" target="_top"><code class="literal">StartTransactionOptions</code></a> or
<a href="/guide/en/apm/agent/go/current/api.html#transaction-start-span-options" class="ulink" target="_top"><code class="literal">StartSpanOptions</code></a>.
</li>
</ol>
</div>
<p>Example:</p>
<div class="pre_wrapper lang-go">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-go">// Receive incoming TraceContext
traceContext, _ := apmhttp.ParseTraceparentHeader(r.Header.Get("Traceparent")) <a id="CO6-1"></a><i class="conum" data-value="1"></i>
traceContext.State, _ = apmhttp.ParseTracestateHeader(r.Header["Tracestate"]...) <a id="CO6-2"></a><i class="conum" data-value="2"></i>
opts := apm.TransactionOptions{
TraceContext: traceContext, <a id="CO6-3"></a><i class="conum" data-value="3"></i>
}
transaction := apm.DefaultTracer.StartTransactionOptions("GET /", "request", opts) <a id="CO6-4"></a><i class="conum" data-value="4"></i></pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO6-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Parse the TraceParent header</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO6-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Parse the tracestate header</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO6-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Set the parent trace context</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO6-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>Start a new transaction as a child of the received TraceContext</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="java-tab-dt-r"
aria-labelledby="java-dt-r">
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Create a transaction as a child of the incoming transaction with
<a href="/guide/en/apm/agent/java/current/public-api.html#api-transaction-inject-trace-headers" class="ulink" target="_top"><code class="literal">startTransactionWithRemoteParent()</code></a>.
</li>
<li class="listitem">
Start and name the transaction with <a href="/guide/en/apm/agent/java/current/public-api.html#api-transaction-activate" class="ulink" target="_top"><code class="literal">activate()</code></a>
and <a href="/guide/en/apm/agent/java/current/public-api.html#api-set-name" class="ulink" target="_top"><code class="literal">setName()</code></a>.
</li>
</ol>
</div>
<p>Example:</p>
<div class="pre_wrapper lang-java">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-java">// Hook into a callback provided by the framework that is called on incoming requests
public Response onIncomingRequest(Request request) throws Exception {
// creates a transaction representing the server-side handling of the request
Transaction transaction = ElasticApm.startTransactionWithRemoteParent(request::getHeader, request::getHeaders); <a id="CO7-1"></a><i class="conum" data-value="1"></i>
try (final Scope scope = transaction.activate()) { <a id="CO7-2"></a><i class="conum" data-value="2"></i>
String name = "a useful name like ClassName#methodName where the request is handled";
transaction.setName(name); <a id="CO7-3"></a><i class="conum" data-value="3"></i>
transaction.setType(Transaction.TYPE_REQUEST); <a id="CO7-4"></a><i class="conum" data-value="4"></i>
return request.handle();
} catch (Exception e) {
transaction.captureException(e);
throw e;
} finally {
transaction.end(); <a id="CO7-5"></a><i class="conum" data-value="5"></i>
}
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO7-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Create a transaction as the child of a remote parent</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO7-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Activate the transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO7-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Name the transaction</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO7-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>Add a transaction type</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO7-5"><i class="conum" data-value="5"></i></a></p>
</td>
<td align="left" valign="top">
<p>Eventually, end the transaction</p>
</td>
</tr>
</table>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="net-tab-dt-r"
aria-labelledby="net-dt-r"
hidden="">
<p>Deserialize the incoming distributed tracing context, and pass it to any of the
<a href="/guide/en/apm/agent/dotnet/current/public-api.html#api-start-transaction" class="ulink" target="_top"><code class="literal">StartTransaction</code></a> or
<a href="/guide/en/apm/agent/dotnet/current/public-api.html#convenient-capture-transaction" class="ulink" target="_top"><code class="literal">CaptureTransaction</code></a> APIs — all of which have an optional <code class="literal">DistributedTracingData</code> parameter.
This will create a new transaction or span as a child of the incoming trace context.</p>
<p>Example starting a new transaction:</p>
<div class="pre_wrapper lang-csharp">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-csharp">var transaction2 = Agent.Tracer.StartTransaction("Transaction2", "TestTransaction",
DistributedTracingData.TryDeserializeFromString(serializedDistributedTracingData));</pre>
</div>
</div>
<div tabindex="0"
role="tabpanel"
id="node-tab-dt-r"