-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathexported-fields-ecs.html
3219 lines (3198 loc) · 105 KB
/
exported-fields-ecs.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>ECS fields | APM Server Reference [7.2] | Elastic</title>
<meta class="elastic" name="content" content="ECS fields | APM Server Reference [7.2]">
<link rel="home" href="index.html" title="APM Server Reference [7.2]"/>
<link rel="up" href="exported-fields.html" title="Exported fields"/>
<link rel="prev" href="exported-fields-docker-processor.html" title="Docker fields"/>
<link rel="next" href="exported-fields-host-processor.html" title="Host fields"/>
<meta class="elastic" name="product_version" content="7.2"/>
<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.2"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.2"/>
<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="exported-fields-docker-processor.html">« Docker fields</a>
</span>
<span class="next">
<a href="exported-fields-host-processor.html">Host fields »</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="exported-fields.html">Exported fields</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>ECS fields</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.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="exported-fields-ecs"></a>ECS fields</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
</div></div></div>
<p>ECS Fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">@timestamp</code></strong></span>
</span>
</dt>
<dd>
<p>Date/time when the event originated.
This is the date/time extracted from the event, typically representing when the event was generated by the source.
If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline.
Required field for all events.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:34.853Z</p>
<p>required: True</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">labels</code></strong></span>
</span>
</dt>
<dd>
<p>Custom key/value pairs.
Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword.
Example: <code class="literal">docker</code> and <code class="literal">k8s</code> labels.</p>
<p>type: object</p>
<p>example: {<em>application</em>: <em>foo-bar</em>, <em>env</em>: <em>production</em>}</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">message</code></strong></span>
</span>
</dt>
<dd>
<p>For log events the message field contains the log message, optimized for viewing in a log viewer.
For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event.
If multiple messages exist, they can be combined into one message.</p>
<p>type: text</p>
<p>example: Hello World</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tags</code></strong></span>
</span>
</dt>
<dd>
<p>List of keywords used to tag each event.</p>
<p>type: keyword</p>
<p>example: ["production", "env2"]</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_agent"></a>agent</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host.
Examples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.ephemeral_id</code></strong></span>
</span>
</dt>
<dd>
<p>Ephemeral identifier of this agent (if one exists).
This id normally changes across restarts, but <code class="literal">agent.id</code> does not.</p>
<p>type: keyword</p>
<p>example: 8a4f500f</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier of this agent (if one exists).
Example: For Beats this would be beat.id.</p>
<p>type: keyword</p>
<p>example: 8a4f500d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.name</code></strong></span>
</span>
</dt>
<dd>
<p>Custom name of the agent.
This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from.
If no name is given, the name is often left empty.</p>
<p>type: keyword</p>
<p>example: foo</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.type</code></strong></span>
</span>
</dt>
<dd>
<p>Type of the agent.
The agent type stays always the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine.</p>
<p>type: keyword</p>
<p>example: filebeat</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.version</code></strong></span>
</span>
</dt>
<dd>
<p>Version of the agent.</p>
<p>type: keyword</p>
<p>example: 6.0.0-rc2</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_client"></a>client</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records.
For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term "originator" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the client to the server.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Client domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the client.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the client.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the client to the server.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the client.</p>
<p>type: long</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User’s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>One or multiple unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_cloud"></a>cloud</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>Fields related to the cloud or infrastructure the events are coming from.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.account.id</code></strong></span>
</span>
</dt>
<dd>
<p>The cloud account or organization id used to identify different entities in a multi-tenant environment.
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.</p>
<p>type: keyword</p>
<p>example: 666777888999</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.availability_zone</code></strong></span>
</span>
</dt>
<dd>
<p>Availability zone in which this host is running.</p>
<p>type: keyword</p>
<p>example: us-east-1c</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.instance.id</code></strong></span>
</span>
</dt>
<dd>
<p>Instance ID of the host machine.</p>
<p>type: keyword</p>
<p>example: i-1234567890abcdef0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.instance.name</code></strong></span>
</span>
</dt>
<dd>
<p>Instance name of the host machine.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.machine.type</code></strong></span>
</span>
</dt>
<dd>
<p>Machine type of the host machine.</p>
<p>type: keyword</p>
<p>example: t2.medium</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.provider</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.</p>
<p>type: keyword</p>
<p>example: aws</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.region</code></strong></span>
</span>
</dt>
<dd>
<p>Region in which this host is running.</p>
<p>type: keyword</p>
<p>example: us-east-1</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_container_2"></a>container</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>Container fields are used for meta information about the specific container that is the source of information.
These fields help correlate data based containers from any runtime.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique container id.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.image.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the image the container was built on.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.image.tag</code></strong></span>
</span>
</dt>
<dd>
<p>Container image tag.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.labels</code></strong></span>
</span>
</dt>
<dd>
<p>Image labels.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.name</code></strong></span>
</span>
</dt>
<dd>
<p>Container name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.runtime</code></strong></span>
</span>
</dt>
<dd>
<p>Runtime managing this container.</p>
<p>type: keyword</p>
<p>example: docker</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_destination"></a>destination</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>Destination fields describe details about the destination of a packet/event.
Destination fields are usually populated in conjunction with source fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the destination to the source.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Destination domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the destination.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the destination.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the destination to the source.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the destination.</p>
<p>type: long</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User’s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>One or multiple unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_ecs"></a>ecs</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>Meta-information specific to ECS.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">ecs.version</code></strong></span>
</span>
</dt>
<dd>
<p>ECS version this event conforms to. <code class="literal">ecs.version</code> is a required field and must exist in all events.
When querying across multiple indices — which may conform to slightly different ECS versions — this field lets integrations adjust to the schema version of the events.</p>
<p>type: keyword</p>
<p>example: 1.0.0</p>
<p>required: True</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_error_3"></a>error</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>These fields can represent errors of any kind.
Use them for errors that happen while fetching events or in cases where the event itself contains an error.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.code</code></strong></span>
</span>
</dt>
<dd>
<p>Error code describing the error.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the error.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.message</code></strong></span>
</span>
</dt>
<dd>
<p>Error message.</p>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_event"></a>event</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.2/docs/fields.asciidoc">edit</a></div>
<p>The event fields are used for context information about the log or metric event itself.
A log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical or categorical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host, or vulnerabilities measured on a scanned host.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.action</code></strong></span>
</span>
</dt>
<dd>
<p>The action captured by the event.
This describes the information in the event. It is more specific than <code class="literal">event.category</code>. Examples are <code class="literal">group-add</code>, <code class="literal">process-started</code>, <code class="literal">file-created</code>. The value is normally defined by the implementer.</p>
<p>type: keyword</p>
<p>example: user-password-change</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.category</code></strong></span>
</span>
</dt>
<dd>
<p>Event category.
This contains high-level information about the contents of the event. It is more generic than <code class="literal">event.action</code>, in the sense that typically a category contains multiple actions. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.</p>
<p>type: keyword</p>
<p>example: user-management</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.created</code></strong></span>
</span>
</dt>
<dd>
<p>event.created contains the date/time when the event was first read by an agent, or by your pipeline.
This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event.
In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent’s or pipeline’s ability to keep up with your event source.
In case the two timestamps are identical, @timestamp should be used.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.dataset</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the dataset.
The concept of a <code class="literal">dataset</code> (fileset / metricset) is used in Beats as a subset of modules. It contains the information which is currently stored in metricset.name and metricset.module or fileset.name.</p>
<p>type: keyword</p>
<p>example: stats</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.duration</code></strong></span>
</span>
</dt>
<dd>
<p>Duration of the event in nanoseconds.
If event.start and event.end are known this value should be the difference between the end and start time.</p>
<p>type: long</p>
<p>format: duration</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.end</code></strong></span>
</span>
</dt>
<dd>
<p>event.end contains the date when the event ended or when the activity was last observed.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.</p>
<p>type: keyword</p>
<p>example: 123456789012345678901234567890ABCD</p>
</dd>
<dt>
<span class="term">