ECS fields

Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline. Required field for all events.

type: date

example: 2016-05-23T08:05:34.853Z

required: True

Custom key/value pairs. Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword. Example: docker and k8s labels.

type: object

example: {"application": "foo-bar", "env": "production"}

For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message.

type: text

example: Hello World

List of keywords used to tag each event.

type: keyword

example: ["production", "env2"]

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.

type: keyword

example: metricbeat version 7.6.0 (amd64), libbeat 7.6.0 [6a23e8f8f30f5001ba344e4e54d8d9cb82cb107c built 2020-02-05 23:10:10 +0000 UTC]

Ephemeral identifier of this agent (if one exists). This id normally changes across restarts, but agent.id does not.

type: keyword

example: 8a4f500f

Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id.

type: keyword

example: 8a4f500d

Custom name of the agent. This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from. If no name is given, the name is often left empty.

type: keyword

example: foo

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.

type: keyword

example: filebeat

Version of the agent.

type: keyword

example: 6.0.0-rc2

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

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.

type: keyword

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

Bytes sent from the client to the server.

type: long

example: 184

format: bytes

Client domain.

type: keyword

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

IP address of the client (IPv4 or IPv6).

type: ip

MAC address of the client. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: 00-00-5E-00-53-23

Translated IP of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers.

type: ip

Translated port of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers.

type: long

format: string

Packets sent from the client to the server.

type: long

example: 12

Port of the client.

type: long

format: string

The highest registered client domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

type: keyword

example: example.com

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.

type: keyword

example: east

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".

type: keyword

example: co.uk

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

User email address.

type: keyword

User’s full name, if available.

type: keyword

example: Albert Einstein

type: text

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

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.

type: keyword

Unique identifier of the user.

type: keyword

Short name or login of the user.

type: keyword

example: albert

type: text

Array of user roles at the time of the event.

type: keyword

example: ["kibana_admin", "reporting_user"]

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.

type: keyword

example: 666777888999

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.

type: keyword

example: elastic-dev

Availability zone in which this host, resource, or service is located.

type: keyword

example: us-east-1c

Instance ID of the host machine.

type: keyword

example: i-1234567890abcdef0

Instance name of the host machine.

type: keyword

Machine type of the host machine.

type: keyword

example: t2.medium

The cloud project identifier. Examples: Google Cloud Project id, Azure Project id.

type: keyword

example: my-project

The cloud project name. Examples: Google Cloud Project name, Azure Project name.

type: keyword

example: my project

Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.

type: keyword

example: aws

Region in which this host, resource, or service is located.

type: keyword

example: us-east-1

The cloud service name is intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server. Examples: app engine, app service, cloud run, fargate, lambda.

type: keyword

example: lambda

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

Unique container id.

type: keyword

Name of the image the container was built on.

type: keyword

Container image tags.

type: keyword

Image labels.

type: object

Container name.

type: keyword

Runtime managing this container.

type: keyword

example: docker

The field can contain anything that makes sense to signify the source of the data. Examples include nginx.access, prometheus, endpoint etc. For data streams that otherwise fit, but that do not have dataset set we use the value "generic" for the dataset value. event.dataset should have the same value as data_stream.dataset. Beyond the Elasticsearch data stream naming criteria noted above, the dataset value has additional restrictions: * Must not contain - * No longer than 100 characters

type: constant_keyword

example: nginx.access

A user defined namespace. Namespaces are useful to allow grouping of data. Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with default. If no value is used, it falls back to default. Beyond the Elasticsearch index naming criteria noted above, namespace value has the additional restrictions: * Must not contain - * No longer than 100 characters

type: constant_keyword

example: production

An overarching type for the data stream. Currently allowed values are "logs" and "metrics". We expect to also add "traces" and "synthetics" in the near future.

type: constant_keyword

example: logs

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.

type: keyword

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

Bytes sent from the destination to the source.

type: long

example: 184

format: bytes

Destination domain.

type: keyword

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

IP address of the destination (IPv4 or IPv6).

type: ip

MAC address of the destination. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: 00-00-5E-00-53-23

Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers.

type: ip

Port the source session is translated to by NAT Device. Typically used with load balancers, firewalls, or routers.

type: long

format: string

Packets sent from the destination to the source.

type: long

example: 12

Port of the destination.

type: long

format: string

The highest registered destination domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

type: keyword

example: example.com

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.

type: keyword

example: east

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".

type: keyword

example: co.uk

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

User email address.

type: keyword

User’s full name, if available.

type: keyword

example: Albert Einstein

type: text

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

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.

type: keyword

Unique identifier of the user.

type: keyword

Short name or login of the user.

type: keyword

example: albert

type: text

Array of user roles at the time of the event.

type: keyword

example: ["kibana_admin", "reporting_user"]

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Name of the library. This generally maps to the name of the file on disk.

type: keyword

example: kernel32.dll

Full file path of the library.

type: keyword

example: C:\Windows\System32\kernel32.dll

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

An array containing an object for each answer section returned by the server. The main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines. Not all DNS data sources give all details about DNS answers. At minimum, answer objects must contain the data key. If more information is available, map as much of it to ECS as possible, and add any additional fields to the answer objects as custom fields.

type: object

The class of DNS data contained in this resource record.

type: keyword

