Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/ecs-entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ The entity fields provide a standardized way to represent and categorize differe
| --- | --- | --- |
| $$$field-entity-attributes$$$ [entity.attributes](#field-entity-attributes) | _This field is beta and subject to change._ A set of static or semi-static attributes of the entity. Usually boolean or keyword field data types. Use this field set when you need to track static or semi-static characteristics of an entity for advanced searching and correlation of normalized values across different providers/sources and entity types.<br><br>type: object | extended |
| $$$field-entity-behavior$$$ [entity.behavior](#field-entity-behavior) | _This field is beta and subject to change._ A set of ephemeral characteristics of the entity, derived from observed behaviors during a specific time period. Usually boolean field data type. Use this field set when you need to capture and track ephemeral characteristics of an entity for advanced searching, correlation of normalized values across different providers/sources and entity types.<br><br>type: object | extended |
| $$$field-entity-display_name$$$ [entity.display_name](#field-entity-display_name) | _This field is beta and subject to change._ An optional field used when a pretty name is desired for entity-centric operations. This field should not be used for correlation with `*.name` fields for entities with dedicated field sets (e.g., `host`).<br><br>type: keyword<br><br>Multi-fields:<br><br>* entity.display_name.text (type: text) | extended |
| $$$field-entity-display_name$$$ [entity.display_name](#field-entity-display_name) | _This field is beta and subject to change._ An optional field used when a pretty name is desired for entity-centric operations. This field should not be used for correlation with `*.name` fields for entities with dedicated field sets (e.g., `host`).<br><br>type: keyword<br><br>Multi-fields:<br><br>* entity.display_name.text (type: match_only_text) | extended |
| $$$field-entity-id$$$ [entity.id](#field-entity-id) | A unique identifier for the entity. When multiple identifiers exist, this should be the most stable and commonly used identifier that: 1) persists across the entity's lifecycle, 2) ensures uniqueness within its scope, 3) is commonly used for queries and correlation, and 4) is readily available in most observations (logs/events). For entities with dedicated field sets (e.g., host, user), this value should match the corresponding *.id field. Alternative identifiers (e.g., ARNs values in AWS, URLs) can be preserved in the raw field.<br><br>type: keyword | core |
| $$$field-entity-last_seen_timestamp$$$ [entity.last_seen_timestamp](#field-entity-last_seen_timestamp) | _This field is beta and subject to change._ Indicates the date/time when this entity was last "seen," usually based upon the last event/log that is initiated by this entity.<br><br>type: date | extended |
| $$$field-entity-lifecycle$$$ [entity.lifecycle](#field-entity-lifecycle) | _This field is beta and subject to change._ A set of temporal characteristics of the entity. Usually date field data type. Use this field set when you need to track temporal characteristics of an entity for advanced searching and correlation of normalized values across different providers/sources and entity types.<br><br>type: object | extended |
| $$$field-entity-metrics$$$ [entity.metrics](#field-entity-metrics) | _This field is beta and subject to change._ Field set for any fields containing numeric entity metrics. These use dynamic field data type mapping.<br><br>type: object | extended |
| $$$field-entity-name$$$ [entity.name](#field-entity-name) | _This field is beta and subject to change._ The name of the entity. The keyword field enables exact matches for filtering and aggregations, while the text field enables full-text search. For entities with dedicated field sets (e.g., `host`), this field should mirrors the corresponding *.name value.<br><br>type: keyword<br><br>Multi-fields:<br><br>* entity.name.text (type: text) | core |
| $$$field-entity-name$$$ [entity.name](#field-entity-name) | _This field is beta and subject to change._ The name of the entity. The keyword field enables exact matches for filtering and aggregations, while the text field enables full-text search. For entities with dedicated field sets (e.g., `host`), this field should mirrors the corresponding *.name value.<br><br>type: keyword<br><br>Multi-fields:<br><br>* entity.name.text (type: match_only_text) | core |
| $$$field-entity-raw$$$ [entity.raw](#field-entity-raw) | _This field is beta and subject to change._ Original, unmodified fields from the source system. Usually flattened field data type. While the attributes field should be used for normalized fields requiring advanced queries, this field preserves all source metadata with basic search capabilities.<br><br>type: object | extended |
| $$$field-entity-reference$$$ [entity.reference](#field-entity-reference) | _This field is beta and subject to change._ A URI, URL, or other direct reference to access or locate the entity in its source system. This could be an API endpoint, web console URL, or other addressable location. Format may vary by entity type and source system.<br><br>type: keyword | extended |
| $$$field-entity-source$$$ [entity.source](#field-entity-source) | _This field is beta and subject to change._ The module or integration that provided this entity data (similar to event.module).<br><br>type: keyword | core |
Expand Down
24 changes: 8 additions & 16 deletions experimental/generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -711,8 +711,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: An optional field used when a pretty name is desired for entity-centric
operations. This field should not be used for correlation with `*.name` fields
for entities with dedicated field sets (e.g., `host`).
Expand Down Expand Up @@ -756,8 +755,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: The name of the entity. The keyword field enables exact matches
for filtering and aggregations, while the text field enables full-text search.
For entities with dedicated field sets (e.g., `host`), this field should mirrors
Expand Down Expand Up @@ -3943,8 +3941,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: An optional field used when a pretty name is desired for entity-centric
operations. This field should not be used for correlation with `*.name` fields
for entities with dedicated field sets (e.g., `host`).
Expand Down Expand Up @@ -3988,8 +3985,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: The name of the entity. The keyword field enables exact matches
for filtering and aggregations, while the text field enables full-text search.
For entities with dedicated field sets (e.g., `host`), this field should mirrors
Expand Down Expand Up @@ -9211,8 +9207,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: An optional field used when a pretty name is desired for entity-centric
operations. This field should not be used for correlation with `*.name` fields
for entities with dedicated field sets (e.g., `host`).
Expand Down Expand Up @@ -9256,8 +9251,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: The name of the entity. The keyword field enables exact matches
for filtering and aggregations, while the text field enables full-text search.
For entities with dedicated field sets (e.g., `host`), this field should mirrors
Expand Down Expand Up @@ -14170,8 +14164,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: An optional field used when a pretty name is desired for entity-centric
operations. This field should not be used for correlation with `*.name` fields
for entities with dedicated field sets (e.g., `host`).
Expand Down Expand Up @@ -14215,8 +14208,7 @@
ignore_above: 1024
multi_fields:
- name: text
type: text
norms: false
type: match_only_text
description: The name of the entity. The keyword field enables exact matches
for filtering and aggregations, while the text field enables full-text search.
For entities with dedicated field sets (e.g., `host`), this field should mirrors
Expand Down
16 changes: 8 additions & 8 deletions experimental/generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,13 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
9.3.0-dev+exp,true,cloud,cloud.target.entity.attributes,object,extended,,,A set of static or semi-static attributes of the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.behavior,object,extended,,,"A set of ephemeral characteristics of the entity, derived from observed behaviors during a specific time period."
9.3.0-dev+exp,true,cloud,cloud.target.entity.display_name,keyword,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,cloud,cloud.target.entity.display_name.text,text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,cloud,cloud.target.entity.display_name.text,match_only_text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,cloud,cloud.target.entity.id,keyword,core,,,Unique identifier for the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.last_seen_timestamp,date,extended,,,"Indicates the date/time when this entity was last ""seen."""
9.3.0-dev+exp,true,cloud,cloud.target.entity.lifecycle,object,extended,,,A set of temporal characteristics of the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.metrics,object,extended,,,Field set for any fields containing numeric entity metrics.
9.3.0-dev+exp,true,cloud,cloud.target.entity.name,keyword,core,,,The name of the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.name.text,text,core,,,The name of the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.name.text,match_only_text,core,,,The name of the entity.
9.3.0-dev+exp,true,cloud,cloud.target.entity.raw,object,extended,,,"Original, unmodified fields from the source system."
9.3.0-dev+exp,true,cloud,cloud.target.entity.reference,keyword,extended,,,"A URI, URL, or other direct reference to access or locate the entity."
9.3.0-dev+exp,true,cloud,cloud.target.entity.source,keyword,core,,,Source module or integration that provided the entity data.
Expand Down Expand Up @@ -483,13 +483,13 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
9.3.0-dev+exp,true,host,host.entity.attributes,object,extended,,,A set of static or semi-static attributes of the entity.
9.3.0-dev+exp,true,host,host.entity.behavior,object,extended,,,"A set of ephemeral characteristics of the entity, derived from observed behaviors during a specific time period."
9.3.0-dev+exp,true,host,host.entity.display_name,keyword,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,host,host.entity.display_name.text,text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,host,host.entity.display_name.text,match_only_text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,host,host.entity.id,keyword,core,,,Unique identifier for the entity.
9.3.0-dev+exp,true,host,host.entity.last_seen_timestamp,date,extended,,,"Indicates the date/time when this entity was last ""seen."""
9.3.0-dev+exp,true,host,host.entity.lifecycle,object,extended,,,A set of temporal characteristics of the entity.
9.3.0-dev+exp,true,host,host.entity.metrics,object,extended,,,Field set for any fields containing numeric entity metrics.
9.3.0-dev+exp,true,host,host.entity.name,keyword,core,,,The name of the entity.
9.3.0-dev+exp,true,host,host.entity.name.text,text,core,,,The name of the entity.
9.3.0-dev+exp,true,host,host.entity.name.text,match_only_text,core,,,The name of the entity.
9.3.0-dev+exp,true,host,host.entity.raw,object,extended,,,"Original, unmodified fields from the source system."
9.3.0-dev+exp,true,host,host.entity.reference,keyword,extended,,,"A URI, URL, or other direct reference to access or locate the entity."
9.3.0-dev+exp,true,host,host.entity.source,keyword,core,,,Source module or integration that provided the entity data.
Expand Down Expand Up @@ -1169,13 +1169,13 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
9.3.0-dev+exp,true,service,service.target.entity.attributes,object,extended,,,A set of static or semi-static attributes of the entity.
9.3.0-dev+exp,true,service,service.target.entity.behavior,object,extended,,,"A set of ephemeral characteristics of the entity, derived from observed behaviors during a specific time period."
9.3.0-dev+exp,true,service,service.target.entity.display_name,keyword,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,service,service.target.entity.display_name.text,text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,service,service.target.entity.display_name.text,match_only_text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,service,service.target.entity.id,keyword,core,,,Unique identifier for the entity.
9.3.0-dev+exp,true,service,service.target.entity.last_seen_timestamp,date,extended,,,"Indicates the date/time when this entity was last ""seen."""
9.3.0-dev+exp,true,service,service.target.entity.lifecycle,object,extended,,,A set of temporal characteristics of the entity.
9.3.0-dev+exp,true,service,service.target.entity.metrics,object,extended,,,Field set for any fields containing numeric entity metrics.
9.3.0-dev+exp,true,service,service.target.entity.name,keyword,core,,,The name of the entity.
9.3.0-dev+exp,true,service,service.target.entity.name.text,text,core,,,The name of the entity.
9.3.0-dev+exp,true,service,service.target.entity.name.text,match_only_text,core,,,The name of the entity.
9.3.0-dev+exp,true,service,service.target.entity.raw,object,extended,,,"Original, unmodified fields from the source system."
9.3.0-dev+exp,true,service,service.target.entity.reference,keyword,extended,,,"A URI, URL, or other direct reference to access or locate the entity."
9.3.0-dev+exp,true,service,service.target.entity.source,keyword,core,,,Source module or integration that provided the entity data.
Expand Down Expand Up @@ -1823,13 +1823,13 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
9.3.0-dev+exp,true,user,user.target.entity.attributes,object,extended,,,A set of static or semi-static attributes of the entity.
9.3.0-dev+exp,true,user,user.target.entity.behavior,object,extended,,,"A set of ephemeral characteristics of the entity, derived from observed behaviors during a specific time period."
9.3.0-dev+exp,true,user,user.target.entity.display_name,keyword,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,user,user.target.entity.display_name.text,text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,user,user.target.entity.display_name.text,match_only_text,extended,,,An optional field used when a pretty name is desired for entity-centric operations.
9.3.0-dev+exp,true,user,user.target.entity.id,keyword,core,,,Unique identifier for the entity.
9.3.0-dev+exp,true,user,user.target.entity.last_seen_timestamp,date,extended,,,"Indicates the date/time when this entity was last ""seen."""
9.3.0-dev+exp,true,user,user.target.entity.lifecycle,object,extended,,,A set of temporal characteristics of the entity.
9.3.0-dev+exp,true,user,user.target.entity.metrics,object,extended,,,Field set for any fields containing numeric entity metrics.
9.3.0-dev+exp,true,user,user.target.entity.name,keyword,core,,,The name of the entity.
9.3.0-dev+exp,true,user,user.target.entity.name.text,text,core,,,The name of the entity.
9.3.0-dev+exp,true,user,user.target.entity.name.text,match_only_text,core,,,The name of the entity.
9.3.0-dev+exp,true,user,user.target.entity.raw,object,extended,,,"Original, unmodified fields from the source system."
9.3.0-dev+exp,true,user,user.target.entity.reference,keyword,extended,,,"A URI, URL, or other direct reference to access or locate the entity."
9.3.0-dev+exp,true,user,user.target.entity.source,keyword,core,,,Source module or integration that provided the entity data.
Expand Down
24 changes: 8 additions & 16 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1033,8 +1033,7 @@ cloud.target.entity.display_name:
multi_fields:
- flat_name: cloud.target.entity.display_name.text
name: text
norms: false
type: text
type: match_only_text
name: display_name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -1108,8 +1107,7 @@ cloud.target.entity.name:
multi_fields:
- flat_name: cloud.target.entity.name.text
name: text
norms: false
type: text
type: match_only_text
name: name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -6813,8 +6811,7 @@ host.entity.display_name:
multi_fields:
- flat_name: host.entity.display_name.text
name: text
norms: false
type: text
type: match_only_text
name: display_name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -6888,8 +6885,7 @@ host.entity.name:
multi_fields:
- flat_name: host.entity.name.text
name: text
norms: false
type: text
type: match_only_text
name: name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -15463,8 +15459,7 @@ service.target.entity.display_name:
multi_fields:
- flat_name: service.target.entity.display_name.text
name: text
norms: false
type: text
type: match_only_text
name: display_name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -15538,8 +15533,7 @@ service.target.entity.name:
multi_fields:
- flat_name: service.target.entity.name.text
name: text
norms: false
type: text
type: match_only_text
name: name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -23904,8 +23898,7 @@ user.target.entity.display_name:
multi_fields:
- flat_name: user.target.entity.display_name.text
name: text
norms: false
type: text
type: match_only_text
name: display_name
normalize: []
original_fieldset: entity
Expand Down Expand Up @@ -23979,8 +23972,7 @@ user.target.entity.name:
multi_fields:
- flat_name: user.target.entity.name.text
name: text
norms: false
type: text
type: match_only_text
name: name
normalize: []
original_fieldset: entity
Expand Down
Loading
Loading