Skip to content
Open
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
2 changes: 2 additions & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Thanks, you're awesome :-) -->

#### Bugfixes

* Fix GenAI integer fields to use `long` datatype per ECS conventions. #2646

#### Added

* Add `vulnerability.status` field with allowed values `open`, `fixed`, `reopened`, `unknown`. #2662
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/ecs-gen_ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ This field group definition is based on the Gen AI namespace of the OpenTelemetr
| $$$field-gen-ai-output-messages$$$ [gen_ai.output.messages](#field-gen-ai-output-messages) | _This field is beta and subject to change._ Messages returned by the model where each message represents a specific model response (choice, candidate).<br><br>type: flattened<br><br>example: `{ "role": "assistant", "parts": [ { "type": "text", "content": "The weather in Paris is currently rainy with a temperature of 57°F." } ], "finish_reason": "stop"}`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.output.messages](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-output-messages) | extended |
| $$$field-gen-ai-output-type$$$ [gen_ai.output.type](#field-gen-ai-output-type) | _This field is beta and subject to change._ Represents the content type requested by the client.<br><br>type: keyword<br><br>example: `text; json; image`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.output.type](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-output-type) | extended |
| $$$field-gen-ai-provider-name$$$ [gen_ai.provider.name](#field-gen-ai-provider-name) | _This field is beta and subject to change._ The Generative AI provider as identified by the client or server instrumentation.<br><br>type: keyword<br><br>example: `openai`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.provider.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-provider-name) | extended |
| $$$field-gen-ai-request-choice-count$$$ [gen_ai.request.choice.count](#field-gen-ai-request-choice-count) | _This field is beta and subject to change._ The target number of candidate completions to return.<br><br>type: integer<br><br>example: `3`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.choice.count](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-choice-count) | extended |
| $$$field-gen-ai-request-choice-count$$$ [gen_ai.request.choice.count](#field-gen-ai-request-choice-count) | _This field is beta and subject to change._ The target number of candidate completions to return.<br><br>type: long<br><br>example: `3`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.choice.count](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-choice-count) | extended |
| $$$field-gen-ai-request-encoding-formats$$$ [gen_ai.request.encoding_formats](#field-gen-ai-request-encoding-formats) | _This field is beta and subject to change._ The encoding formats requested in an embeddings operation, if specified.<br><br>type: nested<br><br>example: `["float", "binary"]`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.encoding_formats](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-encoding-formats) | extended |
| $$$field-gen-ai-request-frequency-penalty$$$ [gen_ai.request.frequency_penalty](#field-gen-ai-request-frequency-penalty) | _This field is beta and subject to change._ The frequency penalty setting for the GenAI request.<br><br>type: double<br><br>example: `0.1`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.frequency_penalty](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-frequency-penalty) | extended |
| $$$field-gen-ai-request-max-tokens$$$ [gen_ai.request.max_tokens](#field-gen-ai-request-max-tokens) | _This field is beta and subject to change._ The maximum number of tokens the model generates for a request.<br><br>type: integer<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.max_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-max-tokens) | extended |
| $$$field-gen-ai-request-max-tokens$$$ [gen_ai.request.max_tokens](#field-gen-ai-request-max-tokens) | _This field is beta and subject to change._ The maximum number of tokens the model generates for a request.<br><br>type: long<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.max_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-max-tokens) | extended |
| $$$field-gen-ai-request-model$$$ [gen_ai.request.model](#field-gen-ai-request-model) | _This field is beta and subject to change._ The name of the GenAI model a request is being made to.<br><br>type: keyword<br><br>example: `gpt-4`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.model](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-model) | extended |
| $$$field-gen-ai-request-presence-penalty$$$ [gen_ai.request.presence_penalty](#field-gen-ai-request-presence-penalty) | _This field is beta and subject to change._ The presence penalty setting for the GenAI request.<br><br>type: double<br><br>example: `0.1`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.presence_penalty](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-presence-penalty) | extended |
| $$$field-gen-ai-request-seed$$$ [gen_ai.request.seed](#field-gen-ai-request-seed) | _This field is beta and subject to change._ Requests with same seed value more likely to return same result.<br><br>type: integer<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.seed](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-seed) | extended |
| $$$field-gen-ai-request-seed$$$ [gen_ai.request.seed](#field-gen-ai-request-seed) | _This field is beta and subject to change._ Requests with same seed value more likely to return same result.<br><br>type: long<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.seed](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-seed) | extended |
| $$$field-gen-ai-request-stop-sequences$$$ [gen_ai.request.stop_sequences](#field-gen-ai-request-stop-sequences) | _This field is beta and subject to change._ List of sequences that the model will use to stop generating further tokens.<br><br>type: nested<br><br>example: `["forest", "lived"]`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.stop_sequences](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-stop-sequences) | extended |
| $$$field-gen-ai-request-temperature$$$ [gen_ai.request.temperature](#field-gen-ai-request-temperature) | _This field is beta and subject to change._ The temperature setting for the GenAI request.<br><br>type: double<br><br>example: `0.0`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.temperature](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-temperature) | extended |
| $$$field-gen-ai-request-top-k$$$ [gen_ai.request.top_k](#field-gen-ai-request-top-k) | _This field is beta and subject to change._ The top_k sampling setting for the GenAI request.<br><br>type: double<br><br>example: `1.0`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.request.top_k](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-request-top-k) | extended |
Expand All @@ -47,7 +47,7 @@ This field group definition is based on the Gen AI namespace of the OpenTelemetr
| $$$field-gen-ai-tool-definitions$$$ [gen_ai.tool.definitions](#field-gen-ai-tool-definitions) | _This field is beta and subject to change._ The list of source system tool definitions available to the GenAI agent or model.<br><br>type: flattened<br><br>example: `{ "type": "function", "name": "get_current_weather", "description": "Get the current weather in a given location", "parameters": { "type": "object", "properties": { "location": { "type": "string", "description": "The city and state, e.g. San Francisco, CA" }, "unit": { "type": "string", "enum": [ "celsius", "fahrenheit" ] } }, "required": [ "location", "unit" ] }}`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.tool.definitions](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-tool-definitions) | extended |
| $$$field-gen-ai-tool-name$$$ [gen_ai.tool.name](#field-gen-ai-tool-name) | _This field is beta and subject to change._ Name of the tool utilized by the agent.<br><br>type: keyword<br><br>example: `Flights`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.tool.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-tool-name) | extended |
| $$$field-gen-ai-tool-type$$$ [gen_ai.tool.type](#field-gen-ai-tool-type) | _This field is beta and subject to change._ Type of the tool utilized by the agent<br><br>type: keyword<br><br>example: `function; extension; datastore`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.tool.type](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-tool-type) | extended |
| $$$field-gen-ai-usage-input-tokens$$$ [gen_ai.usage.input_tokens](#field-gen-ai-usage-input-tokens) | _This field is beta and subject to change._ The number of tokens used in the GenAI input (prompt).<br><br>type: integer<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.usage.input_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-usage-input-tokens) | extended |
| $$$field-gen-ai-usage-output-tokens$$$ [gen_ai.usage.output_tokens](#field-gen-ai-usage-output-tokens) | _This field is beta and subject to change._ The number of tokens used in the GenAI response (completion).<br><br>type: integer<br><br>example: `180`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.usage.output_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-usage-output-tokens) | extended |
| $$$field-gen-ai-usage-input-tokens$$$ [gen_ai.usage.input_tokens](#field-gen-ai-usage-input-tokens) | _This field is beta and subject to change._ The number of tokens used in the GenAI input (prompt).<br><br>type: long<br><br>example: `100`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.usage.input_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-usage-input-tokens) | extended |
| $$$field-gen-ai-usage-output-tokens$$$ [gen_ai.usage.output_tokens](#field-gen-ai-usage-output-tokens) | _This field is beta and subject to change._ The number of tokens used in the GenAI response (completion).<br><br>type: long<br><br>example: `180`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [gen_ai.usage.output_tokens](https://opentelemetry.io/docs/specs/semconv/attributes-registry/gen-ai/#gen-ai-usage-output-tokens) | extended |


10 changes: 5 additions & 5 deletions generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5469,7 +5469,7 @@
default_field: false
- name: request.choice.count
level: extended
type: integer
type: long
description: The target number of candidate completions to return.
example: 3
default_field: false
Expand All @@ -5487,7 +5487,7 @@
default_field: false
- name: request.max_tokens
level: extended
type: integer
type: long
description: The maximum number of tokens the model generates for a request.
example: 100
default_field: false
Expand All @@ -5506,7 +5506,7 @@
default_field: false
- name: request.seed
level: extended
type: integer
type: long
description: Requests with same seed value more likely to return same result.
example: 100
default_field: false
Expand Down Expand Up @@ -5623,13 +5623,13 @@
default_field: false
- name: usage.input_tokens
level: extended
type: integer
type: long
description: The number of tokens used in the GenAI input (prompt).
example: 100
default_field: false
- name: usage.output_tokens
level: extended
type: integer
type: long
description: The number of tokens used in the GenAI response (completion).
example: 180
default_field: false
Expand Down
10 changes: 5 additions & 5 deletions generated/csv/fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -749,13 +749,13 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
}","Messages returned by the model where each message represents a specific model response (choice, candidate)."
9.5.0-dev,true,gen_ai,gen_ai.output.type,keyword,extended,,text; json; image,Represents the content type requested by the client.
9.5.0-dev,true,gen_ai,gen_ai.provider.name,keyword,extended,,openai,The Generative AI provider as identified by the client or server instrumentation.
9.5.0-dev,true,gen_ai,gen_ai.request.choice.count,integer,extended,,3,The target number of candidate completions to return.
9.5.0-dev,true,gen_ai,gen_ai.request.choice.count,long,extended,,3,The target number of candidate completions to return.
9.5.0-dev,true,gen_ai,gen_ai.request.encoding_formats,nested,extended,,"[""float"", ""binary""]","The encoding formats requested in an embeddings operation, if specified."
9.5.0-dev,true,gen_ai,gen_ai.request.frequency_penalty,double,extended,,0.1,The frequency penalty setting for the GenAI request.
9.5.0-dev,true,gen_ai,gen_ai.request.max_tokens,integer,extended,,100,The maximum number of tokens the model generates for a request.
9.5.0-dev,true,gen_ai,gen_ai.request.max_tokens,long,extended,,100,The maximum number of tokens the model generates for a request.
9.5.0-dev,true,gen_ai,gen_ai.request.model,keyword,extended,,gpt-4,The name of the GenAI model a request is being made to.
9.5.0-dev,true,gen_ai,gen_ai.request.presence_penalty,double,extended,,0.1,The presence penalty setting for the GenAI request.
9.5.0-dev,true,gen_ai,gen_ai.request.seed,integer,extended,,100,Requests with same seed value more likely to return same result.
9.5.0-dev,true,gen_ai,gen_ai.request.seed,long,extended,,100,Requests with same seed value more likely to return same result.
9.5.0-dev,true,gen_ai,gen_ai.request.stop_sequences,nested,extended,,"[""forest"", ""lived""]",List of sequences that the model will use to stop generating further tokens.
9.5.0-dev,true,gen_ai,gen_ai.request.temperature,double,extended,,0.0,The temperature setting for the GenAI request.
9.5.0-dev,true,gen_ai,gen_ai.request.top_k,double,extended,,1.0,The top_k sampling setting for the GenAI request.
Expand Down Expand Up @@ -807,8 +807,8 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
}",The list of source system tool definitions available to the GenAI agent or model.
9.5.0-dev,true,gen_ai,gen_ai.tool.name,keyword,extended,,Flights,Name of the tool utilized by the agent.
9.5.0-dev,true,gen_ai,gen_ai.tool.type,keyword,extended,,function; extension; datastore,Type of the tool utilized by the agent
9.5.0-dev,true,gen_ai,gen_ai.usage.input_tokens,integer,extended,,100,The number of tokens used in the GenAI input (prompt).
9.5.0-dev,true,gen_ai,gen_ai.usage.output_tokens,integer,extended,,180,The number of tokens used in the GenAI response (completion).
9.5.0-dev,true,gen_ai,gen_ai.usage.input_tokens,long,extended,,100,The number of tokens used in the GenAI input (prompt).
9.5.0-dev,true,gen_ai,gen_ai.usage.output_tokens,long,extended,,180,The number of tokens used in the GenAI response (completion).
9.5.0-dev,true,group,group.domain,keyword,extended,,,Name of the directory the group is a member of.
9.5.0-dev,true,group,group.id,keyword,extended,,,Unique identifier for the group on the system/platform.
9.5.0-dev,true,group,group.name,keyword,extended,,,Name of the group.
Expand Down
Loading
Loading