example: IN

The data describing the resource. The meaning of this data depends on the type and class of the resource record.

type: keyword

example: 10.10.10.10

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.

type: keyword

example: www.example.com

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

example: 180

The type of data contained in this resource record.

type: keyword

example: CNAME

Array of 2 letter DNS header flags. Expected values are: AA, TC, RD, RA, AD, CD, DO.

type: keyword

example: ["RD", "RA"]

The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response.

type: keyword

example: 62111

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

example: QUERY

The class of records being queried.

type: keyword

example: IN

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.

type: keyword

example: www.example.com

The highest registered domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

type: keyword

example: example.com

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.

type: keyword

example: www

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".

type: keyword

example: co.uk

The type of record being queried.

type: keyword

example: AAAA

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.

type: ip

example: ["10.10.10.10", "10.10.10.11"]

The DNS response code.

type: keyword

example: NOERROR

The type of DNS event captured, query or answer. If your source of DNS events only gives you DNS queries, you should only create dns events of type dns.type:query. If your source of DNS events gives you answers as well, you should create one event per query (optionally as soon as the query is seen). And a second event containing all query details as well as an array of answers.

type: keyword

example: answer

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.

type: keyword

example: 1.0.0

required: True

Machine architecture of the ELF file.

type: keyword

example: x86-64

Byte sequence of ELF file.

type: keyword

example: Little Endian

CPU type of the ELF file.

type: keyword

example: Intel

Extracted when possible from the file’s metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date

List of exported element names and types.

type: flattened

Version of the ELF Application Binary Interface (ABI).

type: keyword

Header class of the ELF file.

type: keyword

Data table of the ELF header.

type: keyword

Header entrypoint of the ELF file.

type: long

format: string

"0x1" for original ELF files.

type: keyword

Application Binary Interface (ABI) of the Linux OS.

type: keyword

Header type of the ELF file.

type: keyword

Version of the ELF header.

type: keyword

List of imported element names and types.

type: flattened

An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.sections.*.

type: nested

Chi-square probability distribution of the section.

type: long

format: number

Shannon entropy calculation from the section.

type: long

format: number

ELF Section List flags.

type: keyword

ELF Section List name.

type: keyword

ELF Section List offset.

type: keyword

ELF Section List physical size.

type: long

format: bytes

ELF Section List type.

type: keyword

ELF Section List virtual address.

type: long

format: string

ELF Section List virtual size.

type: long

format: string

An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.segments.*.

type: nested

ELF object segment sections.

type: keyword

ELF object segment type.

type: keyword

List of shared libraries used by this ELF object.

type: keyword

telfhash symbol hash for ELF file.

type: keyword

Error code describing the error.

type: keyword

Unique identifier for the error.

type: keyword

Error message.

type: text

The stack trace of this error in plain text.

type: keyword

Field is not indexed.

type: text

The type of the error, for example the class name of the exception.

type: keyword

example: java.lang.NullPointerException

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.

type: keyword

example: user-password-change

Agents are normally responsible for populating the agent.id field value. If the system receiving events is capable of validating the value based on authentication information for the client then this field can be used to reflect the outcome of that validation. For example if the agent’s connection is authenticated with mTLS and the client cert contains the ID of the agent to which the cert was issued then the agent.id value in events can be checked against the certificate. If the values match then event.agent_id_status: verified is added to the event, otherwise one of the other allowed values should be used. If no validation is performed then the field should be omitted. The allowed values are: verified - The agent.id field value matches expected value obtained from auth metadata. mismatch - The agent.id field value does not match the expected value obtained from auth metadata. missing - There was no agent.id field in the event to validate. auth_metadata_missing - There was no auth metadata or it was missing information about the agent ID.

type: keyword

example: verified

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. This field is an array. This will allow proper categorization of some events that fall in multiple categories.

type: keyword

example: authentication

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.

type: keyword

example: 4648

event.created contains the date/time when the event was first read by an agent, or by your pipeline. This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event. In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent’s or pipeline’s ability to keep up with your event source. In case the two timestamps are identical, @timestamp should be used.

type: date

example: 2016-05-23T08:05:34.857Z

Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It’s recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.

type: keyword

example: apache.access

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.

type: long

format: duration

event.end contains the date when the event ended or when the activity was last observed.

type: date

Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.

type: keyword

example: 123456789012345678901234567890ABCD

Unique ID to describe the event.

type: keyword

example: 8a4f500d

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. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested.

type: date

example: 2016-05-23T08:05:35.101Z

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. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.

type: keyword

example: alert

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.

type: keyword

example: apache

Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from _source. If users wish to override this and index this field, please see Field data types in the Elasticsearch Reference.

type: keyword

example: Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0|100| worm successfully stopped|10|src=10.0.0.1 dst=2.1.2.2spt=1232

Field is not indexed.

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. Note that when a single transaction is described in multiple events, each event may populate different values of event.outcome, according to their perspective. Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer. Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with event.type:info, or any events for which an outcome does not make logical sense.

type: keyword

example: success

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).

type: keyword

example: kernel

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).

type: keyword

example: Terminated an unexpected process

Reference URL linking to additional information about this event. This URL links to a static definition of this event. Alert events, indicated by event.kind:alert, are a common use case for this field.

type: keyword

