Skip to content
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
f062bd0
Add proposed new fields in .yml format
susan-shu-c Sep 18, 2025
bbc490f
Add built doc files
susan-shu-c Sep 18, 2025
4b32811
Update proposed type for tool.call.result
susan-shu-c Sep 18, 2025
9b177e4
Merge generated files from main
susan-shu-c Oct 2, 2025
9b1cc75
Checkout files from main
susan-shu-c Oct 2, 2025
7ef579f
Fix typo
susan-shu-c Oct 2, 2025
22cdf78
Update generated docs
susan-shu-c Oct 2, 2025
2b1011a
Rebuild generated files
mjwolf Oct 2, 2025
5f878bd
Update examples
susan-shu-c Oct 8, 2025
8a89add
Grab doc file from main
susan-shu-c Oct 8, 2025
368ece1
Merge remote-tracking branch 'upstream/main' into additional-gen_ai-s…
mjwolf Oct 9, 2025
47aa573
Update field types based on feedback tradeoffs
susan-shu-c Oct 9, 2025
dc83c90
Change field beta reuse wording
susan-shu-c Oct 10, 2025
2b53588
Clean up wording and examples in rfcs/text
susan-shu-c Oct 10, 2025
0b7379e
Update schemas/gen_ai.yml
susan-shu-c Oct 10, 2025
33c9f2e
Merge branch 'main' into additional-gen_ai-stage-2
trisch-me Oct 17, 2025
065887c
Comment out not-merged OTel fields
susan-shu-c Oct 17, 2025
4bf7e59
Comment out not-merged OTel fields
susan-shu-c Oct 17, 2025
d90ed1c
Update related OTel
susan-shu-c Oct 17, 2025
72330fd
Remove trailing spaces via lint
susan-shu-c Oct 17, 2025
aebee50
Update proposal text file
susan-shu-c Oct 17, 2025
672d40d
Update generated files
susan-shu-c Oct 17, 2025
d391627
Merge remote-tracking branch 'upstream/main' into additional-gen_ai-s…
mjwolf Oct 17, 2025
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
7 changes: 4 additions & 3 deletions docs/reference/ecs-entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,17 @@ 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: 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-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-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 |
| $$$field-entity-type$$$ [entity.type](#field-entity-type) | _This field is beta and subject to change._ A standardized high-level classification of the entity. This provides a normalized way to group similar entities across different providers or systems. Example values: `bucket`, `database`, `container`, `function`, `queue`, `host`, `user`, `application`, `session`, etc.<br><br>type: keyword<br><br>example: `host` | core |
| $$$field-entity-sub-type$$$ [entity.sub_type](#field-entity-sub-type) | _This field is beta and subject to change._ The specific type designation for the entity as defined by its provider or system. This field provides more granular classification than the type field. Examples: `aws_s3_bucket`, `gcp_cloud_storage_bucket`, `azure_blob_container` would all map to entity type `bucket`. `hardware` , `virtual` , `container` , `node` , `cloud_instance` would all map to entity type `host`.<br><br>type: keyword<br><br>example: `aws_s3_bucket` | extended |
| $$$field-entity-type$$$ [entity.type](#field-entity-type) | _This field is beta and subject to change._ A standardized high-level classification of the entity. This provides a normalized way to group similar entities across different providers or systems. Example values: `bucket`, `database`, `container`, `function`, `queue`, `host`, `user`, `application`, `session`, etc.<br><br>type: keyword<br><br>Note: This field should contain an array of values.<br><br>**Important:** The field value must be one of the following:<br><br>bucket, database, container, function, queue, host, user, application, service, session<br><br>To learn more about when to use which value, visit the page [allowed values for entity.type](/reference/ecs-allowed-values-entity-type.md)<br> | core |

## Field reuse [_field_reuse]

Expand Down
74 changes: 0 additions & 74 deletions generated/elasticsearch/composable/component/entity.json

This file was deleted.

2 changes: 1 addition & 1 deletion rfcs/text/0052-gen_ai-additional-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ gen_ai.input.messages | (Looking for feedback) flattened | The chat history prov
gen_ai.output.messages | (Looking for feedback) flattened | Messages returned by the model where each message represents a specific model response (choice, candidate).
gen_ai.tool.definitions | (Looking for feedback) nested | (Part of invoke_agent span) The list of source system tool definitions available to the GenAI agent or model.
gen_ai.tool.call.arguments | (Looking for feedback) nested | (Part of OTel execute_tool span) Parameters passed to the tool call.
gen_ai.tool.call.result | (Looking for feedback) nested | (Part of OTel execute_tool span) The result returned by the tool call (if any and if execution was successful).
gen_ai.tool.call.result | (Looking for feedback) flattened | (Part of OTel execute_tool span) The result returned by the tool call (if any and if execution was successful).

Changes based on OTel https://github.com/open-telemetry/semantic-conventions/pull/2179/files

Expand Down
51 changes: 51 additions & 0 deletions rfcs/text/0052/gen_ai.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
- name: gen_ai
fields:
- name: system_instructions
type: flattened
description: The system message or instructions provided to the GenAI model separately from the chat history.
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
- name: input.messages
type: flattened
description: The chat history provided to the model as an input.
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
- name: output.messages
type: flattened
description: Messages returned by the model where each message represents a specific model response (choice, candidate).
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
- name: tool.definitions
type: nested
description: The list of source system tool definitions available to the GenAI agent or model.
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
- name: tool.call.arguments
type: nested
description: Parameters passed to the tool call.
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
- name: tool.call.result
type: flattened
description: The result returned by the tool call (if any and if execution was successful).
example: TODO
level: extended
beta: This field reuse is beta and subject to change.
otel:
- relation: match
Loading