From 4c68a243b899696bc79f4dc9cfe29d4ace91f5f5 Mon Sep 17 00:00:00 2001 From: Mathieu Martin Date: Tue, 24 Nov 2020 16:23:16 -0500 Subject: [PATCH 1/4] Make all fields linkable via id 'fields-{dashed field name'} --- docs/field-details.asciidoc | 2045 ++++++++++++++++++++++------ scripts/templates/field_details.j2 | 5 +- 2 files changed, 1640 insertions(+), 410 deletions(-) diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc index ae14752657..f6ec313767 100644 --- a/docs/field-details.asciidoc +++ b/docs/field-details.asciidoc @@ -12,7 +12,10 @@ The `base` field set contains all fields which are at the root of the events. Th // =============================================================== -| @timestamp +| +[[field--timestamp]] +@timestamp + | 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. @@ -31,7 +34,10 @@ example: `2016-05-23T08:05:34.853Z` // =============================================================== -| labels +| +[[field-labels]] +labels + | Custom key/value pairs. Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword. @@ -48,7 +54,10 @@ example: `{"application": "foo-bar", "env": "production"}` // =============================================================== -| message +| +[[field-message]] +message + | 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. @@ -65,7 +74,10 @@ example: `Hello World` // =============================================================== -| tags +| +[[field-tags]] +tags + | List of keywords used to tag each event. type: keyword @@ -99,7 +111,10 @@ Examples include Beats. Agents may also run on observers. ECS agent.* fields sha // =============================================================== -| agent.build.original +| +[[field-agent-build-original]] +agent.build.original + | Extended build information for the agent. This field is intended to contain any build information that a data source may provide, no specific formatting is required. @@ -114,7 +129,10 @@ example: `metricbeat version 7.6.0 (amd64), libbeat 7.6.0 [6a23e8f8f30f5001ba344 // =============================================================== -| agent.ephemeral_id +| +[[field-agent-ephemeral-id]] +agent.ephemeral_id + | Ephemeral identifier of this agent (if one exists). This id normally changes across restarts, but `agent.id` does not. @@ -129,7 +147,10 @@ example: `8a4f500f` // =============================================================== -| agent.id +| +[[field-agent-id]] +agent.id + | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. @@ -144,7 +165,10 @@ example: `8a4f500d` // =============================================================== -| agent.name +| +[[field-agent-name]] +agent.name + | 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. @@ -161,7 +185,10 @@ example: `foo` // =============================================================== -| agent.type +| +[[field-agent-type]] +agent.type + | Type of the agent. The agent type always stays 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. @@ -176,7 +203,10 @@ example: `filebeat` // =============================================================== -| agent.version +| +[[field-agent-version]] +agent.version + | Version of the agent. type: keyword @@ -205,7 +235,10 @@ An autonomous system (AS) is a collection of connected Internet Protocol (IP) ro // =============================================================== -| as.number +| +[[field-as-number]] +as.number + | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. type: long @@ -218,7 +251,10 @@ example: `15169` // =============================================================== -| as.organization.name +| +[[field-as-organization-name]] +as.organization.name + | Organization name. type: keyword @@ -267,7 +303,10 @@ Client / server representations can add semantic context to an exchange, which i // =============================================================== -| client.address +| +[[field-client-address]] +client.address + | 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. @@ -282,7 +321,10 @@ type: keyword // =============================================================== -| client.bytes +| +[[field-client-bytes]] +client.bytes + | Bytes sent from the client to the server. type: long @@ -295,7 +337,10 @@ example: `184` // =============================================================== -| client.domain +| +[[field-client-domain]] +client.domain + | Client domain. type: keyword @@ -308,7 +353,10 @@ type: keyword // =============================================================== -| client.ip +| +[[field-client-ip]] +client.ip + | IP address of the client (IPv4 or IPv6). type: ip @@ -321,7 +369,10 @@ type: ip // =============================================================== -| client.mac +| +[[field-client-mac]] +client.mac + | MAC address of the client. type: keyword @@ -334,7 +385,10 @@ type: keyword // =============================================================== -| client.nat.ip +| +[[field-client-nat-ip]] +client.nat.ip + | Translated IP of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. @@ -349,7 +403,10 @@ type: ip // =============================================================== -| client.nat.port +| +[[field-client-nat-port]] +client.nat.port + | Translated port of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. @@ -364,7 +421,10 @@ type: long // =============================================================== -| client.packets +| +[[field-client-packets]] +client.packets + | Packets sent from the client to the server. type: long @@ -377,7 +437,10 @@ example: `12` // =============================================================== -| client.port +| +[[field-client-port]] +client.port + | Port of the client. type: long @@ -390,7 +453,10 @@ type: long // =============================================================== -| client.registered_domain +| +[[field-client-registered-domain]] +client.registered_domain + | The highest registered client domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -407,7 +473,10 @@ example: `example.com` // =============================================================== -| client.subdomain +| +[[field-client-subdomain]] +client.subdomain + | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -422,7 +491,10 @@ example: `east` // =============================================================== -| client.top_level_domain +| +[[field-client-top-level-domain]] +client.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -490,7 +562,10 @@ Fields related to the cloud or infrastructure the events are coming from. // =============================================================== -| cloud.account.id +| +[[field-cloud-account-id]] +cloud.account.id + | 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. @@ -505,7 +580,10 @@ example: `666777888999` // =============================================================== -| cloud.account.name +| +[[field-cloud-account-name]] +cloud.account.name + | The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. @@ -520,7 +598,10 @@ example: `elastic-dev` // =============================================================== -| cloud.availability_zone +| +[[field-cloud-availability-zone]] +cloud.availability_zone + | Availability zone in which this host is running. type: keyword @@ -533,7 +614,10 @@ example: `us-east-1c` // =============================================================== -| cloud.instance.id +| +[[field-cloud-instance-id]] +cloud.instance.id + | Instance ID of the host machine. type: keyword @@ -546,7 +630,10 @@ example: `i-1234567890abcdef0` // =============================================================== -| cloud.instance.name +| +[[field-cloud-instance-name]] +cloud.instance.name + | Instance name of the host machine. type: keyword @@ -559,7 +646,10 @@ type: keyword // =============================================================== -| cloud.machine.type +| +[[field-cloud-machine-type]] +cloud.machine.type + | Machine type of the host machine. type: keyword @@ -572,7 +662,10 @@ example: `t2.medium` // =============================================================== -| cloud.project.id +| +[[field-cloud-project-id]] +cloud.project.id + | The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. @@ -587,7 +680,10 @@ example: `my-project` // =============================================================== -| cloud.project.name +| +[[field-cloud-project-name]] +cloud.project.name + | The cloud project name. Examples: Google Cloud Project name, Azure Project name. @@ -602,7 +698,10 @@ example: `my project` // =============================================================== -| cloud.provider +| +[[field-cloud-provider]] +cloud.provider + | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. type: keyword @@ -615,7 +714,10 @@ example: `aws` // =============================================================== -| cloud.region +| +[[field-cloud-region]] +cloud.region + | Region in which this host is running. type: keyword @@ -644,7 +746,10 @@ These fields contain information about binary code signatures. // =============================================================== -| code_signature.exists +| +[[field-code-signature-exists]] +code_signature.exists + | Boolean to capture if a signature is present. type: boolean @@ -657,7 +762,10 @@ example: `true` // =============================================================== -| code_signature.status +| +[[field-code-signature-status]] +code_signature.status + | Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. @@ -672,7 +780,10 @@ example: `ERROR_UNTRUSTED_ROOT` // =============================================================== -| code_signature.subject_name +| +[[field-code-signature-subject-name]] +code_signature.subject_name + | Subject name of the code signer type: keyword @@ -685,7 +796,10 @@ example: `Microsoft Corporation` // =============================================================== -| code_signature.trusted +| +[[field-code-signature-trusted]] +code_signature.trusted + | Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. @@ -700,7 +814,10 @@ example: `true` // =============================================================== -| code_signature.valid +| +[[field-code-signature-valid]] +code_signature.valid + | Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. @@ -743,7 +860,10 @@ These fields help correlate data based containers from any runtime. // =============================================================== -| container.id +| +[[field-container-id]] +container.id + | Unique container id. type: keyword @@ -756,7 +876,10 @@ type: keyword // =============================================================== -| container.image.name +| +[[field-container-image-name]] +container.image.name + | Name of the image the container was built on. type: keyword @@ -769,7 +892,10 @@ type: keyword // =============================================================== -| container.image.tag +| +[[field-container-image-tag]] +container.image.tag + | Container image tags. type: keyword @@ -785,7 +911,10 @@ Note: this field should contain an array of values. // =============================================================== -| container.labels +| +[[field-container-labels]] +container.labels + | Image labels. type: object @@ -798,7 +927,10 @@ type: object // =============================================================== -| container.name +| +[[field-container-name]] +container.name + | Container name. type: keyword @@ -811,7 +943,10 @@ type: keyword // =============================================================== -| container.runtime +| +[[field-container-runtime]] +container.runtime + | Runtime managing this container. type: keyword @@ -842,7 +977,10 @@ Destination fields are usually populated in conjunction with source fields. The // =============================================================== -| destination.address +| +[[field-destination-address]] +destination.address + | 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. @@ -857,7 +995,10 @@ type: keyword // =============================================================== -| destination.bytes +| +[[field-destination-bytes]] +destination.bytes + | Bytes sent from the destination to the source. type: long @@ -870,7 +1011,10 @@ example: `184` // =============================================================== -| destination.domain +| +[[field-destination-domain]] +destination.domain + | Destination domain. type: keyword @@ -883,7 +1027,10 @@ type: keyword // =============================================================== -| destination.ip +| +[[field-destination-ip]] +destination.ip + | IP address of the destination (IPv4 or IPv6). type: ip @@ -896,7 +1043,10 @@ type: ip // =============================================================== -| destination.mac +| +[[field-destination-mac]] +destination.mac + | MAC address of the destination. type: keyword @@ -909,7 +1059,10 @@ type: keyword // =============================================================== -| destination.nat.ip +| +[[field-destination-nat-ip]] +destination.nat.ip + | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -924,7 +1077,10 @@ type: ip // =============================================================== -| destination.nat.port +| +[[field-destination-nat-port]] +destination.nat.port + | Port the source session is translated to by NAT Device. Typically used with load balancers, firewalls, or routers. @@ -939,7 +1095,10 @@ type: long // =============================================================== -| destination.packets +| +[[field-destination-packets]] +destination.packets + | Packets sent from the destination to the source. type: long @@ -952,7 +1111,10 @@ example: `12` // =============================================================== -| destination.port +| +[[field-destination-port]] +destination.port + | Port of the destination. type: long @@ -965,7 +1127,10 @@ type: long // =============================================================== -| destination.registered_domain +| +[[field-destination-registered-domain]] +destination.registered_domain + | The highest registered destination domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -982,7 +1147,10 @@ example: `example.com` // =============================================================== -| destination.subdomain +| +[[field-destination-subdomain]] +destination.subdomain + | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -997,7 +1165,10 @@ example: `east` // =============================================================== -| destination.top_level_domain +| +[[field-destination-top-level-domain]] +destination.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -1075,7 +1246,10 @@ Many operating systems refer to "shared code libraries" with different names, bu // =============================================================== -| dll.name +| +[[field-dll-name]] +dll.name + | Name of the library. This generally maps to the name of the file on disk. @@ -1090,7 +1264,10 @@ example: `kernel32.dll` // =============================================================== -| dll.path +| +[[field-dll-path]] +dll.path + | Full file path of the library. type: keyword @@ -1158,7 +1335,10 @@ DNS events should either represent a single DNS query prior to getting answers ( // =============================================================== -| dns.answers +| +[[field-dns-answers]] +dns.answers + | 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. @@ -1178,7 +1358,10 @@ Note: this field should contain an array of values. // =============================================================== -| dns.answers.class +| +[[field-dns-answers-class]] +dns.answers.class + | The class of DNS data contained in this resource record. type: keyword @@ -1191,7 +1374,10 @@ example: `IN` // =============================================================== -| dns.answers.data +| +[[field-dns-answers-data]] +dns.answers.data + | The data describing the resource. The meaning of this data depends on the type and class of the resource record. @@ -1206,7 +1392,10 @@ example: `10.10.10.10` // =============================================================== -| dns.answers.name +| +[[field-dns-answers-name]] +dns.answers.name + | 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. @@ -1221,7 +1410,10 @@ example: `www.example.com` // =============================================================== -| dns.answers.ttl +| +[[field-dns-answers-ttl]] +dns.answers.ttl + | 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. type: long @@ -1234,7 +1426,10 @@ example: `180` // =============================================================== -| dns.answers.type +| +[[field-dns-answers-type]] +dns.answers.type + | The type of data contained in this resource record. type: keyword @@ -1247,7 +1442,10 @@ example: `CNAME` // =============================================================== -| dns.header_flags +| +[[field-dns-header-flags]] +dns.header_flags + | Array of 2 letter DNS header flags. Expected values are: AA, TC, RD, RA, AD, CD, DO. @@ -1265,7 +1463,10 @@ example: `["RD", "RA"]` // =============================================================== -| dns.id +| +[[field-dns-id]] +dns.id + | The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response. type: keyword @@ -1278,7 +1479,10 @@ example: `62111` // =============================================================== -| dns.op_code +| +[[field-dns-op-code]] +dns.op_code + | 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. type: keyword @@ -1291,7 +1495,10 @@ example: `QUERY` // =============================================================== -| dns.question.class +| +[[field-dns-question-class]] +dns.question.class + | The class of records being queried. type: keyword @@ -1304,7 +1511,10 @@ example: `IN` // =============================================================== -| dns.question.name +| +[[field-dns-question-name]] +dns.question.name + | 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. @@ -1319,7 +1529,10 @@ example: `www.example.com` // =============================================================== -| dns.question.registered_domain +| +[[field-dns-question-registered-domain]] +dns.question.registered_domain + | The highest registered domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -1336,7 +1549,10 @@ example: `example.com` // =============================================================== -| dns.question.subdomain +| +[[field-dns-question-subdomain]] +dns.question.subdomain + | The subdomain is all of the labels under the registered_domain. If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -1351,7 +1567,10 @@ example: `www` // =============================================================== -| dns.question.top_level_domain +| +[[field-dns-question-top-level-domain]] +dns.question.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -1366,7 +1585,10 @@ example: `co.uk` // =============================================================== -| dns.question.type +| +[[field-dns-question-type]] +dns.question.type + | The type of record being queried. type: keyword @@ -1379,7 +1601,10 @@ example: `AAAA` // =============================================================== -| dns.resolved_ip +| +[[field-dns-resolved-ip]] +dns.resolved_ip + | 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. @@ -1397,7 +1622,10 @@ example: `["10.10.10.10", "10.10.10.11"]` // =============================================================== -| dns.response_code +| +[[field-dns-response-code]] +dns.response_code + | The DNS response code. type: keyword @@ -1410,7 +1638,10 @@ example: `NOERROR` // =============================================================== -| dns.type +| +[[field-dns-type]] +dns.type + | 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`. @@ -1443,7 +1674,10 @@ Meta-information specific to ECS. // =============================================================== -| ecs.version +| +[[field-ecs-version]] +ecs.version + | 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. @@ -1476,7 +1710,10 @@ Use them for errors that happen while fetching events or in cases where the even // =============================================================== -| error.code +| +[[field-error-code]] +error.code + | Error code describing the error. type: keyword @@ -1489,7 +1726,10 @@ type: keyword // =============================================================== -| error.id +| +[[field-error-id]] +error.id + | Unique identifier for the error. type: keyword @@ -1502,7 +1742,10 @@ type: keyword // =============================================================== -| error.message +| +[[field-error-message]] +error.message + | Error message. type: text @@ -1515,7 +1758,10 @@ type: text // =============================================================== -| error.stack_trace +| +[[field-error-stack-trace]] +error.stack_trace + | The stack trace of this error in plain text. type: keyword @@ -1534,7 +1780,10 @@ Multi-fields: // =============================================================== -| error.type +| +[[field-error-type]] +error.type + | The type of the error, for example the class name of the exception. type: keyword @@ -1565,7 +1814,10 @@ A log is defined as an event containing details of something that happened. Log // =============================================================== -| event.action +| +[[field-event-action]] +event.action + | 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. @@ -1580,7 +1832,10 @@ example: `user-password-change` // =============================================================== -| event.category +| +[[field-event-category]] +event.category + | This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. `event.category` represents the "big buckets" of ECS categories. For example, filtering on `event.category:process` yields all events relating to process activity. This field is closely related to `event.type`, which is used as a subcategory. @@ -1607,7 +1862,10 @@ To learn more about when to use which value, visit the page // =============================================================== -| event.code +| +[[field-event-code]] +event.code + | 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. @@ -1622,7 +1880,10 @@ example: `4648` // =============================================================== -| event.created +| +[[field-event-created]] +event.created + | 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. @@ -1641,7 +1902,10 @@ example: `2016-05-23T08:05:34.857Z` // =============================================================== -| event.dataset +| +[[field-event-dataset]] +event.dataset + | 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. @@ -1658,7 +1922,10 @@ example: `apache.access` // =============================================================== -| event.duration +| +[[field-event-duration]] +event.duration + | 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. @@ -1673,7 +1940,10 @@ type: long // =============================================================== -| event.end +| +[[field-event-end]] +event.end + | event.end contains the date when the event ended or when the activity was last observed. type: date @@ -1686,7 +1956,10 @@ type: date // =============================================================== -| event.hash +| +[[field-event-hash]] +event.hash + | Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity. type: keyword @@ -1699,7 +1972,10 @@ example: `123456789012345678901234567890ABCD` // =============================================================== -| event.id +| +[[field-event-id]] +event.id + | Unique ID to describe the event. type: keyword @@ -1712,7 +1988,10 @@ example: `8a4f500d` // =============================================================== -| event.ingested +| +[[field-event-ingested]] +event.ingested + | Timestamp when an event arrived in the central data store. This is different from `@timestamp`, which is when the event originally occurred. It's also different from `event.created`, which is meant to capture the first time an agent saw the event. @@ -1729,7 +2008,10 @@ example: `2016-05-23T08:05:35.101Z` // =============================================================== -| event.kind +| +[[field-event-kind]] +event.kind + | This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. `event.kind` gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. @@ -1753,7 +2035,10 @@ To learn more about when to use which value, visit the page // =============================================================== -| event.module +| +[[field-event-module]] +event.module + | 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. @@ -1768,7 +2053,10 @@ example: `apache` // =============================================================== -| event.original +| +[[field-event-original]] +event.original + | 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`. @@ -1783,7 +2071,10 @@ example: `Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0& // =============================================================== -| event.outcome +| +[[field-event-outcome]] +event.outcome + | This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. `event.outcome` simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. @@ -1811,7 +2102,10 @@ To learn more about when to use which value, visit the page // =============================================================== -| event.provider +| +[[field-event-provider]] +event.provider + | 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). @@ -1826,7 +2120,10 @@ example: `kernel` // =============================================================== -| event.reason +| +[[field-event-reason]] +event.reason + | Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where `event.action` captures the action from the event, `event.reason` describes why that action was taken. For example, a web proxy with an `event.action` which denied the request may also populate `event.reason` with the reason why (e.g. `blocked site`). @@ -1841,7 +2138,10 @@ example: `Terminated an unexpected process` // =============================================================== -| event.reference +| +[[field-event-reference]] +event.reference + | Reference URL linking to additional information about this event. This URL links to a static definition of the this event. Alert events, indicated by `event.kind:alert`, are a common use case for this field. @@ -1856,7 +2156,10 @@ example: `https://system.example.com/event/#0001234` // =============================================================== -| event.risk_score +| +[[field-event-risk-score]] +event.risk_score + | Risk score or priority of the event (e.g. security solutions). Use your system's original value here. type: float @@ -1869,7 +2172,10 @@ type: float // =============================================================== -| event.risk_score_norm +| +[[field-event-risk-score-norm]] +event.risk_score_norm + | 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. @@ -1884,7 +2190,10 @@ type: float // =============================================================== -| event.sequence +| +[[field-event-sequence]] +event.sequence + | Sequence number of the event. The sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regardless of the timestamp precision. @@ -1899,7 +2208,10 @@ type: long // =============================================================== -| event.severity +| +[[field-event-severity]] +event.severity + | The numeric severity of the event according to your event source. What the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source. @@ -1916,7 +2228,10 @@ example: `7` // =============================================================== -| event.start +| +[[field-event-start]] +event.start + | event.start contains the date when the event started or when the activity was first observed. type: date @@ -1929,7 +2244,10 @@ type: date // =============================================================== -| event.timezone +| +[[field-event-timezone]] +event.timezone + | 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"). @@ -1944,7 +2262,10 @@ type: keyword // =============================================================== -| event.type +| +[[field-event-type]] +event.type + | This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. `event.type` represents a categorization "sub-bucket" that, when used along with the `event.category` field values, enables filtering events down to a level appropriate for single visualization. @@ -1971,7 +2292,10 @@ To learn more about when to use which value, visit the page // =============================================================== -| event.url +| +[[field-event-url]] +event.url + | URL linking to an external system to continue investigation of this event. This URL links to another system where in-depth investigation of the specific occurrence of this event can take place. Alert events, indicated by `event.kind:alert`, are a common use case for this field. @@ -2004,7 +2328,10 @@ File objects can be associated with host events, network events, and/or file eve // =============================================================== -| file.accessed +| +[[field-file-accessed]] +file.accessed + | Last time the file was accessed. Note that not all filesystems keep track of access time. @@ -2019,7 +2346,10 @@ type: date // =============================================================== -| file.attributes +| +[[field-file-attributes]] +file.attributes + | Array of file attributes. Attributes names will vary by platform. Here's a non-exhaustive list of values that are expected in this field: archive, compressed, directory, encrypted, execute, hidden, read, readonly, system, write. @@ -2037,7 +2367,10 @@ example: `["readonly", "system"]` // =============================================================== -| file.created +| +[[field-file-created]] +file.created + | File creation time. Note that not all filesystems store the creation time. @@ -2052,7 +2385,10 @@ type: date // =============================================================== -| file.ctime +| +[[field-file-ctime]] +file.ctime + | Last time the file attributes or metadata changed. Note that changes to the file content will update `mtime`. This implies `ctime` will be adjusted at the same time, since `mtime` is an attribute of the file. @@ -2067,7 +2403,10 @@ type: date // =============================================================== -| file.device +| +[[field-file-device]] +file.device + | Device that is the source of the file. type: keyword @@ -2080,7 +2419,10 @@ example: `sda` // =============================================================== -| file.directory +| +[[field-file-directory]] +file.directory + | Directory where the file is located. It should include the drive letter, when appropriate. type: keyword @@ -2093,7 +2435,10 @@ example: `/home/alice` // =============================================================== -| file.drive_letter +| +[[field-file-drive-letter]] +file.drive_letter + | Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon. @@ -2108,7 +2453,10 @@ example: `C` // =============================================================== -| file.extension +| +[[field-file-extension]] +file.extension + | File extension, excluding the leading dot. Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). @@ -2123,7 +2471,10 @@ example: `png` // =============================================================== -| file.gid +| +[[field-file-gid]] +file.gid + | Primary group ID (GID) of the file. type: keyword @@ -2136,7 +2487,10 @@ example: `1001` // =============================================================== -| file.group +| +[[field-file-group]] +file.group + | Primary group name of the file. type: keyword @@ -2149,7 +2503,10 @@ example: `alice` // =============================================================== -| file.inode +| +[[field-file-inode]] +file.inode + | Inode representing the file in the filesystem. type: keyword @@ -2162,7 +2519,10 @@ example: `256383` // =============================================================== -| file.mime_type +| +[[field-file-mime-type]] +file.mime_type + | MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. type: keyword @@ -2175,7 +2535,10 @@ type: keyword // =============================================================== -| file.mode +| +[[field-file-mode]] +file.mode + | Mode of the file in octal representation. type: keyword @@ -2188,7 +2551,10 @@ example: `0640` // =============================================================== -| file.mtime +| +[[field-file-mtime]] +file.mtime + | Last time the file content was modified. type: date @@ -2201,7 +2567,10 @@ type: date // =============================================================== -| file.name +| +[[field-file-name]] +file.name + | Name of the file including the extension, without the directory. type: keyword @@ -2214,7 +2583,10 @@ example: `example.png` // =============================================================== -| file.owner +| +[[field-file-owner]] +file.owner + | File owner's username. type: keyword @@ -2227,7 +2599,10 @@ example: `alice` // =============================================================== -| file.path +| +[[field-file-path]] +file.path + | Full path to the file, including the file name. It should include the drive letter, when appropriate. type: keyword @@ -2246,7 +2621,10 @@ example: `/home/alice/example.png` // =============================================================== -| file.size +| +[[field-file-size]] +file.size + | File size in bytes. Only relevant when `file.type` is "file". @@ -2261,7 +2639,10 @@ example: `16384` // =============================================================== -| file.target_path +| +[[field-file-target-path]] +file.target_path + | Target path for symlinks. type: keyword @@ -2280,7 +2661,10 @@ Multi-fields: // =============================================================== -| file.type +| +[[field-file-type]] +file.type + | File type (file, dir, or symlink). type: keyword @@ -2293,7 +2677,10 @@ example: `file` // =============================================================== -| file.uid +| +[[field-file-uid]] +file.uid + | The user ID (UID) or security identifier (SID) of the file owner. type: keyword @@ -2367,7 +2754,10 @@ This geolocation information can be derived from techniques such as Geo IP, or b // =============================================================== -| geo.city_name +| +[[field-geo-city-name]] +geo.city_name + | City name. type: keyword @@ -2380,7 +2770,10 @@ example: `Montreal` // =============================================================== -| geo.continent_name +| +[[field-geo-continent-name]] +geo.continent_name + | Name of the continent. type: keyword @@ -2393,7 +2786,10 @@ example: `North America` // =============================================================== -| geo.country_iso_code +| +[[field-geo-country-iso-code]] +geo.country_iso_code + | Country ISO code. type: keyword @@ -2406,7 +2802,10 @@ example: `CA` // =============================================================== -| geo.country_name +| +[[field-geo-country-name]] +geo.country_name + | Country name. type: keyword @@ -2419,7 +2818,10 @@ example: `Canada` // =============================================================== -| geo.location +| +[[field-geo-location]] +geo.location + | Longitude and latitude. type: geo_point @@ -2432,7 +2834,10 @@ example: `{ "lon": -73.614830, "lat": 45.505918 }` // =============================================================== -| geo.name +| +[[field-geo-name]] +geo.name + | 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. @@ -2449,7 +2854,10 @@ example: `boston-dc` // =============================================================== -| geo.region_iso_code +| +[[field-geo-region-iso-code]] +geo.region_iso_code + | Region ISO code. type: keyword @@ -2462,7 +2870,10 @@ example: `CA-QC` // =============================================================== -| geo.region_name +| +[[field-geo-region-name]] +geo.region_name + | Region name. type: keyword @@ -2501,7 +2912,10 @@ The group fields are meant to represent groups that are relevant to the event. // =============================================================== -| group.domain +| +[[field-group-domain]] +group.domain + | Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. @@ -2516,7 +2930,10 @@ type: keyword // =============================================================== -| group.id +| +[[field-group-id]] +group.id + | Unique identifier for the group on the system/platform. type: keyword @@ -2529,7 +2946,10 @@ type: keyword // =============================================================== -| group.name +| +[[field-group-name]] +group.name + | Name of the group. type: keyword @@ -2570,7 +2990,10 @@ Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for ot // =============================================================== -| hash.md5 +| +[[field-hash-md5]] +hash.md5 + | MD5 hash. type: keyword @@ -2583,7 +3006,10 @@ type: keyword // =============================================================== -| hash.sha1 +| +[[field-hash-sha1]] +hash.sha1 + | SHA1 hash. type: keyword @@ -2596,7 +3022,10 @@ type: keyword // =============================================================== -| hash.sha256 +| +[[field-hash-sha256]] +hash.sha256 + | SHA256 hash. type: keyword @@ -2609,7 +3038,10 @@ type: keyword // =============================================================== -| hash.sha512 +| +[[field-hash-sha512]] +hash.sha512 + | SHA512 hash. type: keyword @@ -2650,7 +3082,10 @@ ECS host.* fields should be populated with details about the host on which the e // =============================================================== -| host.architecture +| +[[field-host-architecture]] +host.architecture + | Operating system architecture. type: keyword @@ -2663,7 +3098,10 @@ example: `x86_64` // =============================================================== -| host.domain +| +[[field-host-domain]] +host.domain + | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. @@ -2678,7 +3116,10 @@ example: `CONTOSO` // =============================================================== -| host.hostname +| +[[field-host-hostname]] +host.hostname + | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. @@ -2693,7 +3134,10 @@ type: keyword // =============================================================== -| host.id +| +[[field-host-id]] +host.id + | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. @@ -2710,7 +3154,10 @@ type: keyword // =============================================================== -| host.ip +| +[[field-host-ip]] +host.ip + | Host ip addresses. type: ip @@ -2726,7 +3173,10 @@ Note: this field should contain an array of values. // =============================================================== -| host.mac +| +[[field-host-mac]] +host.mac + | Host mac addresses. type: keyword @@ -2742,7 +3192,10 @@ Note: this field should contain an array of values. // =============================================================== -| host.name +| +[[field-host-name]] +host.name + | Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. @@ -2757,7 +3210,10 @@ type: keyword // =============================================================== -| host.type +| +[[field-host-type]] +host.type + | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. @@ -2772,7 +3228,10 @@ type: keyword // =============================================================== -| host.uptime +| +[[field-host-uptime]] +host.uptime + | Seconds the host has been up. type: long @@ -2838,7 +3297,10 @@ Fields related to HTTP activity. Use the `url` field set to store the url of the // =============================================================== -| http.request.body.bytes +| +[[field-http-request-body-bytes]] +http.request.body.bytes + | Size in bytes of the request body. type: long @@ -2851,7 +3313,10 @@ example: `887` // =============================================================== -| http.request.body.content +| +[[field-http-request-body-content]] +http.request.body.content + | The full HTTP request body. type: keyword @@ -2870,7 +3335,10 @@ example: `Hello world` // =============================================================== -| http.request.bytes +| +[[field-http-request-bytes]] +http.request.bytes + | Total size in bytes of the request (body and headers). type: long @@ -2883,7 +3351,10 @@ example: `1437` // =============================================================== -| http.request.method +| +[[field-http-request-method]] +http.request.method + | HTTP request method. Prior to ECS 1.6.0 the following guidance was provided: @@ -2902,7 +3373,10 @@ example: `GET, POST, PUT, PoST` // =============================================================== -| http.request.mime_type +| +[[field-http-request-mime-type]] +http.request.mime_type + | Mime type of the body of the request. This value must only be populated based on the content of the request body, not on the `Content-Type` header. Comparing the mime type of a request with the request's Content-Type header can be helpful in detecting threats or misconfigured clients. @@ -2917,7 +3391,10 @@ example: `image/gif` // =============================================================== -| http.request.referrer +| +[[field-http-request-referrer]] +http.request.referrer + | Referrer for this HTTP request. type: keyword @@ -2930,7 +3407,10 @@ example: `https://blog.example.com/` // =============================================================== -| http.response.body.bytes +| +[[field-http-response-body-bytes]] +http.response.body.bytes + | Size in bytes of the response body. type: long @@ -2943,7 +3423,10 @@ example: `887` // =============================================================== -| http.response.body.content +| +[[field-http-response-body-content]] +http.response.body.content + | The full HTTP response body. type: keyword @@ -2962,7 +3445,10 @@ example: `Hello world` // =============================================================== -| http.response.bytes +| +[[field-http-response-bytes]] +http.response.bytes + | Total size in bytes of the response (body and headers). type: long @@ -2975,7 +3461,10 @@ example: `1437` // =============================================================== -| http.response.mime_type +| +[[field-http-response-mime-type]] +http.response.mime_type + | Mime type of the body of the response. This value must only be populated based on the content of the response body, not on the `Content-Type` header. Comparing the mime type of a response with the response's Content-Type header can be helpful in detecting misconfigured servers. @@ -2990,7 +3479,10 @@ example: `image/gif` // =============================================================== -| http.response.status_code +| +[[field-http-response-status-code]] +http.response.status_code + | HTTP response status code. type: long @@ -3003,7 +3495,10 @@ example: `404` // =============================================================== -| http.version +| +[[field-http-version]] +http.version + | HTTP version. type: keyword @@ -3032,7 +3527,10 @@ The interface fields are used to record ingress and egress interface information // =============================================================== -| interface.alias +| +[[field-interface-alias]] +interface.alias + | Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. type: keyword @@ -3045,7 +3543,10 @@ example: `outside` // =============================================================== -| interface.id +| +[[field-interface-id]] +interface.id + | Interface ID as reported by an observer (typically SNMP interface ID). type: keyword @@ -3058,7 +3559,10 @@ example: `10` // =============================================================== -| interface.name +| +[[field-interface-name]] +interface.name + | Interface name as reported by the system. type: keyword @@ -3101,7 +3605,10 @@ The details specific to your event source are typically not logged under `log.*` // =============================================================== -| log.file.path +| +[[field-log-file-path]] +log.file.path + | Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn't read from a log file, do not populate this field. @@ -3116,7 +3623,10 @@ example: `/var/log/fun-times.log` // =============================================================== -| log.level +| +[[field-log-level]] +log.level + | Original log level of the log event. If the source of the event provides a log level or textual severity, this is the one that goes in `log.level`. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity). @@ -3133,7 +3643,10 @@ example: `error` // =============================================================== -| log.logger +| +[[field-log-logger]] +log.logger + | The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name. type: keyword @@ -3146,7 +3659,10 @@ example: `org.elasticsearch.bootstrap.Bootstrap` // =============================================================== -| log.origin.file.line +| +[[field-log-origin-file-line]] +log.origin.file.line + | The line number of the file containing the source code which originated the log event. type: integer @@ -3159,7 +3675,10 @@ example: `42` // =============================================================== -| log.origin.file.name +| +[[field-log-origin-file-name]] +log.origin.file.name + | The name of the file containing the source code which originated the log event. Note that this field is not meant to capture the log file. The correct field to capture the log file is `log.file.path`. @@ -3174,7 +3693,10 @@ example: `Bootstrap.java` // =============================================================== -| log.origin.function +| +[[field-log-origin-function]] +log.origin.function + | The name of the function or method which originated the log event. type: keyword @@ -3187,7 +3709,10 @@ example: `init` // =============================================================== -| log.original +| +[[field-log-original]] +log.original + | This is the original log message and contains the full log message before splitting it up in multiple parts. In contrast to the `message` field which can contain an extracted part of the log message, this field contains the original, full log message. It can have already some modifications applied like encoding or new lines removed to clean up the log message. @@ -3204,7 +3729,10 @@ example: `Sep 19 08:26:10 localhost My log` // =============================================================== -| log.syslog +| +[[field-log-syslog]] +log.syslog + | The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164. type: object @@ -3217,7 +3745,10 @@ type: object // =============================================================== -| log.syslog.facility.code +| +[[field-log-syslog-facility-code]] +log.syslog.facility.code + | The Syslog numeric facility of the log event, if available. According to RFCs 5424 and 3164, this value should be an integer between 0 and 23. @@ -3232,7 +3763,10 @@ example: `23` // =============================================================== -| log.syslog.facility.name +| +[[field-log-syslog-facility-name]] +log.syslog.facility.name + | The Syslog text-based facility of the log event, if available. type: keyword @@ -3245,7 +3779,10 @@ example: `local7` // =============================================================== -| log.syslog.priority +| +[[field-log-syslog-priority]] +log.syslog.priority + | Syslog numeric priority of the event, if available. According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191. @@ -3260,7 +3797,10 @@ example: `135` // =============================================================== -| log.syslog.severity.code +| +[[field-log-syslog-severity-code]] +log.syslog.severity.code + | The Syslog numeric severity of the log event, if available. If the event source publishing via Syslog provides a different numeric severity value (e.g. firewall, IDS), your source's numeric severity should go to `event.severity`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `event.severity`. @@ -3275,7 +3815,10 @@ example: `3` // =============================================================== -| log.syslog.severity.name +| +[[field-log-syslog-severity-name]] +log.syslog.severity.name + | The Syslog numeric severity of the log event, if available. If the event source publishing via Syslog provides a different severity value (e.g. firewall, IDS), your source's text severity should go to `log.level`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `log.level`. @@ -3308,7 +3851,10 @@ The network.* fields should be populated with details about the network activity // =============================================================== -| network.application +| +[[field-network-application]] +network.application + | A name given to an application level protocol. This can be arbitrarily assigned for things like microservices, but also apply to things like skype, icq, facebook, twitter. This would be used in situations where the vendor or service can be decoded such as from the source/dest IP owners, ports, or wire format. The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS". @@ -3323,7 +3869,10 @@ example: `aim` // =============================================================== -| network.bytes +| +[[field-network-bytes]] +network.bytes + | Total bytes transferred in both directions. If `source.bytes` and `destination.bytes` are known, `network.bytes` is their sum. @@ -3338,7 +3887,10 @@ example: `368` // =============================================================== -| network.community_id +| +[[field-network-community-id]] +network.community_id + | A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. Learn more at https://github.com/corelight/community-id-spec. @@ -3353,7 +3905,10 @@ example: `1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=` // =============================================================== -| network.direction +| +[[field-network-direction]] +network.direction + | Direction of the network traffic. Recommended values are: @@ -3390,7 +3945,10 @@ example: `inbound` // =============================================================== -| network.forwarded_ip +| +[[field-network-forwarded-ip]] +network.forwarded_ip + | Host IP address when the source IP address is the proxy. type: ip @@ -3403,7 +3961,10 @@ example: `192.1.1.2` // =============================================================== -| network.iana_number +| +[[field-network-iana-number]] +network.iana_number + | IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number. type: keyword @@ -3416,7 +3977,10 @@ example: `6` // =============================================================== -| network.inner +| +[[field-network-inner]] +network.inner + | Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.) type: object @@ -3429,7 +3993,10 @@ type: object // =============================================================== -| network.name +| +[[field-network-name]] +network.name + | Name given by operators to sections of their network. type: keyword @@ -3442,7 +4009,10 @@ example: `Guest Wifi` // =============================================================== -| network.packets +| +[[field-network-packets]] +network.packets + | Total packets transferred in both directions. If `source.packets` and `destination.packets` are known, `network.packets` is their sum. @@ -3457,7 +4027,10 @@ example: `24` // =============================================================== -| network.protocol +| +[[field-network-protocol]] +network.protocol + | L7 Network protocol name. ex. http, lumberjack, transport protocol. The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS". @@ -3472,7 +4045,10 @@ example: `http` // =============================================================== -| network.transport +| +[[field-network-transport]] +network.transport + | Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS". @@ -3487,7 +4063,10 @@ example: `tcp` // =============================================================== -| network.type +| +[[field-network-type]] +network.type + | In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS". @@ -3551,7 +4130,10 @@ This could be a custom hardware appliance or a server that has been configured t // =============================================================== -| observer.egress +| +[[field-observer-egress]] +observer.egress + | Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. type: object @@ -3564,7 +4146,10 @@ type: object // =============================================================== -| observer.egress.zone +| +[[field-observer-egress-zone]] +observer.egress.zone + | Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. type: keyword @@ -3577,7 +4162,10 @@ example: `Public_Internet` // =============================================================== -| observer.hostname +| +[[field-observer-hostname]] +observer.hostname + | Hostname of the observer. type: keyword @@ -3590,7 +4178,10 @@ type: keyword // =============================================================== -| observer.ingress +| +[[field-observer-ingress]] +observer.ingress + | Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. type: object @@ -3603,7 +4194,10 @@ type: object // =============================================================== -| observer.ingress.zone +| +[[field-observer-ingress-zone]] +observer.ingress.zone + | Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc. type: keyword @@ -3616,7 +4210,10 @@ example: `DMZ` // =============================================================== -| observer.ip +| +[[field-observer-ip]] +observer.ip + | IP addresses of the observer. type: ip @@ -3632,7 +4229,10 @@ Note: this field should contain an array of values. // =============================================================== -| observer.mac +| +[[field-observer-mac]] +observer.mac + | MAC addresses of the observer type: keyword @@ -3648,7 +4248,10 @@ Note: this field should contain an array of values. // =============================================================== -| observer.name +| +[[field-observer-name]] +observer.name + | Custom name of the observer. This is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization. @@ -3665,7 +4268,10 @@ example: `1_proxySG` // =============================================================== -| observer.product +| +[[field-observer-product]] +observer.product + | The product name of the observer. type: keyword @@ -3678,7 +4284,10 @@ example: `s200` // =============================================================== -| observer.serial_number +| +[[field-observer-serial-number]] +observer.serial_number + | Observer serial number. type: keyword @@ -3691,7 +4300,10 @@ type: keyword // =============================================================== -| observer.type +| +[[field-observer-type]] +observer.type + | The type of the observer the data is coming from. There is no predefined list of observer types. Some examples are `forwarder`, `firewall`, `ids`, `ips`, `proxy`, `poller`, `sensor`, `APM server`. @@ -3706,7 +4318,10 @@ example: `firewall` // =============================================================== -| observer.vendor +| +[[field-observer-vendor]] +observer.vendor + | Vendor name of the observer. type: keyword @@ -3719,7 +4334,10 @@ example: `Symantec` // =============================================================== -| observer.version +| +[[field-observer-version]] +observer.version + | Observer version. type: keyword @@ -3805,7 +4423,10 @@ These fields help you arrange or filter data stored in an index by one or multip // =============================================================== -| organization.id +| +[[field-organization-id]] +organization.id + | Unique identifier for the organization. type: keyword @@ -3818,7 +4439,10 @@ type: keyword // =============================================================== -| organization.name +| +[[field-organization-name]] +organization.name + | Organization name. type: keyword @@ -3853,7 +4477,10 @@ The OS fields contain information about the operating system. // =============================================================== -| os.family +| +[[field-os-family]] +os.family + | OS family (such as redhat, debian, freebsd, windows). type: keyword @@ -3866,7 +4493,10 @@ example: `debian` // =============================================================== -| os.full +| +[[field-os-full]] +os.full + | Operating system name, including the version or code name. type: keyword @@ -3885,7 +4515,10 @@ example: `Mac OS Mojave` // =============================================================== -| os.kernel +| +[[field-os-kernel]] +os.kernel + | Operating system kernel version as a raw string. type: keyword @@ -3898,7 +4531,10 @@ example: `4.4.0-112-generic` // =============================================================== -| os.name +| +[[field-os-name]] +os.name + | Operating system name, without the version. type: keyword @@ -3917,7 +4553,10 @@ example: `Mac OS X` // =============================================================== -| os.platform +| +[[field-os-platform]] +os.platform + | Operating system platform (such centos, ubuntu, windows). type: keyword @@ -3930,7 +4569,10 @@ example: `darwin` // =============================================================== -| os.type +| +[[field-os-type]] +os.type + | Use the `os.type` field to categorize the operating system into one of the broad commercial families. One of these following values should be used (lowercase): linux, macos, unix, windows. @@ -3947,7 +4589,10 @@ example: `macos` // =============================================================== -| os.version +| +[[field-os-version]] +os.version + | Operating system version as a raw string. type: keyword @@ -3986,7 +4631,10 @@ These fields contain information about an installed software package. It contain // =============================================================== -| package.architecture +| +[[field-package-architecture]] +package.architecture + | Package architecture. type: keyword @@ -3999,7 +4647,10 @@ example: `x86_64` // =============================================================== -| package.build_version +| +[[field-package-build-version]] +package.build_version + | Additional information about the build version of the installed package. For example use the commit SHA of a non-released package. @@ -4014,7 +4665,10 @@ example: `36f4f7e89dd61b0988b12ee000b98966867710cd` // =============================================================== -| package.checksum +| +[[field-package-checksum]] +package.checksum + | Checksum of the installed package for verification. type: keyword @@ -4027,7 +4681,10 @@ example: `68b329da9893e34099c7d8ad5cb9c940` // =============================================================== -| package.description +| +[[field-package-description]] +package.description + | Description of the package. type: keyword @@ -4040,7 +4697,10 @@ example: `Open source programming language to build simple/reliable/efficient so // =============================================================== -| package.install_scope +| +[[field-package-install-scope]] +package.install_scope + | Indicating how the package was installed, e.g. user-local, global. type: keyword @@ -4053,7 +4713,10 @@ example: `global` // =============================================================== -| package.installed +| +[[field-package-installed]] +package.installed + | Time when package was installed. type: date @@ -4066,7 +4729,10 @@ type: date // =============================================================== -| package.license +| +[[field-package-license]] +package.license + | License under which the package was released. Use a short name, e.g. the license identifier from SPDX License List where possible (https://spdx.org/licenses/). @@ -4081,7 +4747,10 @@ example: `Apache License 2.0` // =============================================================== -| package.name +| +[[field-package-name]] +package.name + | Package name type: keyword @@ -4094,7 +4763,10 @@ example: `go` // =============================================================== -| package.path +| +[[field-package-path]] +package.path + | Path where the package is installed. type: keyword @@ -4107,7 +4779,10 @@ example: `/usr/local/Cellar/go/1.12.9/` // =============================================================== -| package.reference +| +[[field-package-reference]] +package.reference + | Home page or reference URL of the software in this package, if available. type: keyword @@ -4120,7 +4795,10 @@ example: `https://golang.org` // =============================================================== -| package.size +| +[[field-package-size]] +package.size + | Package size in bytes. type: long @@ -4133,7 +4811,10 @@ example: `62231` // =============================================================== -| package.type +| +[[field-package-type]] +package.type + | Type of package. This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar. @@ -4148,7 +4829,10 @@ example: `rpm` // =============================================================== -| package.version +| +[[field-package-version]] +package.version + | Package version type: keyword @@ -4177,7 +4861,10 @@ These fields contain Windows Portable Executable (PE) metadata. // =============================================================== -| pe.architecture +| +[[field-pe-architecture]] +pe.architecture + | CPU architecture target for the file. type: keyword @@ -4190,7 +4877,10 @@ example: `x64` // =============================================================== -| pe.company +| +[[field-pe-company]] +pe.company + | Internal company name of the file, provided at compile-time. type: keyword @@ -4203,7 +4893,10 @@ example: `Microsoft Corporation` // =============================================================== -| pe.description +| +[[field-pe-description]] +pe.description + | Internal description of the file, provided at compile-time. type: keyword @@ -4216,7 +4909,10 @@ example: `Paint` // =============================================================== -| pe.file_version +| +[[field-pe-file-version]] +pe.file_version + | Internal version of the file, provided at compile-time. type: keyword @@ -4229,7 +4925,10 @@ example: `6.3.9600.17415` // =============================================================== -| pe.imphash +| +[[field-pe-imphash]] +pe.imphash + | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. @@ -4244,7 +4943,10 @@ example: `0c6803c4e922103c4dca5963aad36ddf` // =============================================================== -| pe.original_file_name +| +[[field-pe-original-file-name]] +pe.original_file_name + | Internal name of the file, provided at compile-time. type: keyword @@ -4257,7 +4959,10 @@ example: `MSPAINT.EXE` // =============================================================== -| pe.product +| +[[field-pe-product]] +pe.product + | Internal product name of the file, provided at compile-time. type: keyword @@ -4298,7 +5003,10 @@ These fields can help you correlate metrics information with a process id/name f // =============================================================== -| process.args +| +[[field-process-args]] +process.args + | Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. @@ -4316,7 +5024,10 @@ example: `["/usr/bin/ssh", "-l", "user", "10.0.0.16"]` // =============================================================== -| process.args_count +| +[[field-process-args-count]] +process.args_count + | Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. @@ -4331,7 +5042,10 @@ example: `4` // =============================================================== -| process.command_line +| +[[field-process-command-line]] +process.command_line + | Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. @@ -4352,7 +5066,10 @@ example: `/usr/bin/ssh -l user 10.0.0.16` // =============================================================== -| process.entity_id +| +[[field-process-entity-id]] +process.entity_id + | Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. @@ -4369,7 +5086,10 @@ example: `c2c455d9f99375d` // =============================================================== -| process.executable +| +[[field-process-executable]] +process.executable + | Absolute path to the process executable. type: keyword @@ -4388,7 +5108,10 @@ example: `/usr/bin/ssh` // =============================================================== -| process.exit_code +| +[[field-process-exit-code]] +process.exit_code + | The exit code of the process, if this is a termination event. The field should be absent if there is no exit code for the event (e.g. process start). @@ -4403,7 +5126,10 @@ example: `137` // =============================================================== -| process.name +| +[[field-process-name]] +process.name + | Process name. Sometimes called program name or similar. @@ -4424,7 +5150,10 @@ example: `ssh` // =============================================================== -| process.pgid +| +[[field-process-pgid]] +process.pgid + | Identifier of the group of processes the process belongs to. type: long @@ -4437,7 +5166,10 @@ type: long // =============================================================== -| process.pid +| +[[field-process-pid]] +process.pid + | Process id. type: long @@ -4450,7 +5182,10 @@ example: `4242` // =============================================================== -| process.ppid +| +[[field-process-ppid]] +process.ppid + | Parent process' pid. type: long @@ -4463,7 +5198,10 @@ example: `4241` // =============================================================== -| process.start +| +[[field-process-start]] +process.start + | The time the process started. type: date @@ -4476,7 +5214,10 @@ example: `2016-05-23T08:05:34.853Z` // =============================================================== -| process.thread.id +| +[[field-process-thread-id]] +process.thread.id + | Thread ID. type: long @@ -4489,7 +5230,10 @@ example: `4242` // =============================================================== -| process.thread.name +| +[[field-process-thread-name]] +process.thread.name + | Thread name. type: keyword @@ -4502,7 +5246,10 @@ example: `thread-0` // =============================================================== -| process.title +| +[[field-process-title]] +process.title + | Process title. The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened. @@ -4523,7 +5270,10 @@ Multi-fields: // =============================================================== -| process.uptime +| +[[field-process-uptime]] +process.uptime + | Seconds the process has been up. type: long @@ -4536,7 +5286,10 @@ example: `1325` // =============================================================== -| process.working_directory +| +[[field-process-working-directory]] +process.working_directory + | The working directory of the process. type: keyword @@ -4618,7 +5371,10 @@ Fields related to Windows Registry operations. // =============================================================== -| registry.data.bytes +| +[[field-registry-data-bytes]] +registry.data.bytes + | Original bytes written with base64 encoding. For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by `lp_data`. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values. @@ -4633,7 +5389,10 @@ example: `ZQBuAC0AVQBTAAAAZQBuAAAAAAA=` // =============================================================== -| registry.data.strings +| +[[field-registry-data-strings]] +registry.data.strings + | Content when writing string types. Populated as an array when writing string data to the registry. For single string registry types (REG_SZ, REG_EXPAND_SZ), this should be an array with one string. For sequences of string with REG_MULTI_SZ, this array will be variable length. For numeric data, such as REG_DWORD and REG_QWORD, this should be populated with the decimal representation (e.g `"1"`). @@ -4651,7 +5410,10 @@ example: `["C:\rta\red_ttp\bin\myapp.exe"]` // =============================================================== -| registry.data.type +| +[[field-registry-data-type]] +registry.data.type + | Standard registry type for encoding contents type: keyword @@ -4664,7 +5426,10 @@ example: `REG_SZ` // =============================================================== -| registry.hive +| +[[field-registry-hive]] +registry.hive + | Abbreviated name for the hive. type: keyword @@ -4677,7 +5442,10 @@ example: `HKLM` // =============================================================== -| registry.key +| +[[field-registry-key]] +registry.key + | Hive-relative path of keys. type: keyword @@ -4690,7 +5458,10 @@ example: `SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Opti // =============================================================== -| registry.path +| +[[field-registry-path]] +registry.path + | Full path, including hive, key and value type: keyword @@ -4703,7 +5474,10 @@ example: `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution // =============================================================== -| registry.value +| +[[field-registry-value]] +registry.value + | Name of the value written. type: keyword @@ -4736,7 +5510,10 @@ A concrete example is IP addresses, which can be under host, observer, source, d // =============================================================== -| related.hash +| +[[field-related-hash]] +related.hash + | All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). type: keyword @@ -4752,7 +5529,10 @@ Note: this field should contain an array of values. // =============================================================== -| related.hosts +| +[[field-related-hosts]] +related.hosts + | All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases. type: keyword @@ -4768,7 +5548,10 @@ Note: this field should contain an array of values. // =============================================================== -| related.ip +| +[[field-related-ip]] +related.ip + | All of the IPs seen on your event. type: ip @@ -4784,7 +5567,10 @@ Note: this field should contain an array of values. // =============================================================== -| related.user +| +[[field-related-user]] +related.user + | All the user names seen on your event. type: keyword @@ -4818,7 +5604,10 @@ Examples of data sources that would populate the rule fields include: network ad // =============================================================== -| rule.author +| +[[field-rule-author]] +rule.author + | Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. type: keyword @@ -4834,7 +5623,10 @@ example: `["Star-Lord"]` // =============================================================== -| rule.category +| +[[field-rule-category]] +rule.category + | A categorization value keyword used by the entity using the rule for detection of this event. type: keyword @@ -4847,7 +5639,10 @@ example: `Attempted Information Leak` // =============================================================== -| rule.description +| +[[field-rule-description]] +rule.description + | The description of the rule generating the event. type: keyword @@ -4860,7 +5655,10 @@ example: `Block requests to public DNS over HTTPS / TLS protocols` // =============================================================== -| rule.id +| +[[field-rule-id]] +rule.id + | A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. type: keyword @@ -4873,7 +5671,10 @@ example: `101` // =============================================================== -| rule.license +| +[[field-rule-license]] +rule.license + | Name of the license under which the rule used to generate this event is made available. type: keyword @@ -4886,7 +5687,10 @@ example: `Apache 2.0` // =============================================================== -| rule.name +| +[[field-rule-name]] +rule.name + | The name of the rule or signature generating the event. type: keyword @@ -4899,7 +5703,10 @@ example: `BLOCK_DNS_over_TLS` // =============================================================== -| rule.reference +| +[[field-rule-reference]] +rule.reference + | Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert. @@ -4914,7 +5721,10 @@ example: `https://en.wikipedia.org/wiki/DNS_over_TLS` // =============================================================== -| rule.ruleset +| +[[field-rule-ruleset]] +rule.ruleset + | Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. type: keyword @@ -4927,7 +5737,10 @@ example: `Standard_Protocol_Filters` // =============================================================== -| rule.uuid +| +[[field-rule-uuid]] +rule.uuid + | A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. type: keyword @@ -4940,7 +5753,10 @@ example: `1100110011` // =============================================================== -| rule.version +| +[[field-rule-version]] +rule.version + | The version / revision of the rule being used for analysis. type: keyword @@ -4973,7 +5789,10 @@ Client / server representations can add semantic context to an exchange, which i // =============================================================== -| server.address +| +[[field-server-address]] +server.address + | Some event server 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. @@ -4988,7 +5807,10 @@ type: keyword // =============================================================== -| server.bytes +| +[[field-server-bytes]] +server.bytes + | Bytes sent from the server to the client. type: long @@ -5001,7 +5823,10 @@ example: `184` // =============================================================== -| server.domain +| +[[field-server-domain]] +server.domain + | Server domain. type: keyword @@ -5014,7 +5839,10 @@ type: keyword // =============================================================== -| server.ip +| +[[field-server-ip]] +server.ip + | IP address of the server (IPv4 or IPv6). type: ip @@ -5027,7 +5855,10 @@ type: ip // =============================================================== -| server.mac +| +[[field-server-mac]] +server.mac + | MAC address of the server. type: keyword @@ -5040,7 +5871,10 @@ type: keyword // =============================================================== -| server.nat.ip +| +[[field-server-nat-ip]] +server.nat.ip + | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -5055,7 +5889,10 @@ type: ip // =============================================================== -| server.nat.port +| +[[field-server-nat-port]] +server.nat.port + | Translated port of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -5070,7 +5907,10 @@ type: long // =============================================================== -| server.packets +| +[[field-server-packets]] +server.packets + | Packets sent from the server to the client. type: long @@ -5083,7 +5923,10 @@ example: `12` // =============================================================== -| server.port +| +[[field-server-port]] +server.port + | Port of the server. type: long @@ -5096,7 +5939,10 @@ type: long // =============================================================== -| server.registered_domain +| +[[field-server-registered-domain]] +server.registered_domain + | The highest registered server domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -5113,7 +5959,10 @@ example: `example.com` // =============================================================== -| server.subdomain +| +[[field-server-subdomain]] +server.subdomain + | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -5128,7 +5977,10 @@ example: `east` // =============================================================== -| server.top_level_domain +| +[[field-server-top-level-domain]] +server.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -5198,7 +6050,10 @@ These fields help you find and correlate logs for a specific service and version // =============================================================== -| service.ephemeral_id +| +[[field-service-ephemeral-id]] +service.ephemeral_id + | Ephemeral identifier of this service (if one exists). This id normally changes across restarts, but `service.id` does not. @@ -5213,7 +6068,10 @@ example: `8a4f500f` // =============================================================== -| service.id +| +[[field-service-id]] +service.id + | Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes. This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event. @@ -5230,7 +6088,10 @@ example: `d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6` // =============================================================== -| service.name +| +[[field-service-name]] +service.name + | Name of the service data is collected from. The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name. @@ -5247,7 +6108,10 @@ example: `elasticsearch-metrics` // =============================================================== -| service.node.name +| +[[field-service-node-name]] +service.node.name + | Name of a service node. This allows for two nodes of the same service running on the same host to be differentiated. Therefore, `service.node.name` should typically be unique across nodes of a given service. @@ -5264,7 +6128,10 @@ example: `instance-0000000016` // =============================================================== -| service.state +| +[[field-service-state]] +service.state + | Current state of the service. type: keyword @@ -5277,7 +6144,10 @@ type: keyword // =============================================================== -| service.type +| +[[field-service-type]] +service.type + | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. @@ -5294,7 +6164,10 @@ example: `elasticsearch` // =============================================================== -| service.version +| +[[field-service-version]] +service.version + | Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. @@ -5327,7 +6200,10 @@ Source fields are usually populated in conjunction with destination fields. The // =============================================================== -| source.address +| +[[field-source-address]] +source.address + | Some event source 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. @@ -5342,7 +6218,10 @@ type: keyword // =============================================================== -| source.bytes +| +[[field-source-bytes]] +source.bytes + | Bytes sent from the source to the destination. type: long @@ -5355,7 +6234,10 @@ example: `184` // =============================================================== -| source.domain +| +[[field-source-domain]] +source.domain + | Source domain. type: keyword @@ -5368,7 +6250,10 @@ type: keyword // =============================================================== -| source.ip +| +[[field-source-ip]] +source.ip + | IP address of the source (IPv4 or IPv6). type: ip @@ -5381,7 +6266,10 @@ type: ip // =============================================================== -| source.mac +| +[[field-source-mac]] +source.mac + | MAC address of the source. type: keyword @@ -5394,7 +6282,10 @@ type: keyword // =============================================================== -| source.nat.ip +| +[[field-source-nat-ip]] +source.nat.ip + | Translated ip of source based NAT sessions (e.g. internal client to internet) Typically connections traversing load balancers, firewalls, or routers. @@ -5409,7 +6300,10 @@ type: ip // =============================================================== -| source.nat.port +| +[[field-source-nat-port]] +source.nat.port + | Translated port of source based NAT sessions. (e.g. internal client to internet) Typically used with load balancers, firewalls, or routers. @@ -5424,7 +6318,10 @@ type: long // =============================================================== -| source.packets +| +[[field-source-packets]] +source.packets + | Packets sent from the source to the destination. type: long @@ -5437,7 +6334,10 @@ example: `12` // =============================================================== -| source.port +| +[[field-source-port]] +source.port + | Port of the source. type: long @@ -5450,7 +6350,10 @@ type: long // =============================================================== -| source.registered_domain +| +[[field-source-registered-domain]] +source.registered_domain + | The highest registered source domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -5467,7 +6370,10 @@ example: `example.com` // =============================================================== -| source.subdomain +| +[[field-source-subdomain]] +source.subdomain + | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -5482,7 +6388,10 @@ example: `east` // =============================================================== -| source.top_level_domain +| +[[field-source-top-level-domain]] +source.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -5552,7 +6461,10 @@ These fields are for users to classify alerts from all of their sources (e.g. ID // =============================================================== -| threat.framework +| +[[field-threat-framework]] +threat.framework + | Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events. type: keyword @@ -5565,7 +6477,10 @@ example: `MITRE ATT&CK` // =============================================================== -| threat.tactic.id +| +[[field-threat-tactic-id]] +threat.tactic.id + | The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) type: keyword @@ -5581,7 +6496,10 @@ example: `TA0002` // =============================================================== -| threat.tactic.name +| +[[field-threat-tactic-name]] +threat.tactic.name + | Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/) type: keyword @@ -5597,7 +6515,10 @@ example: `Execution` // =============================================================== -| threat.tactic.reference +| +[[field-threat-tactic-reference]] +threat.tactic.reference + | The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) type: keyword @@ -5613,7 +6534,10 @@ example: `https://attack.mitre.org/tactics/TA0002/` // =============================================================== -| threat.technique.id +| +[[field-threat-technique-id]] +threat.technique.id + | The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -5629,7 +6553,10 @@ example: `T1059` // =============================================================== -| threat.technique.name +| +[[field-threat-technique-name]] +threat.technique.name + | The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -5651,7 +6578,10 @@ example: `Command and Scripting Interpreter` // =============================================================== -| threat.technique.reference +| +[[field-threat-technique-reference]] +threat.technique.reference + | The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -5667,7 +6597,10 @@ example: `https://attack.mitre.org/techniques/T1059/` // =============================================================== -| threat.technique.subtechnique.id +| +[[field-threat-technique-subtechnique-id]] +threat.technique.subtechnique.id + | The full id of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -5683,7 +6616,10 @@ example: `T1059.001` // =============================================================== -| threat.technique.subtechnique.name +| +[[field-threat-technique-subtechnique-name]] +threat.technique.subtechnique.name + | The name of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -5705,7 +6641,10 @@ example: `PowerShell` // =============================================================== -| threat.technique.subtechnique.reference +| +[[field-threat-technique-subtechnique-reference]] +threat.technique.subtechnique.reference + | The reference url of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -5737,7 +6676,10 @@ Fields related to a TLS connection. These fields focus on the TLS protocol itsel // =============================================================== -| tls.cipher +| +[[field-tls-cipher]] +tls.cipher + | String indicating the cipher used during the current connection. type: keyword @@ -5750,7 +6692,10 @@ example: `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` // =============================================================== -| tls.client.certificate +| +[[field-tls-client-certificate]] +tls.client.certificate + | PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. type: keyword @@ -5763,7 +6708,10 @@ example: `MII...` // =============================================================== -| tls.client.certificate_chain +| +[[field-tls-client-certificate-chain]] +tls.client.certificate_chain + | Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. type: keyword @@ -5779,7 +6727,10 @@ example: `["MII...", "MII..."]` // =============================================================== -| tls.client.hash.md5 +| +[[field-tls-client-hash-md5]] +tls.client.hash.md5 + | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -5792,7 +6743,10 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` // =============================================================== -| tls.client.hash.sha1 +| +[[field-tls-client-hash-sha1]] +tls.client.hash.sha1 + | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -5805,7 +6759,10 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` // =============================================================== -| tls.client.hash.sha256 +| +[[field-tls-client-hash-sha256]] +tls.client.hash.sha256 + | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -5818,7 +6775,10 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` // =============================================================== -| tls.client.issuer +| +[[field-tls-client-issuer]] +tls.client.issuer + | Distinguished name of subject of the issuer of the x.509 certificate presented by the client. type: keyword @@ -5831,7 +6791,10 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` // =============================================================== -| tls.client.ja3 +| +[[field-tls-client-ja3]] +tls.client.ja3 + | A hash that identifies clients based on how they perform an SSL/TLS handshake. type: keyword @@ -5844,7 +6807,10 @@ example: `d4e5b18d6b55c71272893221c96ba240` // =============================================================== -| tls.client.not_after +| +[[field-tls-client-not-after]] +tls.client.not_after + | Date/Time indicating when client certificate is no longer considered valid. type: date @@ -5857,7 +6823,10 @@ example: `2021-01-01T00:00:00.000Z` // =============================================================== -| tls.client.not_before +| +[[field-tls-client-not-before]] +tls.client.not_before + | Date/Time indicating when client certificate is first considered valid. type: date @@ -5870,7 +6839,10 @@ example: `1970-01-01T00:00:00.000Z` // =============================================================== -| tls.client.server_name +| +[[field-tls-client-server-name]] +tls.client.server_name + | Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to `destination.domain`. type: keyword @@ -5883,7 +6855,10 @@ example: `www.elastic.co` // =============================================================== -| tls.client.subject +| +[[field-tls-client-subject]] +tls.client.subject + | Distinguished name of subject of the x.509 certificate presented by the client. type: keyword @@ -5896,7 +6871,10 @@ example: `CN=myclient, OU=Documentation Team, DC=example, DC=com` // =============================================================== -| tls.client.supported_ciphers +| +[[field-tls-client-supported-ciphers]] +tls.client.supported_ciphers + | Array of ciphers offered by the client during the client hello. type: keyword @@ -5912,7 +6890,10 @@ example: `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_25 // =============================================================== -| tls.curve +| +[[field-tls-curve]] +tls.curve + | String indicating the curve used for the given cipher, when applicable. type: keyword @@ -5925,7 +6906,10 @@ example: `secp256r1` // =============================================================== -| tls.established +| +[[field-tls-established]] +tls.established + | Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. type: boolean @@ -5938,7 +6922,10 @@ type: boolean // =============================================================== -| tls.next_protocol +| +[[field-tls-next-protocol]] +tls.next_protocol + | String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. type: keyword @@ -5951,7 +6938,10 @@ example: `http/1.1` // =============================================================== -| tls.resumed +| +[[field-tls-resumed]] +tls.resumed + | Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. type: boolean @@ -5964,7 +6954,10 @@ type: boolean // =============================================================== -| tls.server.certificate +| +[[field-tls-server-certificate]] +tls.server.certificate + | PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. type: keyword @@ -5977,7 +6970,10 @@ example: `MII...` // =============================================================== -| tls.server.certificate_chain +| +[[field-tls-server-certificate-chain]] +tls.server.certificate_chain + | Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. type: keyword @@ -5993,7 +6989,10 @@ example: `["MII...", "MII..."]` // =============================================================== -| tls.server.hash.md5 +| +[[field-tls-server-hash-md5]] +tls.server.hash.md5 + | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -6006,7 +7005,10 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` // =============================================================== -| tls.server.hash.sha1 +| +[[field-tls-server-hash-sha1]] +tls.server.hash.sha1 + | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -6019,7 +7021,10 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` // =============================================================== -| tls.server.hash.sha256 +| +[[field-tls-server-hash-sha256]] +tls.server.hash.sha256 + | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -6032,7 +7037,10 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` // =============================================================== -| tls.server.issuer +| +[[field-tls-server-issuer]] +tls.server.issuer + | Subject of the issuer of the x.509 certificate presented by the server. type: keyword @@ -6045,7 +7053,10 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` // =============================================================== -| tls.server.ja3s +| +[[field-tls-server-ja3s]] +tls.server.ja3s + | A hash that identifies servers based on how they perform an SSL/TLS handshake. type: keyword @@ -6058,7 +7069,10 @@ example: `394441ab65754e2207b1e1b457b3641d` // =============================================================== -| tls.server.not_after +| +[[field-tls-server-not-after]] +tls.server.not_after + | Timestamp indicating when server certificate is no longer considered valid. type: date @@ -6071,7 +7085,10 @@ example: `2021-01-01T00:00:00.000Z` // =============================================================== -| tls.server.not_before +| +[[field-tls-server-not-before]] +tls.server.not_before + | Timestamp indicating when server certificate is first considered valid. type: date @@ -6084,7 +7101,10 @@ example: `1970-01-01T00:00:00.000Z` // =============================================================== -| tls.server.subject +| +[[field-tls-server-subject]] +tls.server.subject + | Subject of the x.509 certificate presented by the server. type: keyword @@ -6097,7 +7117,10 @@ example: `CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com` // =============================================================== -| tls.version +| +[[field-tls-version]] +tls.version + | Numeric part of the version parsed from the original string. type: keyword @@ -6110,7 +7133,10 @@ example: `1.2` // =============================================================== -| tls.version_protocol +| +[[field-tls-version-protocol]] +tls.version_protocol + | Normalized lowercase protocol name parsed from original string. type: keyword @@ -6170,7 +7196,10 @@ Distributed tracing makes it possible to analyze performance throughout a micros // =============================================================== -| span.id +| +[[field-span-id]] +span.id + | Unique identifier of the span within the scope of its trace. A span represents an operation within a transaction, such as a request to another service, or a database query. @@ -6185,7 +7214,10 @@ example: `3ff9a8981b7ccd5a` // =============================================================== -| trace.id +| +[[field-trace-id]] +trace.id + | Unique identifier of the trace. A trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services. @@ -6200,7 +7232,10 @@ example: `4bf92f3577b34da6a3ce929d0e0e4736` // =============================================================== -| transaction.id +| +[[field-transaction-id]] +transaction.id + | Unique identifier of the transaction within the scope of its trace. A transaction is the highest level of work measured within a service, such as a request to a server. @@ -6231,7 +7266,10 @@ URL fields provide support for complete or partial URLs, and supports the breaki // =============================================================== -| url.domain +| +[[field-url-domain]] +url.domain + | Domain of the url, such as "www.elastic.co". In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the `domain` field. @@ -6246,7 +7284,10 @@ example: `www.elastic.co` // =============================================================== -| url.extension +| +[[field-url-extension]] +url.extension + | The field contains the file extension from the original request url. The file extension is only set if it exists, as not every url has a file extension. @@ -6263,7 +7304,10 @@ example: `png` // =============================================================== -| url.fragment +| +[[field-url-fragment]] +url.fragment + | Portion of the url after the `#`, such as "top". The `#` is not part of the fragment. @@ -6278,7 +7322,10 @@ type: keyword // =============================================================== -| url.full +| +[[field-url-full]] +url.full + | If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source. type: keyword @@ -6297,7 +7344,10 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top` // =============================================================== -| url.original +| +[[field-url-original]] +url.original + | Unmodified original url as seen in the event source. Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. @@ -6320,7 +7370,10 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=ela // =============================================================== -| url.password +| +[[field-url-password]] +url.password + | Password of the request. type: keyword @@ -6333,7 +7386,10 @@ type: keyword // =============================================================== -| url.path +| +[[field-url-path]] +url.path + | Path of the request, such as "/search". type: keyword @@ -6346,7 +7402,10 @@ type: keyword // =============================================================== -| url.port +| +[[field-url-port]] +url.port + | Port of the request, such as 443. type: long @@ -6359,7 +7418,10 @@ example: `443` // =============================================================== -| url.query +| +[[field-url-query]] +url.query + | The query field describes the query string of the request, such as "q=elasticsearch". The `?` is excluded from the query string. If a URL contains no `?`, there is no query field. If there is a `?` but no query, the query field exists with an empty string. The `exists` query can be used to differentiate between the two cases. @@ -6374,7 +7436,10 @@ type: keyword // =============================================================== -| url.registered_domain +| +[[field-url-registered-domain]] +url.registered_domain + | The highest registered url domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -6391,7 +7456,10 @@ example: `example.com` // =============================================================== -| url.scheme +| +[[field-url-scheme]] +url.scheme + | Scheme of the request, such as "https". Note: The `:` is not part of the scheme. @@ -6406,7 +7474,10 @@ example: `https` // =============================================================== -| url.subdomain +| +[[field-url-subdomain]] +url.subdomain + | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -6421,7 +7492,10 @@ example: `east` // =============================================================== -| url.top_level_domain +| +[[field-url-top-level-domain]] +url.top_level_domain + | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "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 label will not work well for effective TLDs such as "co.uk". @@ -6436,7 +7510,10 @@ example: `co.uk` // =============================================================== -| url.username +| +[[field-url-username]] +url.username + | Username of the request. type: keyword @@ -6467,7 +7544,10 @@ Fields can have one entry or multiple entries. If a user has more than one id, p // =============================================================== -| user.domain +| +[[field-user-domain]] +user.domain + | Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. @@ -6482,7 +7562,10 @@ type: keyword // =============================================================== -| user.email +| +[[field-user-email]] +user.email + | User email address. type: keyword @@ -6495,7 +7578,10 @@ type: keyword // =============================================================== -| user.full_name +| +[[field-user-full-name]] +user.full_name + | User's full name, if available. type: keyword @@ -6514,7 +7600,10 @@ example: `Albert Einstein` // =============================================================== -| user.hash +| +[[field-user-hash]] +user.hash + | 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. @@ -6529,7 +7618,10 @@ type: keyword // =============================================================== -| user.id +| +[[field-user-id]] +user.id + | Unique identifier of the user. type: keyword @@ -6542,7 +7634,10 @@ type: keyword // =============================================================== -| user.name +| +[[field-user-name]] +user.name + | Short name or login of the user. type: keyword @@ -6561,7 +7656,10 @@ example: `albert` // =============================================================== -| user.roles +| +[[field-user-roles]] +user.roles + | Array of user roles at the time of the event. type: keyword @@ -6624,7 +7722,10 @@ They often show up in web service logs coming from the parsed user agent string. // =============================================================== -| user_agent.device.name +| +[[field-user-agent-device-name]] +user_agent.device.name + | Name of the device. type: keyword @@ -6637,7 +7738,10 @@ example: `iPhone` // =============================================================== -| user_agent.name +| +[[field-user-agent-name]] +user_agent.name + | Name of the user agent. type: keyword @@ -6650,7 +7754,10 @@ example: `Safari` // =============================================================== -| user_agent.original +| +[[field-user-agent-original]] +user_agent.original + | Unparsed user_agent string. type: keyword @@ -6669,7 +7776,10 @@ example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605 // =============================================================== -| user_agent.version +| +[[field-user-agent-version]] +user_agent.version + | Version of the user agent. type: keyword @@ -6729,7 +7839,10 @@ Observer.ingress and observer.egress VLAN values are used to record observer spe // =============================================================== -| vlan.id +| +[[field-vlan-id]] +vlan.id + | VLAN ID as reported by the observer. type: keyword @@ -6742,7 +7855,10 @@ example: `10` // =============================================================== -| vlan.name +| +[[field-vlan-name]] +vlan.name + | Optional VLAN name as reported by the observer. type: keyword @@ -6781,7 +7897,10 @@ The vulnerability fields describe information about a vulnerability that is rele // =============================================================== -| vulnerability.category +| +[[field-vulnerability-category]] +vulnerability.category + | The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm[Qualys vulnerability categories]) This field must be an array. @@ -6799,7 +7918,10 @@ example: `["Firewall"]` // =============================================================== -| vulnerability.classification +| +[[field-vulnerability-classification]] +vulnerability.classification + | The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/) type: keyword @@ -6812,7 +7934,10 @@ example: `CVSS` // =============================================================== -| vulnerability.description +| +[[field-vulnerability-description]] +vulnerability.description + | The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created[Common Vulnerabilities and Exposure CVE description]) type: keyword @@ -6831,7 +7956,10 @@ example: `In macOS before 2.12.6, there is a vulnerability in the RPC...` // =============================================================== -| vulnerability.enumeration +| +[[field-vulnerability-enumeration]] +vulnerability.enumeration + | The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/) type: keyword @@ -6844,7 +7972,10 @@ example: `CVE` // =============================================================== -| vulnerability.id +| +[[field-vulnerability-id]] +vulnerability.id + | The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)[Common Vulnerabilities and Exposure CVE ID] type: keyword @@ -6857,7 +7988,10 @@ example: `CVE-2019-00001` // =============================================================== -| vulnerability.reference +| +[[field-vulnerability-reference]] +vulnerability.reference + | A resource that provides additional information, context, and mitigations for the identified vulnerability. type: keyword @@ -6870,7 +8004,10 @@ example: `https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111` // =============================================================== -| vulnerability.report_id +| +[[field-vulnerability-report-id]] +vulnerability.report_id + | The report or scan identification number. type: keyword @@ -6883,7 +8020,10 @@ example: `20191018.0001` // =============================================================== -| vulnerability.scanner.vendor +| +[[field-vulnerability-scanner-vendor]] +vulnerability.scanner.vendor + | The name of the vulnerability scanner vendor. type: keyword @@ -6896,7 +8036,10 @@ example: `Tenable` // =============================================================== -| vulnerability.score.base +| +[[field-vulnerability-score-base]] +vulnerability.score.base + | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Base scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentiality, integrity, and availability), and scope. For example (https://www.first.org/cvss/specification-document) @@ -6911,7 +8054,10 @@ example: `5.5` // =============================================================== -| vulnerability.score.environmental +| +[[field-vulnerability-score-environmental]] +vulnerability.score.environmental + | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Environmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (https://www.first.org/cvss/specification-document) @@ -6926,7 +8072,10 @@ example: `5.5` // =============================================================== -| vulnerability.score.temporal +| +[[field-vulnerability-score-temporal]] +vulnerability.score.temporal + | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Temporal scores cover an assessment for code maturity, remediation level, and confidence. For example (https://www.first.org/cvss/specification-document) @@ -6941,7 +8090,10 @@ type: float // =============================================================== -| vulnerability.score.version +| +[[field-vulnerability-score-version]] +vulnerability.score.version + | The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification. CVSS is owned and managed by FIRST.Org, Inc. (FIRST), a US-based non-profit organization, whose mission is to help computer security incident response teams across the world. For example (https://nvd.nist.gov/vuln-metrics/cvss) @@ -6956,7 +8108,10 @@ example: `2.0` // =============================================================== -| vulnerability.severity +| +[[field-vulnerability-severity]] +vulnerability.severity + | The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss) type: keyword @@ -6989,7 +8144,10 @@ Events that contain certificate information about network connections, should us // =============================================================== -| x509.alternative_names +| +[[field-x509-alternative-names]] +x509.alternative_names + | List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses. type: keyword @@ -7005,7 +8163,10 @@ example: `*.elastic.co` // =============================================================== -| x509.issuer.common_name +| +[[field-x509-issuer-common-name]] +x509.issuer.common_name + | List of common name (CN) of issuing certificate authority. type: keyword @@ -7021,7 +8182,10 @@ example: `Example SHA2 High Assurance Server CA` // =============================================================== -| x509.issuer.country +| +[[field-x509-issuer-country]] +x509.issuer.country + | List of country (C) codes type: keyword @@ -7037,7 +8201,10 @@ example: `US` // =============================================================== -| x509.issuer.distinguished_name +| +[[field-x509-issuer-distinguished-name]] +x509.issuer.distinguished_name + | Distinguished name (DN) of issuing certificate authority. type: keyword @@ -7050,7 +8217,10 @@ example: `C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assuranc // =============================================================== -| x509.issuer.locality +| +[[field-x509-issuer-locality]] +x509.issuer.locality + | List of locality names (L) type: keyword @@ -7066,7 +8236,10 @@ example: `Mountain View` // =============================================================== -| x509.issuer.organization +| +[[field-x509-issuer-organization]] +x509.issuer.organization + | List of organizations (O) of issuing certificate authority. type: keyword @@ -7082,7 +8255,10 @@ example: `Example Inc` // =============================================================== -| x509.issuer.organizational_unit +| +[[field-x509-issuer-organizational-unit]] +x509.issuer.organizational_unit + | List of organizational units (OU) of issuing certificate authority. type: keyword @@ -7098,7 +8274,10 @@ example: `www.example.com` // =============================================================== -| x509.issuer.state_or_province +| +[[field-x509-issuer-state-or-province]] +x509.issuer.state_or_province + | List of state or province names (ST, S, or P) type: keyword @@ -7114,7 +8293,10 @@ example: `California` // =============================================================== -| x509.not_after +| +[[field-x509-not-after]] +x509.not_after + | Time at which the certificate is no longer considered valid. type: date @@ -7127,7 +8309,10 @@ example: `2020-07-16 03:15:39+00:00` // =============================================================== -| x509.not_before +| +[[field-x509-not-before]] +x509.not_before + | Time at which the certificate is first considered valid. type: date @@ -7140,7 +8325,10 @@ example: `2019-08-16 01:40:25+00:00` // =============================================================== -| x509.public_key_algorithm +| +[[field-x509-public-key-algorithm]] +x509.public_key_algorithm + | Algorithm used to generate the public key. type: keyword @@ -7153,7 +8341,10 @@ example: `RSA` // =============================================================== -| x509.public_key_curve +| +[[field-x509-public-key-curve]] +x509.public_key_curve + | The curve used by the elliptic curve public key algorithm. This is algorithm specific. type: keyword @@ -7166,7 +8357,10 @@ example: `nistp521` // =============================================================== -| x509.public_key_exponent +| +[[field-x509-public-key-exponent]] +x509.public_key_exponent + | Exponent used to derive the public key. This is algorithm specific. type: long @@ -7179,7 +8373,10 @@ example: `65537` // =============================================================== -| x509.public_key_size +| +[[field-x509-public-key-size]] +x509.public_key_size + | The size of the public key space in bits. type: long @@ -7192,7 +8389,10 @@ example: `2048` // =============================================================== -| x509.serial_number +| +[[field-x509-serial-number]] +x509.serial_number + | Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters. type: keyword @@ -7205,7 +8405,10 @@ example: `55FBB9C7DEBF09809D12CCAA` // =============================================================== -| x509.signature_algorithm +| +[[field-x509-signature-algorithm]] +x509.signature_algorithm + | Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353. type: keyword @@ -7218,7 +8421,10 @@ example: `SHA256-RSA` // =============================================================== -| x509.subject.common_name +| +[[field-x509-subject-common-name]] +x509.subject.common_name + | List of common names (CN) of subject. type: keyword @@ -7234,7 +8440,10 @@ example: `shared.global.example.net` // =============================================================== -| x509.subject.country +| +[[field-x509-subject-country]] +x509.subject.country + | List of country (C) code type: keyword @@ -7250,7 +8459,10 @@ example: `US` // =============================================================== -| x509.subject.distinguished_name +| +[[field-x509-subject-distinguished-name]] +x509.subject.distinguished_name + | Distinguished name (DN) of the certificate subject entity. type: keyword @@ -7263,7 +8475,10 @@ example: `C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.globa // =============================================================== -| x509.subject.locality +| +[[field-x509-subject-locality]] +x509.subject.locality + | List of locality names (L) type: keyword @@ -7279,7 +8494,10 @@ example: `San Francisco` // =============================================================== -| x509.subject.organization +| +[[field-x509-subject-organization]] +x509.subject.organization + | List of organizations (O) of subject. type: keyword @@ -7295,7 +8513,10 @@ example: `Example, Inc.` // =============================================================== -| x509.subject.organizational_unit +| +[[field-x509-subject-organizational-unit]] +x509.subject.organizational_unit + | List of organizational units (OU) of subject. type: keyword @@ -7311,7 +8532,10 @@ Note: this field should contain an array of values. // =============================================================== -| x509.subject.state_or_province +| +[[field-x509-subject-state-or-province]] +x509.subject.state_or_province + | List of state or province names (ST, S, or P) type: keyword @@ -7327,7 +8551,10 @@ example: `California` // =============================================================== -| x509.version_number +| +[[field-x509-version-number]] +x509.version_number + | Version of x509 format. type: keyword diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index 643c2ccf5d..ef2a203632 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -32,7 +32,10 @@ beta::[ {{ fieldset['beta'] }}] {% if 'original_fieldset' not in field -%} {# `Field` column -#} -| {{ field['flat_name'] }} +| +[[field-{{field['dashed_name']}}]] +{{ field['flat_name'] }} + {# `Description` column -#} {#- Beta fields will add the `beta` label -#} {% if field['beta'] -%} From 03d9cad8efe1968a4ad0bae72b1eacba7e067137 Mon Sep 17 00:00:00 2001 From: Mathieu Martin Date: Wed, 25 Nov 2020 11:33:54 -0500 Subject: [PATCH 2/4] Remove @ sign instead of replacing with a - Replacing @ with a dash, and also having word separators as dashes lead to a dashed_name of `field--timestamp`, and asciidoc was replacing the double dashes with an em-dash. Trying to use em-dash in links made asciidoctor really sad. --- docs/field-details.asciidoc | 2 +- generated/ecs/ecs_flat.yml | 2 +- generated/ecs/ecs_nested.yml | 2 +- scripts/schema/finalizer.py | 2 +- scripts/tests/unit/test_schema_finalizer.py | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc index f6ec313767..70b13e4c74 100644 --- a/docs/field-details.asciidoc +++ b/docs/field-details.asciidoc @@ -13,7 +13,7 @@ The `base` field set contains all fields which are at the root of the events. Th // =============================================================== | -[[field--timestamp]] +[[field-timestamp]] @timestamp | Date/time when the event originated. diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml index 78ef1eaec8..ff815139d1 100644 --- a/generated/ecs/ecs_flat.yml +++ b/generated/ecs/ecs_flat.yml @@ -1,5 +1,5 @@ '@timestamp': - dashed_name: -timestamp + dashed_name: timestamp description: 'Date/time when the event originated. This is the date/time extracted from the event, typically representing when the diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml index 1352e844e5..66cb64034b 100644 --- a/generated/ecs/ecs_nested.yml +++ b/generated/ecs/ecs_nested.yml @@ -160,7 +160,7 @@ base: events. These fields are common across all types of events. fields: '@timestamp': - dashed_name: -timestamp + dashed_name: timestamp description: 'Date/time when the event originated. This is the date/time extracted from the event, typically representing when diff --git a/scripts/schema/finalizer.py b/scripts/schema/finalizer.py index d1b4928507..3ae41acf41 100644 --- a/scripts/schema/finalizer.py +++ b/scripts/schema/finalizer.py @@ -176,7 +176,7 @@ def field_finalizer(details, path): name_array = path + [details['field_details']['node_name']] flat_name = '.'.join(name_array) details['field_details']['flat_name'] = flat_name - details['field_details']['dashed_name'] = re.sub('[@_\.]', '-', flat_name) + details['field_details']['dashed_name'] = re.sub('[_\.]', '-', flat_name).replace('@', '') if 'multi_fields' in details['field_details']: for mf in details['field_details']['multi_fields']: mf['flat_name'] = flat_name + '.' + mf['name'] diff --git a/scripts/tests/unit/test_schema_finalizer.py b/scripts/tests/unit/test_schema_finalizer.py index cea5c01e6d..7f016351d8 100644 --- a/scripts/tests/unit/test_schema_finalizer.py +++ b/scripts/tests/unit/test_schema_finalizer.py @@ -268,7 +268,7 @@ def test_calculate_final_values(self): timestamp_details = base_fields['@timestamp']['field_details'] self.assertEqual(timestamp_details['flat_name'], '@timestamp', "Field sets with root=true must not namespace field names with the field set's name") - self.assertEqual(timestamp_details['dashed_name'], '-timestamp') + self.assertEqual(timestamp_details['dashed_name'], 'timestamp') # root=false self.assertEqual(server_fields['ip']['field_details']['flat_name'], 'server.ip', "Field sets with root=false must namespace field names with the field set's name") @@ -288,7 +288,7 @@ def test_calculate_final_values(self): def test_dashed_name_cleanup(self): details = {'field_details': {'node_name': '@time.stamp_'}} finalizer.field_finalizer(details, []) - self.assertEqual(details['field_details']['dashed_name'], '-time-stamp-') + self.assertEqual(details['field_details']['dashed_name'], 'time-stamp-') # field_group_at_path From e22b1f0cb487fb8ada373b7d718371a5f6ed0a97 Mon Sep 17 00:00:00 2001 From: Mathieu Martin Date: Wed, 25 Nov 2020 11:38:00 -0500 Subject: [PATCH 3/4] Turn all field names in the table into links :magic: --- docs/field-details.asciidoc | 818 ++++++++++++++--------------- scripts/templates/field_details.j2 | 2 +- 2 files changed, 410 insertions(+), 410 deletions(-) diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc index 70b13e4c74..f968a27b6b 100644 --- a/docs/field-details.asciidoc +++ b/docs/field-details.asciidoc @@ -14,7 +14,7 @@ The `base` field set contains all fields which are at the root of the events. Th | [[field-timestamp]] -@timestamp +<> | Date/time when the event originated. @@ -36,7 +36,7 @@ example: `2016-05-23T08:05:34.853Z` | [[field-labels]] -labels +<> | Custom key/value pairs. @@ -56,7 +56,7 @@ example: `{"application": "foo-bar", "env": "production"}` | [[field-message]] -message +<> | For log events the message field contains the log message, optimized for viewing in a log viewer. @@ -76,7 +76,7 @@ example: `Hello World` | [[field-tags]] -tags +<> | List of keywords used to tag each event. @@ -113,7 +113,7 @@ Examples include Beats. Agents may also run on observers. ECS agent.* fields sha | [[field-agent-build-original]] -agent.build.original +<> | Extended build information for the agent. @@ -131,7 +131,7 @@ example: `metricbeat version 7.6.0 (amd64), libbeat 7.6.0 [6a23e8f8f30f5001ba344 | [[field-agent-ephemeral-id]] -agent.ephemeral_id +<> | Ephemeral identifier of this agent (if one exists). @@ -149,7 +149,7 @@ example: `8a4f500f` | [[field-agent-id]] -agent.id +<> | Unique identifier of this agent (if one exists). @@ -167,7 +167,7 @@ example: `8a4f500d` | [[field-agent-name]] -agent.name +<> | Custom name of the agent. @@ -187,7 +187,7 @@ example: `foo` | [[field-agent-type]] -agent.type +<> | Type of the agent. @@ -205,7 +205,7 @@ example: `filebeat` | [[field-agent-version]] -agent.version +<> | Version of the agent. @@ -237,7 +237,7 @@ An autonomous system (AS) is a collection of connected Internet Protocol (IP) ro | [[field-as-number]] -as.number +<> | Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. @@ -253,7 +253,7 @@ example: `15169` | [[field-as-organization-name]] -as.organization.name +<> | Organization name. @@ -305,7 +305,7 @@ Client / server representations can add semantic context to an exchange, which i | [[field-client-address]] -client.address +<> | 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. @@ -323,7 +323,7 @@ type: keyword | [[field-client-bytes]] -client.bytes +<> | Bytes sent from the client to the server. @@ -339,7 +339,7 @@ example: `184` | [[field-client-domain]] -client.domain +<> | Client domain. @@ -355,7 +355,7 @@ type: keyword | [[field-client-ip]] -client.ip +<> | IP address of the client (IPv4 or IPv6). @@ -371,7 +371,7 @@ type: ip | [[field-client-mac]] -client.mac +<> | MAC address of the client. @@ -387,7 +387,7 @@ type: keyword | [[field-client-nat-ip]] -client.nat.ip +<> | Translated IP of source based NAT sessions (e.g. internal client to internet). @@ -405,7 +405,7 @@ type: ip | [[field-client-nat-port]] -client.nat.port +<> | Translated port of source based NAT sessions (e.g. internal client to internet). @@ -423,7 +423,7 @@ type: long | [[field-client-packets]] -client.packets +<> | Packets sent from the client to the server. @@ -439,7 +439,7 @@ example: `12` | [[field-client-port]] -client.port +<> | Port of the client. @@ -455,7 +455,7 @@ type: long | [[field-client-registered-domain]] -client.registered_domain +<> | The highest registered client domain, stripped of the subdomain. @@ -475,7 +475,7 @@ example: `example.com` | [[field-client-subdomain]] -client.subdomain +<> | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. @@ -493,7 +493,7 @@ example: `east` | [[field-client-top-level-domain]] -client.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -564,7 +564,7 @@ Fields related to the cloud or infrastructure the events are coming from. | [[field-cloud-account-id]] -cloud.account.id +<> | The cloud account or organization id used to identify different entities in a multi-tenant environment. @@ -582,7 +582,7 @@ example: `666777888999` | [[field-cloud-account-name]] -cloud.account.name +<> | The cloud account name or alias used to identify different entities in a multi-tenant environment. @@ -600,7 +600,7 @@ example: `elastic-dev` | [[field-cloud-availability-zone]] -cloud.availability_zone +<> | Availability zone in which this host is running. @@ -616,7 +616,7 @@ example: `us-east-1c` | [[field-cloud-instance-id]] -cloud.instance.id +<> | Instance ID of the host machine. @@ -632,7 +632,7 @@ example: `i-1234567890abcdef0` | [[field-cloud-instance-name]] -cloud.instance.name +<> | Instance name of the host machine. @@ -648,7 +648,7 @@ type: keyword | [[field-cloud-machine-type]] -cloud.machine.type +<> | Machine type of the host machine. @@ -664,7 +664,7 @@ example: `t2.medium` | [[field-cloud-project-id]] -cloud.project.id +<> | The cloud project identifier. @@ -682,7 +682,7 @@ example: `my-project` | [[field-cloud-project-name]] -cloud.project.name +<> | The cloud project name. @@ -700,7 +700,7 @@ example: `my project` | [[field-cloud-provider]] -cloud.provider +<> | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. @@ -716,7 +716,7 @@ example: `aws` | [[field-cloud-region]] -cloud.region +<> | Region in which this host is running. @@ -748,7 +748,7 @@ These fields contain information about binary code signatures. | [[field-code-signature-exists]] -code_signature.exists +<> | Boolean to capture if a signature is present. @@ -764,7 +764,7 @@ example: `true` | [[field-code-signature-status]] -code_signature.status +<> | Additional information about the certificate status. @@ -782,7 +782,7 @@ example: `ERROR_UNTRUSTED_ROOT` | [[field-code-signature-subject-name]] -code_signature.subject_name +<> | Subject name of the code signer @@ -798,7 +798,7 @@ example: `Microsoft Corporation` | [[field-code-signature-trusted]] -code_signature.trusted +<> | Stores the trust status of the certificate chain. @@ -816,7 +816,7 @@ example: `true` | [[field-code-signature-valid]] -code_signature.valid +<> | Boolean to capture if the digital signature is verified against the binary content. @@ -862,7 +862,7 @@ These fields help correlate data based containers from any runtime. | [[field-container-id]] -container.id +<> | Unique container id. @@ -878,7 +878,7 @@ type: keyword | [[field-container-image-name]] -container.image.name +<> | Name of the image the container was built on. @@ -894,7 +894,7 @@ type: keyword | [[field-container-image-tag]] -container.image.tag +<> | Container image tags. @@ -913,7 +913,7 @@ Note: this field should contain an array of values. | [[field-container-labels]] -container.labels +<> | Image labels. @@ -929,7 +929,7 @@ type: object | [[field-container-name]] -container.name +<> | Container name. @@ -945,7 +945,7 @@ type: keyword | [[field-container-runtime]] -container.runtime +<> | Runtime managing this container. @@ -979,7 +979,7 @@ Destination fields are usually populated in conjunction with source fields. The | [[field-destination-address]] -destination.address +<> | 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. @@ -997,7 +997,7 @@ type: keyword | [[field-destination-bytes]] -destination.bytes +<> | Bytes sent from the destination to the source. @@ -1013,7 +1013,7 @@ example: `184` | [[field-destination-domain]] -destination.domain +<> | Destination domain. @@ -1029,7 +1029,7 @@ type: keyword | [[field-destination-ip]] -destination.ip +<> | IP address of the destination (IPv4 or IPv6). @@ -1045,7 +1045,7 @@ type: ip | [[field-destination-mac]] -destination.mac +<> | MAC address of the destination. @@ -1061,7 +1061,7 @@ type: keyword | [[field-destination-nat-ip]] -destination.nat.ip +<> | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) @@ -1079,7 +1079,7 @@ type: ip | [[field-destination-nat-port]] -destination.nat.port +<> | Port the source session is translated to by NAT Device. @@ -1097,7 +1097,7 @@ type: long | [[field-destination-packets]] -destination.packets +<> | Packets sent from the destination to the source. @@ -1113,7 +1113,7 @@ example: `12` | [[field-destination-port]] -destination.port +<> | Port of the destination. @@ -1129,7 +1129,7 @@ type: long | [[field-destination-registered-domain]] -destination.registered_domain +<> | The highest registered destination domain, stripped of the subdomain. @@ -1149,7 +1149,7 @@ example: `example.com` | [[field-destination-subdomain]] -destination.subdomain +<> | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. @@ -1167,7 +1167,7 @@ example: `east` | [[field-destination-top-level-domain]] -destination.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -1248,7 +1248,7 @@ Many operating systems refer to "shared code libraries" with different names, bu | [[field-dll-name]] -dll.name +<> | Name of the library. @@ -1266,7 +1266,7 @@ example: `kernel32.dll` | [[field-dll-path]] -dll.path +<> | Full file path of the library. @@ -1337,7 +1337,7 @@ DNS events should either represent a single DNS query prior to getting answers ( | [[field-dns-answers]] -dns.answers +<> | An array containing an object for each answer section returned by the server. @@ -1360,7 +1360,7 @@ Note: this field should contain an array of values. | [[field-dns-answers-class]] -dns.answers.class +<> | The class of DNS data contained in this resource record. @@ -1376,7 +1376,7 @@ example: `IN` | [[field-dns-answers-data]] -dns.answers.data +<> | The data describing the resource. @@ -1394,7 +1394,7 @@ example: `10.10.10.10` | [[field-dns-answers-name]] -dns.answers.name +<> | The domain name to which this resource record pertains. @@ -1412,7 +1412,7 @@ example: `www.example.com` | [[field-dns-answers-ttl]] -dns.answers.ttl +<> | 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. @@ -1428,7 +1428,7 @@ example: `180` | [[field-dns-answers-type]] -dns.answers.type +<> | The type of data contained in this resource record. @@ -1444,7 +1444,7 @@ example: `CNAME` | [[field-dns-header-flags]] -dns.header_flags +<> | Array of 2 letter DNS header flags. @@ -1465,7 +1465,7 @@ example: `["RD", "RA"]` | [[field-dns-id]] -dns.id +<> | The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response. @@ -1481,7 +1481,7 @@ example: `62111` | [[field-dns-op-code]] -dns.op_code +<> | 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. @@ -1497,7 +1497,7 @@ example: `QUERY` | [[field-dns-question-class]] -dns.question.class +<> | The class of records being queried. @@ -1513,7 +1513,7 @@ example: `IN` | [[field-dns-question-name]] -dns.question.name +<> | The name being queried. @@ -1531,7 +1531,7 @@ example: `www.example.com` | [[field-dns-question-registered-domain]] -dns.question.registered_domain +<> | The highest registered domain, stripped of the subdomain. @@ -1551,7 +1551,7 @@ example: `example.com` | [[field-dns-question-subdomain]] -dns.question.subdomain +<> | The subdomain is all of the labels under the registered_domain. @@ -1569,7 +1569,7 @@ example: `www` | [[field-dns-question-top-level-domain]] -dns.question.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -1587,7 +1587,7 @@ example: `co.uk` | [[field-dns-question-type]] -dns.question.type +<> | The type of record being queried. @@ -1603,7 +1603,7 @@ example: `AAAA` | [[field-dns-resolved-ip]] -dns.resolved_ip +<> | Array containing all IPs seen in `answers.data`. @@ -1624,7 +1624,7 @@ example: `["10.10.10.10", "10.10.10.11"]` | [[field-dns-response-code]] -dns.response_code +<> | The DNS response code. @@ -1640,7 +1640,7 @@ example: `NOERROR` | [[field-dns-type]] -dns.type +<> | The type of DNS event captured, query or answer. @@ -1676,7 +1676,7 @@ Meta-information specific to ECS. | [[field-ecs-version]] -ecs.version +<> | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. @@ -1712,7 +1712,7 @@ Use them for errors that happen while fetching events or in cases where the even | [[field-error-code]] -error.code +<> | Error code describing the error. @@ -1728,7 +1728,7 @@ type: keyword | [[field-error-id]] -error.id +<> | Unique identifier for the error. @@ -1744,7 +1744,7 @@ type: keyword | [[field-error-message]] -error.message +<> | Error message. @@ -1760,7 +1760,7 @@ type: text | [[field-error-stack-trace]] -error.stack_trace +<> | The stack trace of this error in plain text. @@ -1782,7 +1782,7 @@ Multi-fields: | [[field-error-type]] -error.type +<> | The type of the error, for example the class name of the exception. @@ -1816,7 +1816,7 @@ A log is defined as an event containing details of something that happened. Log | [[field-event-action]] -event.action +<> | The action captured by the event. @@ -1834,7 +1834,7 @@ example: `user-password-change` | [[field-event-category]] -event.category +<> | This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. @@ -1864,7 +1864,7 @@ To learn more about when to use which value, visit the page | [[field-event-code]] -event.code +<> | Identification code for this event, if one exists. @@ -1882,7 +1882,7 @@ example: `4648` | [[field-event-created]] -event.created +<> | event.created contains the date/time when the event was first read by an agent, or by your pipeline. @@ -1904,7 +1904,7 @@ example: `2016-05-23T08:05:34.857Z` | [[field-event-dataset]] -event.dataset +<> | Name of the dataset. @@ -1924,7 +1924,7 @@ example: `apache.access` | [[field-event-duration]] -event.duration +<> | Duration of the event in nanoseconds. @@ -1942,7 +1942,7 @@ type: long | [[field-event-end]] -event.end +<> | event.end contains the date when the event ended or when the activity was last observed. @@ -1958,7 +1958,7 @@ type: date | [[field-event-hash]] -event.hash +<> | Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity. @@ -1974,7 +1974,7 @@ example: `123456789012345678901234567890ABCD` | [[field-event-id]] -event.id +<> | Unique ID to describe the event. @@ -1990,7 +1990,7 @@ example: `8a4f500d` | [[field-event-ingested]] -event.ingested +<> | Timestamp when an event arrived in the central data store. @@ -2010,7 +2010,7 @@ example: `2016-05-23T08:05:35.101Z` | [[field-event-kind]] -event.kind +<> | This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. @@ -2037,7 +2037,7 @@ To learn more about when to use which value, visit the page | [[field-event-module]] -event.module +<> | Name of the module this data is coming from. @@ -2055,7 +2055,7 @@ example: `apache` | [[field-event-original]] -event.original +<> | Raw text message of entire event. Used to demonstrate log integrity. @@ -2073,7 +2073,7 @@ example: `Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0& | [[field-event-outcome]] -event.outcome +<> | This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. @@ -2104,7 +2104,7 @@ To learn more about when to use which value, visit the page | [[field-event-provider]] -event.provider +<> | Source of the event. @@ -2122,7 +2122,7 @@ example: `kernel` | [[field-event-reason]] -event.reason +<> | Reason why this event happened, according to the source. @@ -2140,7 +2140,7 @@ example: `Terminated an unexpected process` | [[field-event-reference]] -event.reference +<> | Reference URL linking to additional information about this event. @@ -2158,7 +2158,7 @@ example: `https://system.example.com/event/#0001234` | [[field-event-risk-score]] -event.risk_score +<> | Risk score or priority of the event (e.g. security solutions). Use your system's original value here. @@ -2174,7 +2174,7 @@ type: float | [[field-event-risk-score-norm]] -event.risk_score_norm +<> | Normalized risk score or priority of the event, on a scale of 0 to 100. @@ -2192,7 +2192,7 @@ type: float | [[field-event-sequence]] -event.sequence +<> | Sequence number of the event. @@ -2210,7 +2210,7 @@ type: long | [[field-event-severity]] -event.severity +<> | The numeric severity of the event according to your event source. @@ -2230,7 +2230,7 @@ example: `7` | [[field-event-start]] -event.start +<> | event.start contains the date when the event started or when the activity was first observed. @@ -2246,7 +2246,7 @@ type: date | [[field-event-timezone]] -event.timezone +<> | 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. @@ -2264,7 +2264,7 @@ type: keyword | [[field-event-type]] -event.type +<> | This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. @@ -2294,7 +2294,7 @@ To learn more about when to use which value, visit the page | [[field-event-url]] -event.url +<> | URL linking to an external system to continue investigation of this event. @@ -2330,7 +2330,7 @@ File objects can be associated with host events, network events, and/or file eve | [[field-file-accessed]] -file.accessed +<> | Last time the file was accessed. @@ -2348,7 +2348,7 @@ type: date | [[field-file-attributes]] -file.attributes +<> | Array of file attributes. @@ -2369,7 +2369,7 @@ example: `["readonly", "system"]` | [[field-file-created]] -file.created +<> | File creation time. @@ -2387,7 +2387,7 @@ type: date | [[field-file-ctime]] -file.ctime +<> | Last time the file attributes or metadata changed. @@ -2405,7 +2405,7 @@ type: date | [[field-file-device]] -file.device +<> | Device that is the source of the file. @@ -2421,7 +2421,7 @@ example: `sda` | [[field-file-directory]] -file.directory +<> | Directory where the file is located. It should include the drive letter, when appropriate. @@ -2437,7 +2437,7 @@ example: `/home/alice` | [[field-file-drive-letter]] -file.drive_letter +<> | Drive letter where the file is located. This field is only relevant on Windows. @@ -2455,7 +2455,7 @@ example: `C` | [[field-file-extension]] -file.extension +<> | File extension, excluding the leading dot. @@ -2473,7 +2473,7 @@ example: `png` | [[field-file-gid]] -file.gid +<> | Primary group ID (GID) of the file. @@ -2489,7 +2489,7 @@ example: `1001` | [[field-file-group]] -file.group +<> | Primary group name of the file. @@ -2505,7 +2505,7 @@ example: `alice` | [[field-file-inode]] -file.inode +<> | Inode representing the file in the filesystem. @@ -2521,7 +2521,7 @@ example: `256383` | [[field-file-mime-type]] -file.mime_type +<> | MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. @@ -2537,7 +2537,7 @@ type: keyword | [[field-file-mode]] -file.mode +<> | Mode of the file in octal representation. @@ -2553,7 +2553,7 @@ example: `0640` | [[field-file-mtime]] -file.mtime +<> | Last time the file content was modified. @@ -2569,7 +2569,7 @@ type: date | [[field-file-name]] -file.name +<> | Name of the file including the extension, without the directory. @@ -2585,7 +2585,7 @@ example: `example.png` | [[field-file-owner]] -file.owner +<> | File owner's username. @@ -2601,7 +2601,7 @@ example: `alice` | [[field-file-path]] -file.path +<> | Full path to the file, including the file name. It should include the drive letter, when appropriate. @@ -2623,7 +2623,7 @@ example: `/home/alice/example.png` | [[field-file-size]] -file.size +<> | File size in bytes. @@ -2641,7 +2641,7 @@ example: `16384` | [[field-file-target-path]] -file.target_path +<> | Target path for symlinks. @@ -2663,7 +2663,7 @@ Multi-fields: | [[field-file-type]] -file.type +<> | File type (file, dir, or symlink). @@ -2679,7 +2679,7 @@ example: `file` | [[field-file-uid]] -file.uid +<> | The user ID (UID) or security identifier (SID) of the file owner. @@ -2756,7 +2756,7 @@ This geolocation information can be derived from techniques such as Geo IP, or b | [[field-geo-city-name]] -geo.city_name +<> | City name. @@ -2772,7 +2772,7 @@ example: `Montreal` | [[field-geo-continent-name]] -geo.continent_name +<> | Name of the continent. @@ -2788,7 +2788,7 @@ example: `North America` | [[field-geo-country-iso-code]] -geo.country_iso_code +<> | Country ISO code. @@ -2804,7 +2804,7 @@ example: `CA` | [[field-geo-country-name]] -geo.country_name +<> | Country name. @@ -2820,7 +2820,7 @@ example: `Canada` | [[field-geo-location]] -geo.location +<> | Longitude and latitude. @@ -2836,7 +2836,7 @@ example: `{ "lon": -73.614830, "lat": 45.505918 }` | [[field-geo-name]] -geo.name +<> | User-defined description of a location, at the level of granularity they care about. @@ -2856,7 +2856,7 @@ example: `boston-dc` | [[field-geo-region-iso-code]] -geo.region_iso_code +<> | Region ISO code. @@ -2872,7 +2872,7 @@ example: `CA-QC` | [[field-geo-region-name]] -geo.region_name +<> | Region name. @@ -2914,7 +2914,7 @@ The group fields are meant to represent groups that are relevant to the event. | [[field-group-domain]] -group.domain +<> | Name of the directory the group is a member of. @@ -2932,7 +2932,7 @@ type: keyword | [[field-group-id]] -group.id +<> | Unique identifier for the group on the system/platform. @@ -2948,7 +2948,7 @@ type: keyword | [[field-group-name]] -group.name +<> | Name of the group. @@ -2992,7 +2992,7 @@ Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for ot | [[field-hash-md5]] -hash.md5 +<> | MD5 hash. @@ -3008,7 +3008,7 @@ type: keyword | [[field-hash-sha1]] -hash.sha1 +<> | SHA1 hash. @@ -3024,7 +3024,7 @@ type: keyword | [[field-hash-sha256]] -hash.sha256 +<> | SHA256 hash. @@ -3040,7 +3040,7 @@ type: keyword | [[field-hash-sha512]] -hash.sha512 +<> | SHA512 hash. @@ -3084,7 +3084,7 @@ ECS host.* fields should be populated with details about the host on which the e | [[field-host-architecture]] -host.architecture +<> | Operating system architecture. @@ -3100,7 +3100,7 @@ example: `x86_64` | [[field-host-domain]] -host.domain +<> | Name of the domain of which the host is a member. @@ -3118,7 +3118,7 @@ example: `CONTOSO` | [[field-host-hostname]] -host.hostname +<> | Hostname of the host. @@ -3136,7 +3136,7 @@ type: keyword | [[field-host-id]] -host.id +<> | Unique host id. @@ -3156,7 +3156,7 @@ type: keyword | [[field-host-ip]] -host.ip +<> | Host ip addresses. @@ -3175,7 +3175,7 @@ Note: this field should contain an array of values. | [[field-host-mac]] -host.mac +<> | Host mac addresses. @@ -3194,7 +3194,7 @@ Note: this field should contain an array of values. | [[field-host-name]] -host.name +<> | Name of the host. @@ -3212,7 +3212,7 @@ type: keyword | [[field-host-type]] -host.type +<> | Type of host. @@ -3230,7 +3230,7 @@ type: keyword | [[field-host-uptime]] -host.uptime +<> | Seconds the host has been up. @@ -3299,7 +3299,7 @@ Fields related to HTTP activity. Use the `url` field set to store the url of the | [[field-http-request-body-bytes]] -http.request.body.bytes +<> | Size in bytes of the request body. @@ -3315,7 +3315,7 @@ example: `887` | [[field-http-request-body-content]] -http.request.body.content +<> | The full HTTP request body. @@ -3337,7 +3337,7 @@ example: `Hello world` | [[field-http-request-bytes]] -http.request.bytes +<> | Total size in bytes of the request (body and headers). @@ -3353,7 +3353,7 @@ example: `1437` | [[field-http-request-method]] -http.request.method +<> | HTTP request method. @@ -3375,7 +3375,7 @@ example: `GET, POST, PUT, PoST` | [[field-http-request-mime-type]] -http.request.mime_type +<> | Mime type of the body of the request. @@ -3393,7 +3393,7 @@ example: `image/gif` | [[field-http-request-referrer]] -http.request.referrer +<> | Referrer for this HTTP request. @@ -3409,7 +3409,7 @@ example: `https://blog.example.com/` | [[field-http-response-body-bytes]] -http.response.body.bytes +<> | Size in bytes of the response body. @@ -3425,7 +3425,7 @@ example: `887` | [[field-http-response-body-content]] -http.response.body.content +<> | The full HTTP response body. @@ -3447,7 +3447,7 @@ example: `Hello world` | [[field-http-response-bytes]] -http.response.bytes +<> | Total size in bytes of the response (body and headers). @@ -3463,7 +3463,7 @@ example: `1437` | [[field-http-response-mime-type]] -http.response.mime_type +<> | Mime type of the body of the response. @@ -3481,7 +3481,7 @@ example: `image/gif` | [[field-http-response-status-code]] -http.response.status_code +<> | HTTP response status code. @@ -3497,7 +3497,7 @@ example: `404` | [[field-http-version]] -http.version +<> | HTTP version. @@ -3529,7 +3529,7 @@ The interface fields are used to record ingress and egress interface information | [[field-interface-alias]] -interface.alias +<> | Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. @@ -3545,7 +3545,7 @@ example: `outside` | [[field-interface-id]] -interface.id +<> | Interface ID as reported by an observer (typically SNMP interface ID). @@ -3561,7 +3561,7 @@ example: `10` | [[field-interface-name]] -interface.name +<> | Interface name as reported by the system. @@ -3607,7 +3607,7 @@ The details specific to your event source are typically not logged under `log.*` | [[field-log-file-path]] -log.file.path +<> | Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. @@ -3625,7 +3625,7 @@ example: `/var/log/fun-times.log` | [[field-log-level]] -log.level +<> | Original log level of the log event. @@ -3645,7 +3645,7 @@ example: `error` | [[field-log-logger]] -log.logger +<> | The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name. @@ -3661,7 +3661,7 @@ example: `org.elasticsearch.bootstrap.Bootstrap` | [[field-log-origin-file-line]] -log.origin.file.line +<> | The line number of the file containing the source code which originated the log event. @@ -3677,7 +3677,7 @@ example: `42` | [[field-log-origin-file-name]] -log.origin.file.name +<> | The name of the file containing the source code which originated the log event. @@ -3695,7 +3695,7 @@ example: `Bootstrap.java` | [[field-log-origin-function]] -log.origin.function +<> | The name of the function or method which originated the log event. @@ -3711,7 +3711,7 @@ example: `init` | [[field-log-original]] -log.original +<> | This is the original log message and contains the full log message before splitting it up in multiple parts. @@ -3731,7 +3731,7 @@ example: `Sep 19 08:26:10 localhost My log` | [[field-log-syslog]] -log.syslog +<> | The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164. @@ -3747,7 +3747,7 @@ type: object | [[field-log-syslog-facility-code]] -log.syslog.facility.code +<> | The Syslog numeric facility of the log event, if available. @@ -3765,7 +3765,7 @@ example: `23` | [[field-log-syslog-facility-name]] -log.syslog.facility.name +<> | The Syslog text-based facility of the log event, if available. @@ -3781,7 +3781,7 @@ example: `local7` | [[field-log-syslog-priority]] -log.syslog.priority +<> | Syslog numeric priority of the event, if available. @@ -3799,7 +3799,7 @@ example: `135` | [[field-log-syslog-severity-code]] -log.syslog.severity.code +<> | The Syslog numeric severity of the log event, if available. @@ -3817,7 +3817,7 @@ example: `3` | [[field-log-syslog-severity-name]] -log.syslog.severity.name +<> | The Syslog numeric severity of the log event, if available. @@ -3853,7 +3853,7 @@ The network.* fields should be populated with details about the network activity | [[field-network-application]] -network.application +<> | A name given to an application level protocol. This can be arbitrarily assigned for things like microservices, but also apply to things like skype, icq, facebook, twitter. This would be used in situations where the vendor or service can be decoded such as from the source/dest IP owners, ports, or wire format. @@ -3871,7 +3871,7 @@ example: `aim` | [[field-network-bytes]] -network.bytes +<> | Total bytes transferred in both directions. @@ -3889,7 +3889,7 @@ example: `368` | [[field-network-community-id]] -network.community_id +<> | A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. @@ -3907,7 +3907,7 @@ example: `1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=` | [[field-network-direction]] -network.direction +<> | Direction of the network traffic. @@ -3947,7 +3947,7 @@ example: `inbound` | [[field-network-forwarded-ip]] -network.forwarded_ip +<> | Host IP address when the source IP address is the proxy. @@ -3963,7 +3963,7 @@ example: `192.1.1.2` | [[field-network-iana-number]] -network.iana_number +<> | IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number. @@ -3979,7 +3979,7 @@ example: `6` | [[field-network-inner]] -network.inner +<> | Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.) @@ -3995,7 +3995,7 @@ type: object | [[field-network-name]] -network.name +<> | Name given by operators to sections of their network. @@ -4011,7 +4011,7 @@ example: `Guest Wifi` | [[field-network-packets]] -network.packets +<> | Total packets transferred in both directions. @@ -4029,7 +4029,7 @@ example: `24` | [[field-network-protocol]] -network.protocol +<> | L7 Network protocol name. ex. http, lumberjack, transport protocol. @@ -4047,7 +4047,7 @@ example: `http` | [[field-network-transport]] -network.transport +<> | Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) @@ -4065,7 +4065,7 @@ example: `tcp` | [[field-network-type]] -network.type +<> | In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc @@ -4132,7 +4132,7 @@ This could be a custom hardware appliance or a server that has been configured t | [[field-observer-egress]] -observer.egress +<> | Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. @@ -4148,7 +4148,7 @@ type: object | [[field-observer-egress-zone]] -observer.egress.zone +<> | Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. @@ -4164,7 +4164,7 @@ example: `Public_Internet` | [[field-observer-hostname]] -observer.hostname +<> | Hostname of the observer. @@ -4180,7 +4180,7 @@ type: keyword | [[field-observer-ingress]] -observer.ingress +<> | Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. @@ -4196,7 +4196,7 @@ type: object | [[field-observer-ingress-zone]] -observer.ingress.zone +<> | Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc. @@ -4212,7 +4212,7 @@ example: `DMZ` | [[field-observer-ip]] -observer.ip +<> | IP addresses of the observer. @@ -4231,7 +4231,7 @@ Note: this field should contain an array of values. | [[field-observer-mac]] -observer.mac +<> | MAC addresses of the observer @@ -4250,7 +4250,7 @@ Note: this field should contain an array of values. | [[field-observer-name]] -observer.name +<> | Custom name of the observer. @@ -4270,7 +4270,7 @@ example: `1_proxySG` | [[field-observer-product]] -observer.product +<> | The product name of the observer. @@ -4286,7 +4286,7 @@ example: `s200` | [[field-observer-serial-number]] -observer.serial_number +<> | Observer serial number. @@ -4302,7 +4302,7 @@ type: keyword | [[field-observer-type]] -observer.type +<> | The type of the observer the data is coming from. @@ -4320,7 +4320,7 @@ example: `firewall` | [[field-observer-vendor]] -observer.vendor +<> | Vendor name of the observer. @@ -4336,7 +4336,7 @@ example: `Symantec` | [[field-observer-version]] -observer.version +<> | Observer version. @@ -4425,7 +4425,7 @@ These fields help you arrange or filter data stored in an index by one or multip | [[field-organization-id]] -organization.id +<> | Unique identifier for the organization. @@ -4441,7 +4441,7 @@ type: keyword | [[field-organization-name]] -organization.name +<> | Organization name. @@ -4479,7 +4479,7 @@ The OS fields contain information about the operating system. | [[field-os-family]] -os.family +<> | OS family (such as redhat, debian, freebsd, windows). @@ -4495,7 +4495,7 @@ example: `debian` | [[field-os-full]] -os.full +<> | Operating system name, including the version or code name. @@ -4517,7 +4517,7 @@ example: `Mac OS Mojave` | [[field-os-kernel]] -os.kernel +<> | Operating system kernel version as a raw string. @@ -4533,7 +4533,7 @@ example: `4.4.0-112-generic` | [[field-os-name]] -os.name +<> | Operating system name, without the version. @@ -4555,7 +4555,7 @@ example: `Mac OS X` | [[field-os-platform]] -os.platform +<> | Operating system platform (such centos, ubuntu, windows). @@ -4571,7 +4571,7 @@ example: `darwin` | [[field-os-type]] -os.type +<> | Use the `os.type` field to categorize the operating system into one of the broad commercial families. @@ -4591,7 +4591,7 @@ example: `macos` | [[field-os-version]] -os.version +<> | Operating system version as a raw string. @@ -4633,7 +4633,7 @@ These fields contain information about an installed software package. It contain | [[field-package-architecture]] -package.architecture +<> | Package architecture. @@ -4649,7 +4649,7 @@ example: `x86_64` | [[field-package-build-version]] -package.build_version +<> | Additional information about the build version of the installed package. @@ -4667,7 +4667,7 @@ example: `36f4f7e89dd61b0988b12ee000b98966867710cd` | [[field-package-checksum]] -package.checksum +<> | Checksum of the installed package for verification. @@ -4683,7 +4683,7 @@ example: `68b329da9893e34099c7d8ad5cb9c940` | [[field-package-description]] -package.description +<> | Description of the package. @@ -4699,7 +4699,7 @@ example: `Open source programming language to build simple/reliable/efficient so | [[field-package-install-scope]] -package.install_scope +<> | Indicating how the package was installed, e.g. user-local, global. @@ -4715,7 +4715,7 @@ example: `global` | [[field-package-installed]] -package.installed +<> | Time when package was installed. @@ -4731,7 +4731,7 @@ type: date | [[field-package-license]] -package.license +<> | License under which the package was released. @@ -4749,7 +4749,7 @@ example: `Apache License 2.0` | [[field-package-name]] -package.name +<> | Package name @@ -4765,7 +4765,7 @@ example: `go` | [[field-package-path]] -package.path +<> | Path where the package is installed. @@ -4781,7 +4781,7 @@ example: `/usr/local/Cellar/go/1.12.9/` | [[field-package-reference]] -package.reference +<> | Home page or reference URL of the software in this package, if available. @@ -4797,7 +4797,7 @@ example: `https://golang.org` | [[field-package-size]] -package.size +<> | Package size in bytes. @@ -4813,7 +4813,7 @@ example: `62231` | [[field-package-type]] -package.type +<> | Type of package. @@ -4831,7 +4831,7 @@ example: `rpm` | [[field-package-version]] -package.version +<> | Package version @@ -4863,7 +4863,7 @@ These fields contain Windows Portable Executable (PE) metadata. | [[field-pe-architecture]] -pe.architecture +<> | CPU architecture target for the file. @@ -4879,7 +4879,7 @@ example: `x64` | [[field-pe-company]] -pe.company +<> | Internal company name of the file, provided at compile-time. @@ -4895,7 +4895,7 @@ example: `Microsoft Corporation` | [[field-pe-description]] -pe.description +<> | Internal description of the file, provided at compile-time. @@ -4911,7 +4911,7 @@ example: `Paint` | [[field-pe-file-version]] -pe.file_version +<> | Internal version of the file, provided at compile-time. @@ -4927,7 +4927,7 @@ example: `6.3.9600.17415` | [[field-pe-imphash]] -pe.imphash +<> | A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. @@ -4945,7 +4945,7 @@ example: `0c6803c4e922103c4dca5963aad36ddf` | [[field-pe-original-file-name]] -pe.original_file_name +<> | Internal name of the file, provided at compile-time. @@ -4961,7 +4961,7 @@ example: `MSPAINT.EXE` | [[field-pe-product]] -pe.product +<> | Internal product name of the file, provided at compile-time. @@ -5005,7 +5005,7 @@ These fields can help you correlate metrics information with a process id/name f | [[field-process-args]] -process.args +<> | Array of process arguments, starting with the absolute path to the executable. @@ -5026,7 +5026,7 @@ example: `["/usr/bin/ssh", "-l", "user", "10.0.0.16"]` | [[field-process-args-count]] -process.args_count +<> | Length of the process.args array. @@ -5044,7 +5044,7 @@ example: `4` | [[field-process-command-line]] -process.command_line +<> | Full command line that started the process, including the absolute path to the executable, and all arguments. @@ -5068,7 +5068,7 @@ example: `/usr/bin/ssh -l user 10.0.0.16` | [[field-process-entity-id]] -process.entity_id +<> | Unique identifier for the process. @@ -5088,7 +5088,7 @@ example: `c2c455d9f99375d` | [[field-process-executable]] -process.executable +<> | Absolute path to the process executable. @@ -5110,7 +5110,7 @@ example: `/usr/bin/ssh` | [[field-process-exit-code]] -process.exit_code +<> | The exit code of the process, if this is a termination event. @@ -5128,7 +5128,7 @@ example: `137` | [[field-process-name]] -process.name +<> | Process name. @@ -5152,7 +5152,7 @@ example: `ssh` | [[field-process-pgid]] -process.pgid +<> | Identifier of the group of processes the process belongs to. @@ -5168,7 +5168,7 @@ type: long | [[field-process-pid]] -process.pid +<> | Process id. @@ -5184,7 +5184,7 @@ example: `4242` | [[field-process-ppid]] -process.ppid +<> | Parent process' pid. @@ -5200,7 +5200,7 @@ example: `4241` | [[field-process-start]] -process.start +<> | The time the process started. @@ -5216,7 +5216,7 @@ example: `2016-05-23T08:05:34.853Z` | [[field-process-thread-id]] -process.thread.id +<> | Thread ID. @@ -5232,7 +5232,7 @@ example: `4242` | [[field-process-thread-name]] -process.thread.name +<> | Thread name. @@ -5248,7 +5248,7 @@ example: `thread-0` | [[field-process-title]] -process.title +<> | Process title. @@ -5272,7 +5272,7 @@ Multi-fields: | [[field-process-uptime]] -process.uptime +<> | Seconds the process has been up. @@ -5288,7 +5288,7 @@ example: `1325` | [[field-process-working-directory]] -process.working_directory +<> | The working directory of the process. @@ -5373,7 +5373,7 @@ Fields related to Windows Registry operations. | [[field-registry-data-bytes]] -registry.data.bytes +<> | Original bytes written with base64 encoding. @@ -5391,7 +5391,7 @@ example: `ZQBuAC0AVQBTAAAAZQBuAAAAAAA=` | [[field-registry-data-strings]] -registry.data.strings +<> | Content when writing string types. @@ -5412,7 +5412,7 @@ example: `["C:\rta\red_ttp\bin\myapp.exe"]` | [[field-registry-data-type]] -registry.data.type +<> | Standard registry type for encoding contents @@ -5428,7 +5428,7 @@ example: `REG_SZ` | [[field-registry-hive]] -registry.hive +<> | Abbreviated name for the hive. @@ -5444,7 +5444,7 @@ example: `HKLM` | [[field-registry-key]] -registry.key +<> | Hive-relative path of keys. @@ -5460,7 +5460,7 @@ example: `SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Opti | [[field-registry-path]] -registry.path +<> | Full path, including hive, key and value @@ -5476,7 +5476,7 @@ example: `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution | [[field-registry-value]] -registry.value +<> | Name of the value written. @@ -5512,7 +5512,7 @@ A concrete example is IP addresses, which can be under host, observer, source, d | [[field-related-hash]] -related.hash +<> | All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). @@ -5531,7 +5531,7 @@ Note: this field should contain an array of values. | [[field-related-hosts]] -related.hosts +<> | All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases. @@ -5550,7 +5550,7 @@ Note: this field should contain an array of values. | [[field-related-ip]] -related.ip +<> | All of the IPs seen on your event. @@ -5569,7 +5569,7 @@ Note: this field should contain an array of values. | [[field-related-user]] -related.user +<> | All the user names seen on your event. @@ -5606,7 +5606,7 @@ Examples of data sources that would populate the rule fields include: network ad | [[field-rule-author]] -rule.author +<> | Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. @@ -5625,7 +5625,7 @@ example: `["Star-Lord"]` | [[field-rule-category]] -rule.category +<> | A categorization value keyword used by the entity using the rule for detection of this event. @@ -5641,7 +5641,7 @@ example: `Attempted Information Leak` | [[field-rule-description]] -rule.description +<> | The description of the rule generating the event. @@ -5657,7 +5657,7 @@ example: `Block requests to public DNS over HTTPS / TLS protocols` | [[field-rule-id]] -rule.id +<> | A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. @@ -5673,7 +5673,7 @@ example: `101` | [[field-rule-license]] -rule.license +<> | Name of the license under which the rule used to generate this event is made available. @@ -5689,7 +5689,7 @@ example: `Apache 2.0` | [[field-rule-name]] -rule.name +<> | The name of the rule or signature generating the event. @@ -5705,7 +5705,7 @@ example: `BLOCK_DNS_over_TLS` | [[field-rule-reference]] -rule.reference +<> | Reference URL to additional information about the rule used to generate this event. @@ -5723,7 +5723,7 @@ example: `https://en.wikipedia.org/wiki/DNS_over_TLS` | [[field-rule-ruleset]] -rule.ruleset +<> | Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. @@ -5739,7 +5739,7 @@ example: `Standard_Protocol_Filters` | [[field-rule-uuid]] -rule.uuid +<> | A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. @@ -5755,7 +5755,7 @@ example: `1100110011` | [[field-rule-version]] -rule.version +<> | The version / revision of the rule being used for analysis. @@ -5791,7 +5791,7 @@ Client / server representations can add semantic context to an exchange, which i | [[field-server-address]] -server.address +<> | Some event server 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. @@ -5809,7 +5809,7 @@ type: keyword | [[field-server-bytes]] -server.bytes +<> | Bytes sent from the server to the client. @@ -5825,7 +5825,7 @@ example: `184` | [[field-server-domain]] -server.domain +<> | Server domain. @@ -5841,7 +5841,7 @@ type: keyword | [[field-server-ip]] -server.ip +<> | IP address of the server (IPv4 or IPv6). @@ -5857,7 +5857,7 @@ type: ip | [[field-server-mac]] -server.mac +<> | MAC address of the server. @@ -5873,7 +5873,7 @@ type: keyword | [[field-server-nat-ip]] -server.nat.ip +<> | Translated ip of destination based NAT sessions (e.g. internet to private DMZ) @@ -5891,7 +5891,7 @@ type: ip | [[field-server-nat-port]] -server.nat.port +<> | Translated port of destination based NAT sessions (e.g. internet to private DMZ) @@ -5909,7 +5909,7 @@ type: long | [[field-server-packets]] -server.packets +<> | Packets sent from the server to the client. @@ -5925,7 +5925,7 @@ example: `12` | [[field-server-port]] -server.port +<> | Port of the server. @@ -5941,7 +5941,7 @@ type: long | [[field-server-registered-domain]] -server.registered_domain +<> | The highest registered server domain, stripped of the subdomain. @@ -5961,7 +5961,7 @@ example: `example.com` | [[field-server-subdomain]] -server.subdomain +<> | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. @@ -5979,7 +5979,7 @@ example: `east` | [[field-server-top-level-domain]] -server.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -6052,7 +6052,7 @@ These fields help you find and correlate logs for a specific service and version | [[field-service-ephemeral-id]] -service.ephemeral_id +<> | Ephemeral identifier of this service (if one exists). @@ -6070,7 +6070,7 @@ example: `8a4f500f` | [[field-service-id]] -service.id +<> | Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes. @@ -6090,7 +6090,7 @@ example: `d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6` | [[field-service-name]] -service.name +<> | Name of the service data is collected from. @@ -6110,7 +6110,7 @@ example: `elasticsearch-metrics` | [[field-service-node-name]] -service.node.name +<> | Name of a service node. @@ -6130,7 +6130,7 @@ example: `instance-0000000016` | [[field-service-state]] -service.state +<> | Current state of the service. @@ -6146,7 +6146,7 @@ type: keyword | [[field-service-type]] -service.type +<> | The type of the service data is collected from. @@ -6166,7 +6166,7 @@ example: `elasticsearch` | [[field-service-version]] -service.version +<> | Version of the service the data was collected from. @@ -6202,7 +6202,7 @@ Source fields are usually populated in conjunction with destination fields. The | [[field-source-address]] -source.address +<> | Some event source 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. @@ -6220,7 +6220,7 @@ type: keyword | [[field-source-bytes]] -source.bytes +<> | Bytes sent from the source to the destination. @@ -6236,7 +6236,7 @@ example: `184` | [[field-source-domain]] -source.domain +<> | Source domain. @@ -6252,7 +6252,7 @@ type: keyword | [[field-source-ip]] -source.ip +<> | IP address of the source (IPv4 or IPv6). @@ -6268,7 +6268,7 @@ type: ip | [[field-source-mac]] -source.mac +<> | MAC address of the source. @@ -6284,7 +6284,7 @@ type: keyword | [[field-source-nat-ip]] -source.nat.ip +<> | Translated ip of source based NAT sessions (e.g. internal client to internet) @@ -6302,7 +6302,7 @@ type: ip | [[field-source-nat-port]] -source.nat.port +<> | Translated port of source based NAT sessions. (e.g. internal client to internet) @@ -6320,7 +6320,7 @@ type: long | [[field-source-packets]] -source.packets +<> | Packets sent from the source to the destination. @@ -6336,7 +6336,7 @@ example: `12` | [[field-source-port]] -source.port +<> | Port of the source. @@ -6352,7 +6352,7 @@ type: long | [[field-source-registered-domain]] -source.registered_domain +<> | The highest registered source domain, stripped of the subdomain. @@ -6372,7 +6372,7 @@ example: `example.com` | [[field-source-subdomain]] -source.subdomain +<> | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. @@ -6390,7 +6390,7 @@ example: `east` | [[field-source-top-level-domain]] -source.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -6463,7 +6463,7 @@ These fields are for users to classify alerts from all of their sources (e.g. ID | [[field-threat-framework]] -threat.framework +<> | Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events. @@ -6479,7 +6479,7 @@ example: `MITRE ATT&CK` | [[field-threat-tactic-id]] -threat.tactic.id +<> | The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) @@ -6498,7 +6498,7 @@ example: `TA0002` | [[field-threat-tactic-name]] -threat.tactic.name +<> | Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/) @@ -6517,7 +6517,7 @@ example: `Execution` | [[field-threat-tactic-reference]] -threat.tactic.reference +<> | The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) @@ -6536,7 +6536,7 @@ example: `https://attack.mitre.org/tactics/TA0002/` | [[field-threat-technique-id]] -threat.technique.id +<> | The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) @@ -6555,7 +6555,7 @@ example: `T1059` | [[field-threat-technique-name]] -threat.technique.name +<> | The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) @@ -6580,7 +6580,7 @@ example: `Command and Scripting Interpreter` | [[field-threat-technique-reference]] -threat.technique.reference +<> | The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) @@ -6599,7 +6599,7 @@ example: `https://attack.mitre.org/techniques/T1059/` | [[field-threat-technique-subtechnique-id]] -threat.technique.subtechnique.id +<> | The full id of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) @@ -6618,7 +6618,7 @@ example: `T1059.001` | [[field-threat-technique-subtechnique-name]] -threat.technique.subtechnique.name +<> | The name of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) @@ -6643,7 +6643,7 @@ example: `PowerShell` | [[field-threat-technique-subtechnique-reference]] -threat.technique.subtechnique.reference +<> | The reference url of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) @@ -6678,7 +6678,7 @@ Fields related to a TLS connection. These fields focus on the TLS protocol itsel | [[field-tls-cipher]] -tls.cipher +<> | String indicating the cipher used during the current connection. @@ -6694,7 +6694,7 @@ example: `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` | [[field-tls-client-certificate]] -tls.client.certificate +<> | PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. @@ -6710,7 +6710,7 @@ example: `MII...` | [[field-tls-client-certificate-chain]] -tls.client.certificate_chain +<> | Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. @@ -6729,7 +6729,7 @@ example: `["MII...", "MII..."]` | [[field-tls-client-hash-md5]] -tls.client.hash.md5 +<> | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -6745,7 +6745,7 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` | [[field-tls-client-hash-sha1]] -tls.client.hash.sha1 +<> | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -6761,7 +6761,7 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` | [[field-tls-client-hash-sha256]] -tls.client.hash.sha256 +<> | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -6777,7 +6777,7 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` | [[field-tls-client-issuer]] -tls.client.issuer +<> | Distinguished name of subject of the issuer of the x.509 certificate presented by the client. @@ -6793,7 +6793,7 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` | [[field-tls-client-ja3]] -tls.client.ja3 +<> | A hash that identifies clients based on how they perform an SSL/TLS handshake. @@ -6809,7 +6809,7 @@ example: `d4e5b18d6b55c71272893221c96ba240` | [[field-tls-client-not-after]] -tls.client.not_after +<> | Date/Time indicating when client certificate is no longer considered valid. @@ -6825,7 +6825,7 @@ example: `2021-01-01T00:00:00.000Z` | [[field-tls-client-not-before]] -tls.client.not_before +<> | Date/Time indicating when client certificate is first considered valid. @@ -6841,7 +6841,7 @@ example: `1970-01-01T00:00:00.000Z` | [[field-tls-client-server-name]] -tls.client.server_name +<> | Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to `destination.domain`. @@ -6857,7 +6857,7 @@ example: `www.elastic.co` | [[field-tls-client-subject]] -tls.client.subject +<> | Distinguished name of subject of the x.509 certificate presented by the client. @@ -6873,7 +6873,7 @@ example: `CN=myclient, OU=Documentation Team, DC=example, DC=com` | [[field-tls-client-supported-ciphers]] -tls.client.supported_ciphers +<> | Array of ciphers offered by the client during the client hello. @@ -6892,7 +6892,7 @@ example: `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_25 | [[field-tls-curve]] -tls.curve +<> | String indicating the curve used for the given cipher, when applicable. @@ -6908,7 +6908,7 @@ example: `secp256r1` | [[field-tls-established]] -tls.established +<> | Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. @@ -6924,7 +6924,7 @@ type: boolean | [[field-tls-next-protocol]] -tls.next_protocol +<> | String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. @@ -6940,7 +6940,7 @@ example: `http/1.1` | [[field-tls-resumed]] -tls.resumed +<> | Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. @@ -6956,7 +6956,7 @@ type: boolean | [[field-tls-server-certificate]] -tls.server.certificate +<> | PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. @@ -6972,7 +6972,7 @@ example: `MII...` | [[field-tls-server-certificate-chain]] -tls.server.certificate_chain +<> | Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. @@ -6991,7 +6991,7 @@ example: `["MII...", "MII..."]` | [[field-tls-server-hash-md5]] -tls.server.hash.md5 +<> | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -7007,7 +7007,7 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` | [[field-tls-server-hash-sha1]] -tls.server.hash.sha1 +<> | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -7023,7 +7023,7 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` | [[field-tls-server-hash-sha256]] -tls.server.hash.sha256 +<> | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. @@ -7039,7 +7039,7 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` | [[field-tls-server-issuer]] -tls.server.issuer +<> | Subject of the issuer of the x.509 certificate presented by the server. @@ -7055,7 +7055,7 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` | [[field-tls-server-ja3s]] -tls.server.ja3s +<> | A hash that identifies servers based on how they perform an SSL/TLS handshake. @@ -7071,7 +7071,7 @@ example: `394441ab65754e2207b1e1b457b3641d` | [[field-tls-server-not-after]] -tls.server.not_after +<> | Timestamp indicating when server certificate is no longer considered valid. @@ -7087,7 +7087,7 @@ example: `2021-01-01T00:00:00.000Z` | [[field-tls-server-not-before]] -tls.server.not_before +<> | Timestamp indicating when server certificate is first considered valid. @@ -7103,7 +7103,7 @@ example: `1970-01-01T00:00:00.000Z` | [[field-tls-server-subject]] -tls.server.subject +<> | Subject of the x.509 certificate presented by the server. @@ -7119,7 +7119,7 @@ example: `CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com` | [[field-tls-version]] -tls.version +<> | Numeric part of the version parsed from the original string. @@ -7135,7 +7135,7 @@ example: `1.2` | [[field-tls-version-protocol]] -tls.version_protocol +<> | Normalized lowercase protocol name parsed from original string. @@ -7198,7 +7198,7 @@ Distributed tracing makes it possible to analyze performance throughout a micros | [[field-span-id]] -span.id +<> | Unique identifier of the span within the scope of its trace. @@ -7216,7 +7216,7 @@ example: `3ff9a8981b7ccd5a` | [[field-trace-id]] -trace.id +<> | Unique identifier of the trace. @@ -7234,7 +7234,7 @@ example: `4bf92f3577b34da6a3ce929d0e0e4736` | [[field-transaction-id]] -transaction.id +<> | Unique identifier of the transaction within the scope of its trace. @@ -7268,7 +7268,7 @@ URL fields provide support for complete or partial URLs, and supports the breaki | [[field-url-domain]] -url.domain +<> | Domain of the url, such as "www.elastic.co". @@ -7286,7 +7286,7 @@ example: `www.elastic.co` | [[field-url-extension]] -url.extension +<> | The field contains the file extension from the original request url. @@ -7306,7 +7306,7 @@ example: `png` | [[field-url-fragment]] -url.fragment +<> | Portion of the url after the `#`, such as "top". @@ -7324,7 +7324,7 @@ type: keyword | [[field-url-full]] -url.full +<> | If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source. @@ -7346,7 +7346,7 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top` | [[field-url-original]] -url.original +<> | Unmodified original url as seen in the event source. @@ -7372,7 +7372,7 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=ela | [[field-url-password]] -url.password +<> | Password of the request. @@ -7388,7 +7388,7 @@ type: keyword | [[field-url-path]] -url.path +<> | Path of the request, such as "/search". @@ -7404,7 +7404,7 @@ type: keyword | [[field-url-port]] -url.port +<> | Port of the request, such as 443. @@ -7420,7 +7420,7 @@ example: `443` | [[field-url-query]] -url.query +<> | The query field describes the query string of the request, such as "q=elasticsearch". @@ -7438,7 +7438,7 @@ type: keyword | [[field-url-registered-domain]] -url.registered_domain +<> | The highest registered url domain, stripped of the subdomain. @@ -7458,7 +7458,7 @@ example: `example.com` | [[field-url-scheme]] -url.scheme +<> | Scheme of the request, such as "https". @@ -7476,7 +7476,7 @@ example: `https` | [[field-url-subdomain]] -url.subdomain +<> | The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. @@ -7494,7 +7494,7 @@ example: `east` | [[field-url-top-level-domain]] -url.top_level_domain +<> | The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". @@ -7512,7 +7512,7 @@ example: `co.uk` | [[field-url-username]] -url.username +<> | Username of the request. @@ -7546,7 +7546,7 @@ Fields can have one entry or multiple entries. If a user has more than one id, p | [[field-user-domain]] -user.domain +<> | Name of the directory the user is a member of. @@ -7564,7 +7564,7 @@ type: keyword | [[field-user-email]] -user.email +<> | User email address. @@ -7580,7 +7580,7 @@ type: keyword | [[field-user-full-name]] -user.full_name +<> | User's full name, if available. @@ -7602,7 +7602,7 @@ example: `Albert Einstein` | [[field-user-hash]] -user.hash +<> | Unique user hash to correlate information for a user in anonymized form. @@ -7620,7 +7620,7 @@ type: keyword | [[field-user-id]] -user.id +<> | Unique identifier of the user. @@ -7636,7 +7636,7 @@ type: keyword | [[field-user-name]] -user.name +<> | Short name or login of the user. @@ -7658,7 +7658,7 @@ example: `albert` | [[field-user-roles]] -user.roles +<> | Array of user roles at the time of the event. @@ -7724,7 +7724,7 @@ They often show up in web service logs coming from the parsed user agent string. | [[field-user-agent-device-name]] -user_agent.device.name +<> | Name of the device. @@ -7740,7 +7740,7 @@ example: `iPhone` | [[field-user-agent-name]] -user_agent.name +<> | Name of the user agent. @@ -7756,7 +7756,7 @@ example: `Safari` | [[field-user-agent-original]] -user_agent.original +<> | Unparsed user_agent string. @@ -7778,7 +7778,7 @@ example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605 | [[field-user-agent-version]] -user_agent.version +<> | Version of the user agent. @@ -7841,7 +7841,7 @@ Observer.ingress and observer.egress VLAN values are used to record observer spe | [[field-vlan-id]] -vlan.id +<> | VLAN ID as reported by the observer. @@ -7857,7 +7857,7 @@ example: `10` | [[field-vlan-name]] -vlan.name +<> | Optional VLAN name as reported by the observer. @@ -7899,7 +7899,7 @@ The vulnerability fields describe information about a vulnerability that is rele | [[field-vulnerability-category]] -vulnerability.category +<> | The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm[Qualys vulnerability categories]) @@ -7920,7 +7920,7 @@ example: `["Firewall"]` | [[field-vulnerability-classification]] -vulnerability.classification +<> | The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/) @@ -7936,7 +7936,7 @@ example: `CVSS` | [[field-vulnerability-description]] -vulnerability.description +<> | The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created[Common Vulnerabilities and Exposure CVE description]) @@ -7958,7 +7958,7 @@ example: `In macOS before 2.12.6, there is a vulnerability in the RPC...` | [[field-vulnerability-enumeration]] -vulnerability.enumeration +<> | The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/) @@ -7974,7 +7974,7 @@ example: `CVE` | [[field-vulnerability-id]] -vulnerability.id +<> | The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)[Common Vulnerabilities and Exposure CVE ID] @@ -7990,7 +7990,7 @@ example: `CVE-2019-00001` | [[field-vulnerability-reference]] -vulnerability.reference +<> | A resource that provides additional information, context, and mitigations for the identified vulnerability. @@ -8006,7 +8006,7 @@ example: `https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111` | [[field-vulnerability-report-id]] -vulnerability.report_id +<> | The report or scan identification number. @@ -8022,7 +8022,7 @@ example: `20191018.0001` | [[field-vulnerability-scanner-vendor]] -vulnerability.scanner.vendor +<> | The name of the vulnerability scanner vendor. @@ -8038,7 +8038,7 @@ example: `Tenable` | [[field-vulnerability-score-base]] -vulnerability.score.base +<> | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. @@ -8056,7 +8056,7 @@ example: `5.5` | [[field-vulnerability-score-environmental]] -vulnerability.score.environmental +<> | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. @@ -8074,7 +8074,7 @@ example: `5.5` | [[field-vulnerability-score-temporal]] -vulnerability.score.temporal +<> | Scores can range from 0.0 to 10.0, with 10.0 being the most severe. @@ -8092,7 +8092,7 @@ type: float | [[field-vulnerability-score-version]] -vulnerability.score.version +<> | The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification. @@ -8110,7 +8110,7 @@ example: `2.0` | [[field-vulnerability-severity]] -vulnerability.severity +<> | The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss) @@ -8146,7 +8146,7 @@ Events that contain certificate information about network connections, should us | [[field-x509-alternative-names]] -x509.alternative_names +<> | List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses. @@ -8165,7 +8165,7 @@ example: `*.elastic.co` | [[field-x509-issuer-common-name]] -x509.issuer.common_name +<> | List of common name (CN) of issuing certificate authority. @@ -8184,7 +8184,7 @@ example: `Example SHA2 High Assurance Server CA` | [[field-x509-issuer-country]] -x509.issuer.country +<> | List of country (C) codes @@ -8203,7 +8203,7 @@ example: `US` | [[field-x509-issuer-distinguished-name]] -x509.issuer.distinguished_name +<> | Distinguished name (DN) of issuing certificate authority. @@ -8219,7 +8219,7 @@ example: `C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assuranc | [[field-x509-issuer-locality]] -x509.issuer.locality +<> | List of locality names (L) @@ -8238,7 +8238,7 @@ example: `Mountain View` | [[field-x509-issuer-organization]] -x509.issuer.organization +<> | List of organizations (O) of issuing certificate authority. @@ -8257,7 +8257,7 @@ example: `Example Inc` | [[field-x509-issuer-organizational-unit]] -x509.issuer.organizational_unit +<> | List of organizational units (OU) of issuing certificate authority. @@ -8276,7 +8276,7 @@ example: `www.example.com` | [[field-x509-issuer-state-or-province]] -x509.issuer.state_or_province +<> | List of state or province names (ST, S, or P) @@ -8295,7 +8295,7 @@ example: `California` | [[field-x509-not-after]] -x509.not_after +<> | Time at which the certificate is no longer considered valid. @@ -8311,7 +8311,7 @@ example: `2020-07-16 03:15:39+00:00` | [[field-x509-not-before]] -x509.not_before +<> | Time at which the certificate is first considered valid. @@ -8327,7 +8327,7 @@ example: `2019-08-16 01:40:25+00:00` | [[field-x509-public-key-algorithm]] -x509.public_key_algorithm +<> | Algorithm used to generate the public key. @@ -8343,7 +8343,7 @@ example: `RSA` | [[field-x509-public-key-curve]] -x509.public_key_curve +<> | The curve used by the elliptic curve public key algorithm. This is algorithm specific. @@ -8359,7 +8359,7 @@ example: `nistp521` | [[field-x509-public-key-exponent]] -x509.public_key_exponent +<> | Exponent used to derive the public key. This is algorithm specific. @@ -8375,7 +8375,7 @@ example: `65537` | [[field-x509-public-key-size]] -x509.public_key_size +<> | The size of the public key space in bits. @@ -8391,7 +8391,7 @@ example: `2048` | [[field-x509-serial-number]] -x509.serial_number +<> | Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters. @@ -8407,7 +8407,7 @@ example: `55FBB9C7DEBF09809D12CCAA` | [[field-x509-signature-algorithm]] -x509.signature_algorithm +<> | Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353. @@ -8423,7 +8423,7 @@ example: `SHA256-RSA` | [[field-x509-subject-common-name]] -x509.subject.common_name +<> | List of common names (CN) of subject. @@ -8442,7 +8442,7 @@ example: `shared.global.example.net` | [[field-x509-subject-country]] -x509.subject.country +<> | List of country (C) code @@ -8461,7 +8461,7 @@ example: `US` | [[field-x509-subject-distinguished-name]] -x509.subject.distinguished_name +<> | Distinguished name (DN) of the certificate subject entity. @@ -8477,7 +8477,7 @@ example: `C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.globa | [[field-x509-subject-locality]] -x509.subject.locality +<> | List of locality names (L) @@ -8496,7 +8496,7 @@ example: `San Francisco` | [[field-x509-subject-organization]] -x509.subject.organization +<> | List of organizations (O) of subject. @@ -8515,7 +8515,7 @@ example: `Example, Inc.` | [[field-x509-subject-organizational-unit]] -x509.subject.organizational_unit +<> | List of organizational units (OU) of subject. @@ -8534,7 +8534,7 @@ Note: this field should contain an array of values. | [[field-x509-subject-state-or-province]] -x509.subject.state_or_province +<> | List of state or province names (ST, S, or P) @@ -8553,7 +8553,7 @@ example: `California` | [[field-x509-version-number]] -x509.version_number +<> | Version of x509 format. diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index ef2a203632..6e606f8783 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -34,7 +34,7 @@ beta::[ {{ fieldset['beta'] }}] {# `Field` column -#} | [[field-{{field['dashed_name']}}]] -{{ field['flat_name'] }} +<> {# `Description` column -#} {#- Beta fields will add the `beta` label -#} From 8c4db4e0b7ec19070044dea57bd08096d5e1aae1 Mon Sep 17 00:00:00 2001 From: Mathieu Martin Date: Wed, 25 Nov 2020 11:42:45 -0500 Subject: [PATCH 4/4] Rebuild experimental artifacts as well --- experimental/generated/ecs/ecs_flat.yml | 2 +- experimental/generated/ecs/ecs_nested.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml index 5aefba80d3..f1014738e9 100644 --- a/experimental/generated/ecs/ecs_flat.yml +++ b/experimental/generated/ecs/ecs_flat.yml @@ -1,5 +1,5 @@ '@timestamp': - dashed_name: -timestamp + dashed_name: timestamp description: 'Date/time when the event originated. This is the date/time extracted from the event, typically representing when the diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml index 977a5c2232..87ca6d4449 100644 --- a/experimental/generated/ecs/ecs_nested.yml +++ b/experimental/generated/ecs/ecs_nested.yml @@ -158,7 +158,7 @@ base: events. These fields are common across all types of events. fields: '@timestamp': - dashed_name: -timestamp + dashed_name: timestamp description: 'Date/time when the event originated. This is the date/time extracted from the event, typically representing when