example: https://system.example.com/event/#0001234

Risk score or priority of the event (e.g. security solutions). Use your system’s original value here.

type: float

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.

type: float

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.

type: long

format: string

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. The Syslog severity belongs in log.syslog.severity.code. event.severity is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the log.syslog.severity.code to event.severity.

type: long

example: 7

format: string

event.start contains the date when the event started or when the activity was first observed.

type: date

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").

type: keyword

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. This field is an array. This will allow proper categorization of some events that fall in multiple event types.

type: keyword

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.

type: keyword

example: https://mysystem.example.com/alert/5271dedb-f5b0-4218-87f0-4ac4870a38fe

Last time the file was accessed. Note that not all filesystems keep track of access time.

type: date

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.

type: keyword

example: ["readonly", "system"]

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

File creation time. Note that not all filesystems store the creation time.

type: date

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.

type: date

Device that is the source of the file.

type: keyword

example: sda

Directory where the file is located. It should include the drive letter, when appropriate.

type: keyword

example: /home/alice

Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon.

type: keyword

example: C

Machine architecture of the ELF file.

type: keyword

example: x86-64

Byte sequence of ELF file.

type: keyword

example: Little Endian

CPU type of the ELF file.

type: keyword

example: Intel

Extracted when possible from the file’s metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date

List of exported element names and types.

type: flattened

Version of the ELF Application Binary Interface (ABI).

type: keyword

Header class of the ELF file.

type: keyword

Data table of the ELF header.

type: keyword

Header entrypoint of the ELF file.

type: long

format: string

"0x1" for original ELF files.

type: keyword

Application Binary Interface (ABI) of the Linux OS.

type: keyword

Header type of the ELF file.

type: keyword

Version of the ELF header.

type: keyword

List of imported element names and types.

type: flattened

An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.sections.*.

type: nested

Chi-square probability distribution of the section.

type: long

format: number

Shannon entropy calculation from the section.

type: long

format: number

ELF Section List flags.

type: keyword

ELF Section List name.

type: keyword

ELF Section List offset.

type: keyword

ELF Section List physical size.

type: long

format: bytes

ELF Section List type.

type: keyword

ELF Section List virtual address.

type: long

format: string

ELF Section List virtual size.

type: long

format: string

An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.segments.*.

type: nested

ELF object segment sections.

type: keyword

ELF object segment type.

type: keyword

List of shared libraries used by this ELF object.

type: keyword

telfhash symbol hash for ELF file.

type: keyword

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").

type: keyword

example: png

Primary group ID (GID) of the file.

type: keyword

example: 1001

Primary group name of the file.

type: keyword

example: alice

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Inode representing the file in the filesystem.

type: keyword

example: 256383

MIME type should identify the format of the file or stream of bytes using IANA official types, where possible. When more than one type is applicable, the most specific type should be used.

type: keyword

Mode of the file in octal representation.

type: keyword

example: 0640

Last time the file content was modified.

type: date

Name of the file including the extension, without the directory.

type: keyword

example: example.png

File owner’s username.

type: keyword

example: alice

Full path to the file, including the file name. It should include the drive letter, when appropriate.

type: keyword

example: /home/alice/example.png

type: text

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

File size in bytes. Only relevant when file.type is "file".

type: long

example: 16384

Target path for symlinks.

type: keyword

type: text

File type (file, dir, or symlink).

type: keyword

example: file

The user ID (UID) or security identifier (SID) of the file owner.

type: keyword

example: 1001

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

example: *.elastic.co

List of common name (CN) of issuing certificate authority.

type: keyword

example: Example SHA2 High Assurance Server CA

List of country © codes

type: keyword

example: US

Distinguished name (DN) of issuing certificate authority.

type: keyword

example: C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA

List of locality names (L)

type: keyword

example: Mountain View

List of organizations (O) of issuing certificate authority.

type: keyword

example: Example Inc

List of organizational units (OU) of issuing certificate authority.

type: keyword

example: www.example.com

List of state or province names (ST, S, or P)

type: keyword

example: California

Time at which the certificate is no longer considered valid.

type: date

example: 2020-07-16 03:15:39+00:00

Time at which the certificate is first considered valid.

type: date

example: 2019-08-16 01:40:25+00:00

Algorithm used to generate the public key.

type: keyword

example: RSA

The curve used by the elliptic curve public key algorithm. This is algorithm specific.

type: keyword

example: nistp521

Exponent used to derive the public key. This is algorithm specific.

type: long

example: 65537

Field is not indexed.

The size of the public key space in bits.

type: long

example: 2048

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

example: 55FBB9C7DEBF09809D12CCAA

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

example: SHA256-RSA

List of common names (CN) of subject.

type: keyword

example: shared.global.example.net

List of country © code

type: keyword

example: US

Distinguished name (DN) of the certificate subject entity.

type: keyword

example: C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net

List of locality names (L)

type: keyword

example: San Francisco

List of organizations (O) of subject.

type: keyword

example: Example, Inc.

List of organizational units (OU) of subject.

type: keyword

List of state or province names (ST, S, or P)

type: keyword

example: California

Version of x509 format.

type: keyword

example: 3

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Operating system architecture.

type: keyword

example: x86_64

Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000. For example: For a two core host, this value should be the average of the two cores, between 0 and 1.

