Skip to content

Commit

Permalink
Promote beta fields to GA in v9.x (#2411)
Browse files Browse the repository at this point in the history
Promote beta fields that have been present since the previous major release to GA

* cloud.origin
* cloud.target
* elf fields
* event.kind->asset type
* faas fields
* host.boot_id
* host.pid_ns_inode
* volume fields
  • Loading branch information
mjwolf authored Feb 12, 2025
1 parent 9a39b89 commit eaecbe7
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 91 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Thanks, you're awesome :-) -->

#### Improvements

* Promote beta fields to GA. #2411
* Define base encoding of `x509.serial_number`. #2383
* Restrict the encoding of `x509.serial_number` to base 16. #2398
* Set synthetic_source_keep = none on fields that represent sets. #2422
Expand Down
34 changes: 10 additions & 24 deletions docs/fields/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -821,17 +821,15 @@ Note also that the `cloud` fields may be used directly at the root of the events


| `cloud.origin.*`
| <<ecs-cloud,cloud>>| beta:[ Reusing the `cloud` fields in this location is currently considered beta.]

Provides the cloud information of the origin entity in case of an incoming request or event.
| <<ecs-cloud,cloud>>
| Provides the cloud information of the origin entity in case of an incoming request or event.

// ===============================================================


| `cloud.target.*`
| <<ecs-cloud,cloud>>| beta:[ Reusing the `cloud` fields in this location is currently considered beta.]

Provides the cloud information of the target entity in case of an outgoing request or event.
| <<ecs-cloud,cloud>>
| Provides the cloud information of the target entity in case of an outgoing request or event.

// ===============================================================

Expand Down Expand Up @@ -2327,8 +2325,6 @@ image:https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentele

These fields contain Linux Executable Linkable Format (ELF) metadata.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== ELF Header Field Details

Expand Down Expand Up @@ -4020,8 +4016,6 @@ example: `https://mysystem.example.com/alert/5271dedb-f5b0-4218-87f0-4ac4870a38f

The user fields describe information about the function as a service (FaaS) that is relevant to the event.

beta::[ These fields are in beta and are subject to change.]

[discrete]
==== FaaS Field Details

Expand Down Expand Up @@ -4673,9 +4667,8 @@ Note also that the `file` fields may be used directly at the root of the events.


| `file.elf.*`
| <<ecs-elf,elf>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Linux Executable Linkable Format (ELF) metadata.
| <<ecs-elf,elf>>
| These fields contain Linux Executable Linkable Format (ELF) metadata.

// ===============================================================

Expand Down Expand Up @@ -5242,9 +5235,7 @@ image:https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentele
[[field-host-boot-id]]
<<field-host-boot-id, host.boot.id>>

a| beta:[ This field is beta and subject to change. ]

Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the boot_id value from /proc may or may not be the same in containers as on the host. Some container runtimes will bind mount a new boot_id value onto the proc file in each container.
a| Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the boot_id value from /proc may or may not be the same in containers as on the host. Some container runtimes will bind mount a new boot_id value onto the proc file in each container.

type: keyword

Expand Down Expand Up @@ -5512,9 +5503,7 @@ image:https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentele
[[field-host-pid-ns-ino]]
<<field-host-pid-ns-ino, host.pid_ns_ino>>

a| beta:[ This field is beta and subject to change. ]

This is the inode number of the namespace in the namespace file system (nsfs). Unsigned int inum in include/linux/ns_common.h.
a| This is the inode number of the namespace in the namespace file system (nsfs). Unsigned int inum in include/linux/ns_common.h.

type: keyword

Expand Down Expand Up @@ -9070,9 +9059,8 @@ The externally attested user based on an external source such as the Kube API.


| `process.elf.*`
| <<ecs-elf,elf>>| beta:[ This field reuse is beta and subject to change.]

These fields contain Linux Executable Linkable Format (ELF) metadata.
| <<ecs-elf,elf>>
| These fields contain Linux Executable Linkable Format (ELF) metadata.

// ===============================================================

Expand Down Expand Up @@ -13407,8 +13395,6 @@ Note also that the `vlan` fields are not expected to be used directly at the roo

Fields related to storage volume details.

beta::[ These fields are beta and are subject to change.]

[discrete]
==== Volume Field Details

Expand Down
2 changes: 0 additions & 2 deletions docs/fields/field-values.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ This value is not used by Elastic solutions for alert documents that are created
[[ecs-event-kind-asset]]
==== asset

beta:[ This event categorization value is beta and subject to change. ]

This value indicates events whose primary purpose is to store an inventory of assets/entities and their attributes. Assets/entities are objects (such as users and hosts) that are expected to be subjects of detailed analysis within the system.

Examples include lists of user identities or accounts ingested from directory services such as Active Directory (AD), inventory of hosts pulled from configuration management databases (CMDB), and lists of cloud storage buckets pulled from cloud provider APIs.
Expand Down
10 changes: 5 additions & 5 deletions docs/opentelemetry/otel-fields-mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ Note: The `body` in OTLP is of type `Any` and can be either an unstructured log

.1+|
[[otel-mapping-for-faas-coldstart]]
<<field-faas-coldstart, faas.coldstart>> [beta]
<<field-faas-coldstart, faas.coldstart>>



Expand All @@ -554,7 +554,7 @@ Note: The `body` in OTLP is of type `Any` and can be either an unstructured log
// ===============================================================
.1+|
[[otel-mapping-for-faas-execution]]
<<field-faas-execution, faas.execution>> [beta]
<<field-faas-execution, faas.execution>>



Expand All @@ -568,7 +568,7 @@ Note: The `body` in OTLP is of type `Any` and can be either an unstructured log
// ===============================================================
.1+|
[[otel-mapping-for-faas-name]]
<<field-faas-name, faas.name>> [beta]
<<field-faas-name, faas.name>>



Expand All @@ -582,7 +582,7 @@ Note: The `body` in OTLP is of type `Any` and can be either an unstructured log
// ===============================================================
.1+|
[[otel-mapping-for-faas-trigger-type]]
<<field-faas-trigger-type, faas.trigger.type>> [beta]
<<field-faas-trigger-type, faas.trigger.type>>



Expand All @@ -596,7 +596,7 @@ Note: The `body` in OTLP is of type `Any` and can be either an unstructured log
// ===============================================================
.1+|
[[otel-mapping-for-faas-version]]
<<field-faas-version, faas.version>> [beta]
<<field-faas-version, faas.version>>



Expand Down
5 changes: 1 addition & 4 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3515,8 +3515,7 @@ event.kind:
This value is not used by Elastic solutions for alert documents that are created
by rules executing within the Kibana alerting framework.'
name: alert
- beta: This event categorization value is beta and subject to change.
description: 'This value indicates events whose primary purpose is to store an
- description: 'This value indicates events whose primary purpose is to store an
inventory of assets/entities and their attributes. Assets/entities are objects
(such as users and hosts) that are expected to be subjects of detailed analysis
within the system.
Expand Down Expand Up @@ -5931,7 +5930,6 @@ host.architecture:
short: Operating system architecture.
type: keyword
host.boot.id:
beta: This field is beta and subject to change.
dashed_name: host-boot-id
description: Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the
boot_id value from /proc may or may not be the same in containers as on the host.
Expand Down Expand Up @@ -6390,7 +6388,6 @@ host.os.version:
short: Operating system version as a raw string.
type: keyword
host.pid_ns_ino:
beta: This field is beta and subject to change.
dashed_name: host-pid-ns-ino
description: This is the inode number of the namespace in the namespace file system
(nsfs). Unsigned int inum in include/linux/ns_common.h.
Expand Down
24 changes: 5 additions & 19 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1321,25 +1321,21 @@ cloud:
expected:
- as: origin
at: cloud
beta: Reusing the `cloud` fields in this location is currently considered beta.
full: cloud.origin
short_override: Provides the cloud information of the origin entity in case
of an incoming request or event.
- as: target
at: cloud
beta: Reusing the `cloud` fields in this location is currently considered beta.
full: cloud.target
short_override: Provides the cloud information of the target entity in case
of an outgoing request or event.
top_level: true
reused_here:
- beta: Reusing the `cloud` fields in this location is currently considered beta.
full: cloud.origin
- full: cloud.origin
schema_name: cloud
short: Provides the cloud information of the origin entity in case of an incoming
request or event.
- beta: Reusing the `cloud` fields in this location is currently considered beta.
full: cloud.target
- full: cloud.target
schema_name: cloud
short: Provides the cloud information of the target entity in case of an outgoing
request or event.
Expand Down Expand Up @@ -3259,7 +3255,6 @@ ecs:
title: ECS
type: group
elf:
beta: These fields are in beta and are subject to change.
description: These fields contain Linux Executable Linkable Format (ELF) metadata.
fields:
elf.architecture:
Expand Down Expand Up @@ -3674,11 +3669,9 @@ elf:
expected:
- as: elf
at: file
beta: This field reuse is beta and subject to change.
full: file.elf
- as: elf
at: process
beta: This field reuse is beta and subject to change.
full: process.elf
top_level: false
short: These fields contain Linux Executable Linkable Format (ELF) metadata.
Expand Down Expand Up @@ -4538,8 +4531,7 @@ event:
This value is not used by Elastic solutions for alert documents that are
created by rules executing within the Kibana alerting framework.'
name: alert
- beta: This event categorization value is beta and subject to change.
description: 'This value indicates events whose primary purpose is to store
- description: 'This value indicates events whose primary purpose is to store
an inventory of assets/entities and their attributes. Assets/entities are
objects (such as users and hosts) that are expected to be subjects of detailed
analysis within the system.
Expand Down Expand Up @@ -5001,7 +4993,6 @@ event:
title: Event
type: group
faas:
beta: These fields are in beta and are subject to change.
description: The user fields describe information about the function as a service
(FaaS) that is relevant to the event.
fields:
Expand Down Expand Up @@ -6978,8 +6969,7 @@ file:
- full: file.code_signature
schema_name: code_signature
short: These fields contain information about binary code signatures.
- beta: This field reuse is beta and subject to change.
full: file.elf
- full: file.elf
schema_name: elf
short: These fields contain Linux Executable Linkable Format (ELF) metadata.
- beta: This field reuse is beta and subject to change.
Expand Down Expand Up @@ -7397,7 +7387,6 @@ host:
short: Operating system architecture.
type: keyword
host.boot.id:
beta: This field is beta and subject to change.
dashed_name: host-boot-id
description: Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note
the boot_id value from /proc may or may not be the same in containers as on
Expand Down Expand Up @@ -7858,7 +7847,6 @@ host:
short: Operating system version as a raw string.
type: keyword
host.pid_ns_ino:
beta: This field is beta and subject to change.
dashed_name: host-pid-ns-ino
description: This is the inode number of the namespace in the namespace file
system (nsfs). Unsigned int inum in include/linux/ns_common.h.
Expand Down Expand Up @@ -15666,8 +15654,7 @@ process:
- full: process.code_signature
schema_name: code_signature
short: These fields contain information about binary code signatures.
- beta: This field reuse is beta and subject to change.
full: process.elf
- full: process.elf
schema_name: elf
short: These fields contain Linux Executable Linkable Format (ELF) metadata.
- beta: This field reuse is beta and subject to change.
Expand Down Expand Up @@ -25860,7 +25847,6 @@ vlan:
title: VLAN
type: group
volume:
beta: These fields are beta and are subject to change.
description: Fields related to storage volume details.
fields:
volume.bus_type:
Expand Down
5 changes: 1 addition & 4 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3446,8 +3446,7 @@ event.kind:
This value is not used by Elastic solutions for alert documents that are created
by rules executing within the Kibana alerting framework.'
name: alert
- beta: This event categorization value is beta and subject to change.
description: 'This value indicates events whose primary purpose is to store an
- description: 'This value indicates events whose primary purpose is to store an
inventory of assets/entities and their attributes. Assets/entities are objects
(such as users and hosts) that are expected to be subjects of detailed analysis
within the system.
Expand Down Expand Up @@ -5862,7 +5861,6 @@ host.architecture:
short: Operating system architecture.
type: keyword
host.boot.id:
beta: This field is beta and subject to change.
dashed_name: host-boot-id
description: Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the
boot_id value from /proc may or may not be the same in containers as on the host.
Expand Down Expand Up @@ -6321,7 +6319,6 @@ host.os.version:
short: Operating system version as a raw string.
type: keyword
host.pid_ns_ino:
beta: This field is beta and subject to change.
dashed_name: host-pid-ns-ino
description: This is the inode number of the namespace in the namespace file system
(nsfs). Unsigned int inum in include/linux/ns_common.h.
Expand Down
Loading

0 comments on commit eaecbe7

Please sign in to comment.