-
Notifications
You must be signed in to change notification settings - Fork 4
/
fields.yml
3101 lines (2916 loc) · 97.8 KB
/
fields.yml
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
# WARNING! Do not edit this file directly, it was generated by the ECS project,
# based on ECS version 1.1.0.
# Please visit https://github.com/elastic/ecs to suggest changes to ECS fields.
- key: ecs
title: ECS
description: ECS Fields.
fields:
- name: '@timestamp'
level: core
required: true
type: date
description: '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.'
example: '2016-05-23T08:05:34.853Z'
- name: labels
level: core
type: object
object_type: keyword
description: '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: `docker` and `k8s` labels.'
example:
application: foo-bar
env: production
- name: message
level: core
type: text
description: '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.'
example: Hello World
- name: tags
level: core
type: keyword
ignore_above: 1024
description: List of keywords used to tag each event.
example: '["production", "env2"]'
- name: agent
title: Agent
group: 2
description: '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.'
footnote: 'Examples: In the case of Beats for logs, the agent.name is filebeat.
For APM, it is the agent running in the app/service. The agent information does
not change if data is sent through queuing systems like Kafka, Redis, or processing
systems such as Logstash or APM Server.'
type: group
fields:
- name: ephemeral_id
level: extended
type: keyword
ignore_above: 1024
description: 'Ephemeral identifier of this agent (if one exists).
This id normally changes across restarts, but `agent.id` does not.'
example: 8a4f500f
- name: id
level: core
type: keyword
ignore_above: 1024
description: 'Unique identifier of this agent (if one exists).
Example: For Beats this would be beat.id.'
example: 8a4f500d
- name: name
level: core
type: keyword
ignore_above: 1024
description: '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.'
example: foo
- name: type
level: core
type: keyword
ignore_above: 1024
description: '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.'
example: filebeat
- name: version
level: core
type: keyword
ignore_above: 1024
description: Version of the agent.
example: 6.0.0-rc2
- name: as
title: Autonomous System
group: 2
description: An autonomous system (AS) is a collection of connected Internet Protocol
(IP) routing prefixes under the control of one or more network operators on
behalf of a single administrative entity or domain that presents a common, clearly
defined routing policy to the internet.
type: group
fields:
- name: number
level: extended
type: long
description: Unique number allocated to the autonomous system. The autonomous
system number (ASN) uniquely identifies each network on the Internet.
example: 15169
- name: organization.name
level: extended
type: keyword
ignore_above: 1024
description: Organization name.
example: Google LLC
- name: client
title: Client
group: 2
description: '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.'
type: group
fields:
- name: address
level: extended
type: keyword
ignore_above: 1024
description: '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 `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which one
it is.'
- name: as.number
level: extended
type: long
description: Unique number allocated to the autonomous system. The autonomous
system number (ASN) uniquely identifies each network on the Internet.
example: 15169
- name: as.organization.name
level: extended
type: keyword
ignore_above: 1024
description: Organization name.
example: Google LLC
- name: bytes
level: core
type: long
format: bytes
description: Bytes sent from the client to the server.
example: 184
- name: domain
level: core
type: keyword
ignore_above: 1024
description: Client domain.
- name: geo.city_name
level: core
type: keyword
ignore_above: 1024
description: City name.
example: Montreal
- name: geo.continent_name
level: core
type: keyword
ignore_above: 1024
description: Name of the continent.
example: North America
- name: geo.country_iso_code
level: core
type: keyword
ignore_above: 1024
description: Country ISO code.
example: CA
- name: geo.country_name
level: core
type: keyword
ignore_above: 1024
description: Country name.
example: Canada
- name: geo.location
level: core
type: geo_point
description: Longitude and latitude.
example: '{ "lon": -73.614830, "lat": 45.505918 }'
- name: geo.name
level: extended
type: keyword
ignore_above: 1024
description: '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.'
example: boston-dc
- name: geo.region_iso_code
level: core
type: keyword
ignore_above: 1024
description: Region ISO code.
example: CA-QC
- name: geo.region_name
level: core
type: keyword
ignore_above: 1024
description: Region name.
example: Quebec
- name: ip
level: core
type: ip
description: 'IP address of the client.
Can be one or multiple IPv4 or IPv6 addresses.'
- name: mac
level: core
type: keyword
ignore_above: 1024
description: MAC address of the client.
- name: nat.ip
level: extended
type: ip
description: 'Translated IP of source based NAT sessions (e.g. internal client
to internet).
Typically connections traversing load balancers, firewalls, or routers.'
- name: nat.port
level: extended
type: long
format: string
description: 'Translated port of source based NAT sessions (e.g. internal client
to internet).
Typically connections traversing load balancers, firewalls, or routers.'
- name: packets
level: core
type: long
description: Packets sent from the client to the server.
example: 12
- name: port
level: core
type: long
format: string
description: Port of the client.
- name: user.domain
level: extended
type: keyword
ignore_above: 1024
description: 'Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.'
- name: user.email
level: extended
type: keyword
ignore_above: 1024
description: User email address.
- name: user.full_name
level: extended
type: keyword
ignore_above: 1024
description: User's full name, if available.
example: Albert Einstein
- name: user.group.id
level: extended
type: keyword
ignore_above: 1024
description: Unique identifier for the group on the system/platform.
- name: user.group.name
level: extended
type: keyword
ignore_above: 1024
description: Name of the group.
- name: user.hash
level: extended
type: keyword
ignore_above: 1024
description: 'Unique user hash to correlate information for a user in anonymized
form.
Useful if `user.id` or `user.name` contain confidential information and cannot
be used.'
- name: user.id
level: core
type: keyword
ignore_above: 1024
description: One or multiple unique identifiers of the user.
- name: user.name
level: core
type: keyword
ignore_above: 1024
description: Short name or login of the user.
example: albert
- name: cloud
title: Cloud
group: 2
description: Fields related to the cloud or infrastructure the events are coming
from.
footnote: 'Examples: If Metricbeat is running on an EC2 host and fetches data
from its host, the cloud info contains the data about this machine. If Metricbeat
runs on a remote machine outside the cloud and fetches data from a service running
in the cloud, the field contains cloud data from the machine the service is
running on.'
type: group
fields:
- name: account.id
level: extended
type: keyword
ignore_above: 1024
description: '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.'
example: 666777888999
- name: availability_zone
level: extended
type: keyword
ignore_above: 1024
description: Availability zone in which this host is running.
example: us-east-1c
- name: instance.id
level: extended
type: keyword
ignore_above: 1024
description: Instance ID of the host machine.
example: i-1234567890abcdef0
- name: instance.name
level: extended
type: keyword
ignore_above: 1024
description: Instance name of the host machine.
- name: machine.type
level: extended
type: keyword
ignore_above: 1024
description: Machine type of the host machine.
example: t2.medium
- name: provider
level: extended
type: keyword
ignore_above: 1024
description: Name of the cloud provider. Example values are aws, azure, gcp,
or digitalocean.
example: aws
- name: region
level: extended
type: keyword
ignore_above: 1024
description: Region in which this host is running.
example: us-east-1
- name: container
title: Container
group: 2
description: '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.'
type: group
fields:
- name: id
level: core
type: keyword
ignore_above: 1024
description: Unique container id.
- name: image.name
level: extended
type: keyword
ignore_above: 1024
description: Name of the image the container was built on.
- name: image.tag
level: extended
type: keyword
ignore_above: 1024
description: Container image tag.
- name: labels
level: extended
type: object
object_type: keyword
description: Image labels.
- name: name
level: extended
type: keyword
ignore_above: 1024
description: Container name.
- name: runtime
level: extended
type: keyword
ignore_above: 1024
description: Runtime managing this container.
example: docker
- name: destination
title: Destination
group: 2
description: 'Destination fields describe details about the destination of a packet/event.
Destination fields are usually populated in conjunction with source fields.'
type: group
fields:
- name: address
level: extended
type: keyword
ignore_above: 1024
description: '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 `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which one
it is.'
- name: as.number
level: extended
type: long
description: Unique number allocated to the autonomous system. The autonomous
system number (ASN) uniquely identifies each network on the Internet.
example: 15169
- name: as.organization.name
level: extended
type: keyword
ignore_above: 1024
description: Organization name.
example: Google LLC
- name: bytes
level: core
type: long
format: bytes
description: Bytes sent from the destination to the source.
example: 184
- name: domain
level: core
type: keyword
ignore_above: 1024
description: Destination domain.
- name: geo.city_name
level: core
type: keyword
ignore_above: 1024
description: City name.
example: Montreal
- name: geo.continent_name
level: core
type: keyword
ignore_above: 1024
description: Name of the continent.
example: North America
- name: geo.country_iso_code
level: core
type: keyword
ignore_above: 1024
description: Country ISO code.
example: CA
- name: geo.country_name
level: core
type: keyword
ignore_above: 1024
description: Country name.
example: Canada
- name: geo.location
level: core
type: geo_point
description: Longitude and latitude.
example: '{ "lon": -73.614830, "lat": 45.505918 }'
- name: geo.name
level: extended
type: keyword
ignore_above: 1024
description: '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.'
example: boston-dc
- name: geo.region_iso_code
level: core
type: keyword
ignore_above: 1024
description: Region ISO code.
example: CA-QC
- name: geo.region_name
level: core
type: keyword
ignore_above: 1024
description: Region name.
example: Quebec
- name: ip
level: core
type: ip
description: 'IP address of the destination.
Can be one or multiple IPv4 or IPv6 addresses.'
- name: mac
level: core
type: keyword
ignore_above: 1024
description: MAC address of the destination.
- name: nat.ip
level: extended
type: ip
description: 'Translated ip of destination based NAT sessions (e.g. internet
to private DMZ)
Typically used with load balancers, firewalls, or routers.'
- name: nat.port
level: extended
type: long
format: string
description: 'Port the source session is translated to by NAT Device.
Typically used with load balancers, firewalls, or routers.'
- name: packets
level: core
type: long
description: Packets sent from the destination to the source.
example: 12
- name: port
level: core
type: long
format: string
description: Port of the destination.
- name: user.domain
level: extended
type: keyword
ignore_above: 1024
description: 'Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.'
- name: user.email
level: extended
type: keyword
ignore_above: 1024
description: User email address.
- name: user.full_name
level: extended
type: keyword
ignore_above: 1024
description: User's full name, if available.
example: Albert Einstein
- name: user.group.id
level: extended
type: keyword
ignore_above: 1024
description: Unique identifier for the group on the system/platform.
- name: user.group.name
level: extended
type: keyword
ignore_above: 1024
description: Name of the group.
- name: user.hash
level: extended
type: keyword
ignore_above: 1024
description: 'Unique user hash to correlate information for a user in anonymized
form.
Useful if `user.id` or `user.name` contain confidential information and cannot
be used.'
- name: user.id
level: core
type: keyword
ignore_above: 1024
description: One or multiple unique identifiers of the user.
- name: user.name
level: core
type: keyword
ignore_above: 1024
description: Short name or login of the user.
example: albert
- name: dns
title: DNS
group: 2
description: 'Fields describing DNS queries and answers.
DNS events should either represent a single DNS query prior to getting answers
(`dns.type:query`) or they should represent a full exchange and contain the
query details as well as all of the answers that were provided for this query
(`dns.type:answer`).'
type: group
fields:
- name: answers
level: extended
type: object
object_type: keyword
description: 'An array containing an object for each answer section returned
by the server.
The main keys that should be present in these objects are defined by ECS.
Records that have more information may contain more keys than what ECS defines.
Not all DNS data sources give all details about DNS answers. At minimum, answer
objects must contain the `data` key. If more information is available, map
as much of it to ECS as possible, and add any additional fields to the answer
objects as custom fields.'
- name: answers.class
level: extended
type: keyword
ignore_above: 1024
description: The class of DNS data contained in this resource record.
example: IN
- name: answers.data
level: extended
type: keyword
ignore_above: 1024
description: 'The data describing the resource.
The meaning of this data depends on the type and class of the resource record.'
example: 10.10.10.10
- name: answers.name
level: extended
type: keyword
ignore_above: 1024
description: 'The domain name to which this resource record pertains.
If a chain of CNAME is being resolved, each answer''s `name` should be the
one that corresponds with the answer''s `data`. It should not simply be the
original `question.name` repeated.'
example: www.google.com
- name: answers.ttl
level: extended
type: long
description: The time interval in seconds that this resource record may be cached
before it should be discarded. Zero values mean that the data should not be
cached.
example: 180
- name: answers.type
level: extended
type: keyword
ignore_above: 1024
description: The type of data contained in this resource record.
example: CNAME
- name: header_flags
level: extended
type: keyword
ignore_above: 1024
description: 'Array of 2 letter DNS header flags.
Expected values are: AA, TC, RD, RA, AD, CD, DO.'
example:
- RD
- RA
- name: id
level: extended
type: keyword
ignore_above: 1024
description: The DNS packet identifier assigned by the program that generated
the query. The identifier is copied to the response.
example: 62111
- name: op_code
level: extended
type: keyword
ignore_above: 1024
description: The DNS operation code that specifies the kind of query in the
message. This value is set by the originator of a query and copied into the
response.
example: QUERY
- name: question.class
level: extended
type: keyword
ignore_above: 1024
description: The class of of records being queried.
example: IN
- name: question.name
level: extended
type: keyword
ignore_above: 1024
description: 'The name being queried.
If the name field contains non-printable characters (below 32 or above 126),
those characters should be represented as escaped base 10 integers (\DDD).
Back slashes and quotes should be escaped. Tabs, carriage returns, and line
feeds should be converted to \t, \r, and \n respectively.'
example: www.google.com
- name: question.registered_domain
level: extended
type: keyword
ignore_above: 1024
description: 'The highest registered domain, stripped of the subdomain.
For example, the registered domain for "foo.google.com" is "google.com".
This value can be determined precisely with a list like the public suffix
list (http://publicsuffix.org). Trying to approximate this by simply taking
the last two labels will not work well for TLDs such as "co.uk".'
example: google.com
- name: question.type
level: extended
type: keyword
ignore_above: 1024
description: The type of record being queried.
example: AAAA
- name: resolved_ip
level: extended
type: ip
description: 'Array containing all IPs seen in `answers.data`.
The `answers` array can be difficult to use, because of the variety of data
formats it can contain. Extracting all IP addresses seen in there to `dns.resolved_ip`
makes it possible to index them as IP addresses, and makes them easier to
visualize and query for.'
example:
- 10.10.10.10
- 10.10.10.11
- name: response_code
level: extended
type: keyword
ignore_above: 1024
description: The DNS response code.
example: NOERROR
- name: type
level: extended
type: keyword
ignore_above: 1024
description: 'The type of DNS event captured, query or answer.
If your source of DNS events only gives you DNS queries, you should only create
dns events of type `dns.type:query`.
If your source of DNS events gives you answers as well, you should create
one event per query (optionally as soon as the query is seen). And a second
event containing all query details as well as an array of answers.'
example: answer
- name: ecs
title: ECS
group: 2
description: Meta-information specific to ECS.
type: group
fields:
- name: version
level: core
required: true
type: keyword
ignore_above: 1024
description: 'ECS version this event conforms to. `ecs.version` 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.'
example: 1.0.0
- name: error
title: Error
group: 2
description: '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.'
type: group
fields:
- name: code
level: core
type: keyword
ignore_above: 1024
description: Error code describing the error.
- name: id
level: core
type: keyword
ignore_above: 1024
description: Unique identifier for the error.
- name: message
level: core
type: text
description: Error message.
- name: event
title: Event
group: 2
description: '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.'
type: group
fields:
- name: action
level: core
type: keyword
ignore_above: 1024
description: 'The action captured by the event.
This describes the information in the event. It is more specific than `event.category`.
Examples are `group-add`, `process-started`, `file-created`. The value is
normally defined by the implementer.'
example: user-password-change
- name: category
level: core
type: keyword
ignore_above: 1024
description: 'Event category.
This contains high-level information about the contents of the event. It is
more generic than `event.action`, 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.'
example: user-management
- name: code
level: extended
type: keyword
ignore_above: 1024
description: 'Identification code for this event, if one exists.
Some event sources use event codes to identify messages unambiguously, regardless
of message language or wording adjustments over time. An example of this is
the Windows Event ID.'
example: 4648
- name: created
level: core
type: date
description: '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.'
- name: dataset
level: core
type: keyword
ignore_above: 1024
description: 'Name of the dataset.
If an event source publishes more than one type of log or events (e.g. access
log, error log), the dataset is used to specify which one the event comes
from.
It''s recommended but not required to start the dataset name with the module
name, followed by a dot, then the dataset name.'
example: apache.access
- name: duration
level: core
type: long
format: duration
input_format: nanoseconds
output_format: asMilliseconds
output_precision: 1
description: '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.'
- name: end
level: extended
type: date
description: event.end contains the date when the event ended or when the activity
was last observed.
- name: hash
level: extended
type: keyword
ignore_above: 1024
description: Hash (perhaps logstash fingerprint) of raw field to be able to
demonstrate log integrity.
example: 123456789012345678901234567890ABCD
- name: id
level: core
type: keyword
ignore_above: 1024
description: Unique ID to describe the event.
example: 8a4f500d
- name: kind
level: extended
type: keyword
ignore_above: 1024
description: 'The kind of the event.
This gives information about what type of information the event contains,
without being specific to the contents of the event. Examples are `event`,
`state`, `alarm`. Warning: In future versions of ECS, we plan to provide a
list of acceptable values for this field, please use with caution.'
example: state
- name: module
level: core
type: keyword
ignore_above: 1024
description: 'Name of the module this data is coming from.
If your monitoring agent supports the concept of modules or plugins to process
events of a given source (e.g. Apache logs), `event.module` should contain
the name of this module.'
example: apache
- name: original
level: core
type: keyword
ignore_above: 1024
description: 'Raw text message of entire event. Used to demonstrate log integrity.
This field is not indexed and doc_values are disabled. It cannot be searched,
but it can be retrieved from `_source`.'
example: Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0|100|
worm successfully stopped|10|src=10.0.0.1 dst=2.1.2.2spt=1232
- name: outcome
level: extended
type: keyword
ignore_above: 1024
description: 'The outcome of the event.
If the event describes an action, this fields contains the outcome of that
action. Examples outcomes are `success` and `failure`. Warning: In future
versions of ECS, we plan to provide a list of acceptable values for this field,
please use with caution.'
example: success
- name: provider
level: extended
type: keyword
ignore_above: 1024
description: 'Source of the event.
Event transports such as Syslog or the Windows Event Log typically mention
the source of an event. It can be the name of the software that generated
the event (e.g. Sysmon, httpd), or of a subsystem of the operating system
(kernel, Microsoft-Windows-Security-Auditing).'
example: kernel
- name: risk_score
level: core
type: float
description: Risk score or priority of the event (e.g. security solutions).
Use your system's original value here.
- name: risk_score_norm
level: extended
type: float
description: 'Normalized risk score or priority of the event, on a scale of
0 to 100.
This is mainly useful if you use more than one system that assigns risk scores,
and you want to see a normalized value across all systems.'
- name: sequence
level: extended
type: long
format: string
description: 'Sequence number of the event.
The sequence number is a value published by some event sources, to make the
exact ordering of events unambiguous, regarless of the timestamp precision.'
- name: severity
level: core
type: long
format: string
description: Severity describes the original severity of the event. What the
different severity values mean can very different between use cases. It's
up to the implementer to make sure severities are consistent across events.
example: '7'
- name: start
level: extended
type: date
description: event.start contains the date when the event started or when the
activity was first observed.
- name: timezone
level: extended
type: keyword
ignore_above: 1024
description: 'This field should be populated when the event''s timestamp does
not include timezone information already (e.g. default Syslog timestamps).
It''s optional otherwise.
Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"),
abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00").'
- name: type
level: core
type: keyword
ignore_above: 1024
description: 'Reserved for future usage.
Please avoid using this field for user data.'
- name: file