type: scaled_float

The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection.

type: long

The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection.

type: long

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.

type: keyword

example: CONTOSO

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

Hostname of the host. It normally contains what the hostname command returns on the host machine.

type: keyword

Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name.

type: keyword

Host ip addresses.

type: ip

Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: ["00-00-5E-00-53-23", "00-00-5E-00-53-24"]

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.

type: keyword

The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection.

type: long

The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection.

type: long

The number of bytes received (gauge) on all network interfaces by the host since the last metric collection.

type: long

The number of packets (gauge) received on all network interfaces by the host since the last metric collection.

type: long

OS family (such as redhat, debian, freebsd, windows).

type: keyword

example: debian

Operating system name, including the version or code name.

type: keyword

example: Mac OS Mojave

type: text

Operating system kernel version as a raw string.

type: keyword

example: 4.4.0-112-generic

Operating system name, without the version.

type: keyword

example: Mac OS X

type: text

Operating system platform (such centos, ubuntu, windows).

type: keyword

example: darwin

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. If the OS you’re dealing with is not in the list, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition.

type: keyword

example: macos

Operating system version as a raw string.

type: keyword

example: 10.14.1

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.

type: keyword

Seconds the host has been up.

type: long

example: 1325

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

User email address.

type: keyword

User’s full name, if available.

type: keyword

example: Albert Einstein

type: text

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

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.

type: keyword

Unique identifier of the user.

type: keyword

Short name or login of the user.

type: keyword

example: albert

type: text

Array of user roles at the time of the event.

type: keyword

example: ["kibana_admin", "reporting_user"]

Size in bytes of the request body.

type: long

example: 887

format: bytes

The full HTTP request body.

type: keyword

example: Hello world

type: text

Total size in bytes of the request (body and headers).

type: long

example: 1437

format: bytes

A unique identifier for each HTTP request to correlate logs between clients and servers in transactions. The id may be contained in a non-standard HTTP header, such as X-Request-ID or X-Correlation-ID.

type: keyword

example: 123e4567-e89b-12d3-a456-426614174000

HTTP request method. Prior to ECS 1.6.0 the following guidance was provided: "The field value must be normalized to lowercase for querying." As of ECS 1.6.0, the guidance is deprecated because the original case of the method may be useful in anomaly detection. Original case will be mandated in ECS 2.0.0

type: keyword

example: GET, POST, PUT, PoST

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.

type: keyword

example: image/gif

Referrer for this HTTP request.

type: keyword

example: https://blog.example.com/

Size in bytes of the response body.

type: long

example: 887

format: bytes

The full HTTP response body.

type: keyword

example: Hello world

type: text

Total size in bytes of the response (body and headers).

type: long

example: 1437

format: bytes

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.

type: keyword

example: image/gif

HTTP response status code.

type: long

example: 404

format: string

HTTP version.

type: keyword

example: 1.1

Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.

type: keyword

example: outside

Interface ID as reported by an observer (typically SNMP interface ID).

type: keyword

example: 10

Interface name as reported by the system.

type: keyword

example: eth0

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.

type: keyword

example: /var/log/fun-times.log

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). Some examples are warn, err, i, informational.

type: keyword

example: error

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

example: org.elasticsearch.bootstrap.Bootstrap

The line number of the file containing the source code which originated the log event.

type: integer

example: 42

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.

type: keyword

example: Bootstrap.java

The name of the function or method which originated the log event.

type: keyword

example: init

Deprecated for removal in next major version release. This field is superseded by event.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. This field is not indexed and doc_values are disabled so it can’t be queried but the value can be retrieved from _source.

type: keyword

example: Sep 19 08:26:10 localhost My log

Field is not indexed.

The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164.

type: object

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.

type: long

example: 23

format: string

The Syslog text-based facility of the log event, if available.

type: keyword

example: local7

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.

type: long

example: 135

format: string

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.

type: long

example: 3

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.

type: keyword

example: Error

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".

type: keyword

example: aim

Total bytes transferred in both directions. If source.bytes and destination.bytes are known, network.bytes is their sum.

type: long

example: 368

format: bytes

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.

type: keyword

example: 1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=

Direction of the network traffic. Recommended values are: * ingress * egress * inbound * outbound * internal * external * unknown

When mapping events from a host-based monitoring context, populate this field from the host’s point of view, using the values "ingress" or "egress". When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values "inbound", "outbound", "internal" or "external". Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers.

type: keyword

example: inbound

Host IP address when the source IP address is the proxy.

type: ip

example: 192.1.1.2

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

example: 6

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

VLAN ID as reported by the observer.

type: keyword

example: 10

Optional VLAN name as reported by the observer.

type: keyword

example: outside

Name given by operators to sections of their network.

type: keyword

example: Guest Wifi

Total packets transferred in both directions. If source.packets and destination.packets are known, network.packets is their sum.

type: long

example: 24

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".

type: keyword

example: http

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".

type: keyword

example: tcp

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".

type: keyword

example: ipv4

VLAN ID as reported by the observer.

type: keyword

example: 10

Optional VLAN name as reported by the observer.

type: keyword

example: outside

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

Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.

type: keyword

example: outside

Interface ID as reported by an observer (typically SNMP interface ID).

type: keyword

example: 10

Interface name as reported by the system.

type: keyword

example: eth0

VLAN ID as reported by the observer.

type: keyword

example: 10

Optional VLAN name as reported by the observer.

type: keyword

example: outside

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

example: Public_Internet

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

Hostname of the observer.

type: keyword

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

Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.

type: keyword

example: outside

Interface ID as reported by an observer (typically SNMP interface ID).

type: keyword

example: 10

Interface name as reported by the system.

type: keyword

example: eth0

VLAN ID as reported by the observer.

type: keyword

example: 10

Optional VLAN name as reported by the observer.

type: keyword

example: outside

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

example: DMZ

IP addresses of the observer.

type: ip

MAC addresses of the observer. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: ["00-00-5E-00-53-23", "00-00-5E-00-53-24"]

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. If no custom name is needed, the field can be left empty.

type: keyword

example: 1_proxySG

OS family (such as redhat, debian, freebsd, windows).

type: keyword

example: debian

Operating system name, including the version or code name.

type: keyword

example: Mac OS Mojave

type: text

Operating system kernel version as a raw string.

type: keyword

example: 4.4.0-112-generic

Operating system name, without the version.

type: keyword

example: Mac OS X

type: text

Operating system platform (such centos, ubuntu, windows).

type: keyword

example: darwin

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. If the OS you’re dealing with is not in the list, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition.

type: keyword

example: macos

Operating system version as a raw string.

type: keyword

example: 10.14.1

The product name of the observer.

type: keyword

example: s200

Observer serial number.

type: keyword

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.

type: keyword

example: firewall

Vendor name of the observer.

type: keyword

example: Symantec

Observer version.

type: keyword

API version being used to carry out the action

type: keyword

example: v1beta1

Name of the cluster.

type: keyword

URL of the API used to manage the cluster.

type: keyword

The version of the cluster.

type: keyword

Namespace in which the action is taking place.

type: keyword

example: kube-system

Organization affected by the event (for multi-tenant orchestrator setups).

type: keyword

example: elastic

Name of the resource being acted upon.

type: keyword

example: test-pod-cdcws

Type of resource being acted upon.

type: keyword

example: service

Orchestrator cluster type (e.g. kubernetes, nomad or cloudfoundry).

type: keyword

example: kubernetes

Unique identifier for the organization.

type: keyword

Organization name.

type: keyword

type: text

OS family (such as redhat, debian, freebsd, windows).

type: keyword

example: debian

Operating system name, including the version or code name.

type: keyword

example: Mac OS Mojave

type: text

Operating system kernel version as a raw string.

type: keyword

example: 4.4.0-112-generic

Operating system name, without the version.

type: keyword

example: Mac OS X

type: text

Operating system platform (such centos, ubuntu, windows).

type: keyword

example: darwin

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. If the OS you’re dealing with is not in the list, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition.

type: keyword

example: macos

Operating system version as a raw string.

type: keyword

example: 10.14.1

Package architecture.

type: keyword

example: x86_64

Additional information about the build version of the installed package. For example use the commit SHA of a non-released package.

type: keyword

example: 36f4f7e89dd61b0988b12ee000b98966867710cd

Checksum of the installed package for verification.

type: keyword

example: 68b329da9893e34099c7d8ad5cb9c940

Description of the package.

type: keyword

example: Open source programming language to build simple/reliable/efficient software.

Indicating how the package was installed, e.g. user-local, global.

type: keyword

example: global

Time when package was installed.

type: date

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/).

type: keyword

example: Apache License 2.0

Package name

type: keyword

example: go

Path where the package is installed.

type: keyword

example: /usr/local/Cellar/go/1.12.9/

Home page or reference URL of the software in this package, if available.

type: keyword

example: https://golang.org

Package size in bytes.

type: long

example: 62231

format: string

Type of package. This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar.

type: keyword

example: rpm

Package version

type: keyword

example: 1.12.9

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information.

type: keyword

example: ["/usr/bin/ssh", "-l", "user", "10.0.0.16"]

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.

type: long

example: 4

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

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.

type: keyword

example: /usr/bin/ssh -l user 10.0.0.16

type: text

Machine architecture of the ELF file.

type: keyword

example: x86-64

Byte sequence of ELF file.

type: keyword

example: Little Endian

CPU type of the ELF file.

type: keyword

example: Intel

Extracted when possible from the file’s metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date

List of exported element names and types.

type: flattened

Version of the ELF Application Binary Interface (ABI).

type: keyword

Header class of the ELF file.

type: keyword

Data table of the ELF header.

type: keyword

Header entrypoint of the ELF file.

type: long

format: string

"0x1" for original ELF files.

type: keyword

Application Binary Interface (ABI) of the Linux OS.

type: keyword

Header type of the ELF file.

type: keyword

Version of the ELF header.

type: keyword

List of imported element names and types.

type: flattened

An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.sections.*.

type: nested

Chi-square probability distribution of the section.

type: long

format: number

Shannon entropy calculation from the section.

type: long

format: number

ELF Section List flags.

type: keyword

ELF Section List name.

type: keyword

ELF Section List offset.

type: keyword

ELF Section List physical size.

type: long

format: bytes

ELF Section List type.

type: keyword

ELF Section List virtual address.

type: long

format: string

ELF Section List virtual size.

type: long

format: string

An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.segments.*.

type: nested

ELF object segment sections.

type: keyword

ELF object segment type.

type: keyword

List of shared libraries used by this ELF object.

type: keyword

telfhash symbol hash for ELF file.

type: keyword

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. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts.

type: keyword

example: c2c455d9f99375d

Absolute path to the process executable.

type: keyword

example: /usr/bin/ssh

type: text

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).

type: long

example: 137

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Process name. Sometimes called program name or similar.

type: keyword

example: ssh

type: text

Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information.

type: keyword

example: ["/usr/bin/ssh", "-l", "user", "10.0.0.16"]

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.

type: long

example: 4

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

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.

type: keyword

example: /usr/bin/ssh -l user 10.0.0.16

type: text

Machine architecture of the ELF file.

type: keyword

example: x86-64

Byte sequence of ELF file.

type: keyword

example: Little Endian

CPU type of the ELF file.

type: keyword

example: Intel

Extracted when possible from the file’s metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date

List of exported element names and types.

type: flattened

Version of the ELF Application Binary Interface (ABI).

type: keyword

Header class of the ELF file.

type: keyword

Data table of the ELF header.

type: keyword

Header entrypoint of the ELF file.

type: long

format: string

"0x1" for original ELF files.

type: keyword

Application Binary Interface (ABI) of the Linux OS.

type: keyword

Header type of the ELF file.

type: keyword

Version of the ELF header.

type: keyword

List of imported element names and types.

type: flattened

An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.sections.*.

type: nested

Chi-square probability distribution of the section.

type: long

format: number

Shannon entropy calculation from the section.

type: long

format: number

ELF Section List flags.

type: keyword

ELF Section List name.

type: keyword

ELF Section List offset.

type: keyword

ELF Section List physical size.

type: long

format: bytes

ELF Section List type.

type: keyword

ELF Section List virtual address.

type: long

format: string

ELF Section List virtual size.

type: long

format: string

An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.segments.*.

type: nested

ELF object segment sections.

type: keyword

ELF object segment type.

type: keyword

List of shared libraries used by this ELF object.

type: keyword

telfhash symbol hash for ELF file.

type: keyword

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. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts.

type: keyword

example: c2c455d9f99375d

Absolute path to the process executable.

type: keyword

example: /usr/bin/ssh

type: text

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).

type: long

example: 137

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Process name. Sometimes called program name or similar.

type: keyword

example: ssh

type: text

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

Identifier of the group of processes the process belongs to.

type: long

format: string

Process id.

type: long

example: 4242

format: string

Parent process' pid.

type: long

example: 4241

format: string

The time the process started.

type: date

example: 2016-05-23T08:05:34.853Z

Thread ID.

type: long

example: 4242

format: string

Thread name.

type: keyword

example: thread-0

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.

type: keyword

type: text

Seconds the process has been up.

type: long

example: 1325

The working directory of the process.

type: keyword

example: /home/alice

type: text

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

Identifier of the group of processes the process belongs to.

type: long

format: string

Process id.

type: long

example: 4242

format: string

Parent process' pid.

type: long

example: 4241

format: string

The time the process started.

type: date

example: 2016-05-23T08:05:34.853Z

Thread ID.

type: long

example: 4242

format: string

Thread name.

type: keyword

example: thread-0

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.

type: keyword

type: text

Seconds the process has been up.

type: long

example: 1325

The working directory of the process.

type: keyword

example: /home/alice

type: text

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.

type: keyword

example: ZQBuAC0AVQBTAAAAZQBuAAAAAAA=

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").

type: keyword

example: ["C:\rta\red_ttp\bin\myapp.exe"]

Standard registry type for encoding contents

type: keyword

example: REG_SZ

Abbreviated name for the hive.

type: keyword

example: HKLM

Hive-relative path of keys.

type: keyword

example: SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe

Full path, including hive, key and value

type: keyword

example: HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe\Debugger

Name of the value written.

type: keyword

example: Debugger

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

All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases.

type: keyword

All of the IPs seen on your event.

type: ip

All the user names or other user identifiers seen on the event.

type: keyword

Name, organization, or pseudonym of the author or authors who created the rule used to generate this event.

type: keyword

example: ["Star-Lord"]

A categorization value keyword used by the entity using the rule for detection of this event.

type: keyword

example: Attempted Information Leak

The description of the rule generating the event.

type: keyword

example: Block requests to public DNS over HTTPS / TLS protocols

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

example: 101

Name of the license under which the rule used to generate this event is made available.

type: keyword

example: Apache 2.0

The name of the rule or signature generating the event.

type: keyword

example: BLOCK_DNS_over_TLS

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.

type: keyword

example: https://en.wikipedia.org/wiki/DNS_over_TLS

Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.

type: keyword

example: Standard_Protocol_Filters

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

example: 1100110011

The version / revision of the rule being used for analysis.

type: keyword

example: 1.1

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.

type: keyword

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

Bytes sent from the server to the client.

type: long

example: 184

format: bytes

Server domain.

type: keyword

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

IP address of the server (IPv4 or IPv6).

type: ip

MAC address of the server. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: 00-00-5E-00-53-23

Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers.

type: ip

Translated port of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers.

type: long

format: string

Packets sent from the server to the client.

type: long

example: 12

Port of the server.

type: long

format: string

The highest registered server domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

type: keyword

example: example.com

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.

type: keyword

example: east

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".

type: keyword

example: co.uk

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

User email address.

type: keyword

User’s full name, if available.

type: keyword

example: Albert Einstein

type: text

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

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.

type: keyword

Unique identifier of the user.

type: keyword

Short name or login of the user.

type: keyword

example: albert

type: text

Array of user roles at the time of the event.

type: keyword

example: ["kibana_admin", "reporting_user"]

Ephemeral identifier of this service (if one exists). This id normally changes across restarts, but service.id does not.

type: keyword

example: 8a4f500f

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. Note that if you need to see the events from one specific host of the service, you should filter on that host.name or host.id instead.

type: keyword

example: d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6

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. In the case of Elasticsearch the service.name could contain the cluster name. For Beats the service.name is by default a copy of the service.type field if no name is specified.

type: keyword

example: elasticsearch-metrics

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. In the case of Elasticsearch, the service.node.name could contain the unique node name within the Elasticsearch cluster. In cases where the service doesn’t have the concept of a node name, the host name or container name can be used to distinguish running instances that make up this service. If those do not provide uniqueness (e.g. multiple instances of the service running on the same host) - the node name can be manually set.

type: keyword

example: instance-0000000016

Current state of the service.

type: keyword

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. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.

type: keyword

example: elasticsearch

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.

type: keyword

example: 3.2.4

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.

type: keyword

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

Bytes sent from the source to the destination.

type: long

example: 184

format: bytes

Source domain.

type: keyword

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

IP address of the source (IPv4 or IPv6).

type: ip

MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.

type: keyword

example: 00-00-5E-00-53-23

Translated ip of source based NAT sessions (e.g. internal client to internet) Typically connections traversing load balancers, firewalls, or routers.

type: ip

Translated port of source based NAT sessions. (e.g. internal client to internet) Typically used with load balancers, firewalls, or routers.

type: long

format: string

Packets sent from the source to the destination.

type: long

example: 12

Port of the source.

type: long

format: string

The highest registered source domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

type: keyword

example: example.com

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.

type: keyword

example: east

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".

type: keyword

example: co.uk

Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

User email address.

type: keyword

User’s full name, if available.

type: keyword

example: Albert Einstein

type: text

Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name.

type: keyword

Unique identifier for the group on the system/platform.

type: keyword

Name of the group.

type: keyword

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.

type: keyword

Unique identifier of the user.

type: keyword

Short name or login of the user.

type: keyword

example: albert

type: text

Array of user roles at the time of the event.

type: keyword

example: ["kibana_admin", "reporting_user"]

A list of associated indicators objects enriching the event, and the context of that association/enrichment.

type: nested

Object containing associated indicators enriching the event.

type: object

Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.

type: long

example: 15169

Organization name.

type: keyword

example: Google LLC

type: text

Identifies the confidence rating assigned by the provider using STIX confidence scales. Expected values: * Not Specified, None, Low, Medium, High * 0-10 * Admirality Scale (1-6) * DNI Scale (5-95) * WEP Scale (Impossible - Certain)

type: keyword

example: High

Describes the type of action conducted by the threat.

type: keyword

example: IP x.x.x.x was observed delivering the Angler EK.

Identifies a threat indicator as an email address (irrespective of direction).

type: keyword

example: phish@example.com

Last time the file was accessed. Note that not all filesystems keep track of access time.

type: date

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.

type: keyword

example: ["readonly", "system"]

Boolean to capture if a signature is present.

type: boolean

example: true

The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only.

type: keyword

example: com.apple.xpc.proxy

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.

type: keyword

example: ERROR_UNTRUSTED_ROOT

Subject name of the code signer

type: keyword

example: Microsoft Corporation

The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only.

type: keyword

example: EQHXZ8M8AV

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.

type: boolean

example: true

Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked.

type: boolean

example: true

File creation time. Note that not all filesystems store the creation time.

type: date

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.

type: date

Device that is the source of the file.

type: keyword

example: sda

Directory where the file is located. It should include the drive letter, when appropriate.

type: keyword

example: /home/alice

Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon.

type: keyword

example: C

Machine architecture of the ELF file.

type: keyword

example: x86-64

Byte sequence of ELF file.

type: keyword

example: Little Endian

CPU type of the ELF file.

type: keyword

example: Intel

Extracted when possible from the file’s metadata. Indicates when it was built or compiled. It can also be faked by malware creators.

type: date

List of exported element names and types.

type: flattened

Version of the ELF Application Binary Interface (ABI).

type: keyword

Header class of the ELF file.

type: keyword

Data table of the ELF header.

type: keyword

Header entrypoint of the ELF file.

type: long

format: string

"0x1" for original ELF files.

type: keyword

Application Binary Interface (ABI) of the Linux OS.

type: keyword

Header type of the ELF file.

type: keyword

Version of the ELF header.

type: keyword

List of imported element names and types.

type: flattened

An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.sections.*.

type: nested

Chi-square probability distribution of the section.

type: long

format: number

Shannon entropy calculation from the section.

type: long

format: number

ELF Section List flags.

type: keyword

ELF Section List name.

type: keyword

ELF Section List offset.

type: keyword

ELF Section List physical size.

type: long

format: bytes

ELF Section List type.

type: keyword

ELF Section List virtual address.

type: long

format: string

ELF Section List virtual size.

type: long

format: string

An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath elf.segments.*.

type: nested

ELF object segment sections.

type: keyword

ELF object segment type.

type: keyword

List of shared libraries used by this ELF object.

type: keyword

telfhash symbol hash for ELF file.

type: keyword

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").

type: keyword

example: png

Primary group ID (GID) of the file.

type: keyword

example: 1001

Primary group name of the file.

type: keyword

example: alice

Inode representing the file in the filesystem.

type: keyword

example: 256383

MIME type should identify the format of the file or stream of bytes using IANA official types, where possible. When more than one type is applicable, the most specific type should be used.

type: keyword

Mode of the file in octal representation.

type: keyword

example: 0640

Last time the file content was modified.

type: date

Name of the file including the extension, without the directory.

type: keyword

example: example.png

File owner’s username.

type: keyword

example: alice

Full path to the file, including the file name. It should include the drive letter, when appropriate.

type: keyword

example: /home/alice/example.png

type: text

File size in bytes. Only relevant when file.type is "file".

type: long

example: 16384

Target path for symlinks.

type: keyword

type: text

File type (file, dir, or symlink).

type: keyword

example: file

The user ID (UID) or security identifier (SID) of the file owner.

type: keyword

example: 1001

The date and time when intelligence source first reported sighting this indicator.

type: date

example: 2020-11-05T17:25:47.000Z

City name.

type: keyword

example: Montreal

Two-letter code representing continent’s name.

type: keyword

example: NA

Name of the continent.

type: keyword

example: North America

Country ISO code.

type: keyword

example: CA

Country name.

type: keyword

example: Canada

Longitude and latitude.

type: geo_point

example: { "lon": -73.614830, "lat": 45.505918 }

User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. Not typically used in automated geolocation.

type: keyword

example: boston-dc

Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country.

type: keyword

example: 94040

Region ISO code.

type: keyword

example: CA-QC

Region name.

type: keyword

example: Quebec

The time zone of the location, such as IANA time zone name.

type: keyword

example: America/Argentina/Buenos_Aires

MD5 hash.

type: keyword

SHA1 hash.

type: keyword

SHA256 hash.

type: keyword

SHA512 hash.

type: keyword

SSDEEP hash.

type: keyword

Identifies a threat indicator as an IP address (irrespective of direction).

type: ip

example: 1.2.3.4

The date and time when intelligence source last reported sighting this indicator.

type: date

example: 2020-11-05T17:25:47.000Z

Traffic Light Protocol sharing markings. Recommended values are: * WHITE * GREEN * AMBER * RED

type: keyword

example: White

The date and time when intelligence source last modified information for this indicator.

type: date

example: 2020-11-05T17:25:47.000Z

CPU architecture target for the file.

type: keyword

example: x64

Internal company name of the file, provided at compile-time.

type: keyword

example: Microsoft Corporation

Internal description of the file, provided at compile-time.

type: keyword

example: Paint

Internal version of the file, provided at compile-time.

type: keyword

example: 6.3.9600.17415

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.

type: keyword

example: 0c6803c4e922103c4dca5963aad36ddf

Internal name of the file, provided at compile-time.

type: keyword

example: MSPAINT.EXE

Internal product name of the file, provided at compile-time.

type: keyword

example: Microsoft® Windows® Operating System

Identifies a threat indicator as a port number (irrespective of direction).

type: long

example: 443

The name of the indicator’s provider.

type: keyword

example: lrz_urlhaus

Reference URL linking to additional information about this indicator.

type: keyword

example: https://system.example.com/indicator/0001234

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.

type: keyword

example: ZQBuAC0AVQBTAAAAZQBuAAAAAAA=

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").

type: keyword

example: ["C:\rta\red_ttp\bin\myapp.exe"]

Standard registry type for encoding contents

type: keyword

example: REG_SZ

Abbreviated name for the hive.

type: keyword

example: HKLM

Hive-relative path of keys.

type: keyword

example: SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe

Full path, including hive, key and value

type: keyword

example: HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe\Debugger

Name of the value written.

type: keyword

example: Debugger

Count of AV/EDR vendors that successfully detected malicious file or URL.

type: long

example: 4

Number of times this indicator was observed conducting threat activity.

type: long

example: 20

Type of indicator as represented by Cyber Observable in STIX 2.0. Recommended values: * autonomous-system * artifact * directory * domain-name * email-addr * file * ipv4-addr * ipv6-addr * mac-addr * mutex * port * process * software * url * user-account * windows-registry-key * x509-certificate

type: keyword

example: ipv4-addr

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. If the URL contains a literal IPv6 address enclosed by [ and ] (IETF RFC 2732), the [ and ] characters should also be captured in the domain field.

type: keyword

example: www.elastic.co

The field contains the file extension from the original request url, excluding the leading dot. The file extension is only set if it exists, as not every url has a file extension. The leading period must not be included. For example, the value must be "png", not ".png". Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz").

type: keyword

example: png

Portion of the url after the #, such as "top". The # is not part of the fragment.

type: keyword