From 375a4dd01549286b1f79413ffcf4541bdb0ac2d1 Mon Sep 17 00:00:00 2001 From: Michael Wolf Date: Mon, 15 Jan 2024 11:30:17 -0800 Subject: [PATCH 1/4] Promote process.env_vars to GA (#2315) The process.env_vars field has been stabalized and in use for some time now, so it should be promoted to GA status. --- CHANGELOG.next.md | 1 + docs/fields/field-details.asciidoc | 4 +--- experimental/generated/ecs/ecs_flat.yml | 1 - experimental/generated/ecs/ecs_nested.yml | 1 - generated/ecs/ecs_flat.yml | 1 - generated/ecs/ecs_nested.yml | 1 - schemas/process.yml | 1 - 7 files changed, 2 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 64e3c1b3a7..198542f139 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -17,6 +17,7 @@ Thanks, you're awesome :-) --> #### Added * Added `volume.*` as beta field set. #2269 +* Advanced `process.env_vars` to GA. #2315 #### Improvements diff --git a/docs/fields/field-details.asciidoc b/docs/fields/field-details.asciidoc index b71ae31f60..52a4f8769b 100644 --- a/docs/fields/field-details.asciidoc +++ b/docs/fields/field-details.asciidoc @@ -8101,9 +8101,7 @@ type: keyword [[field-process-env-vars]] <> -a| beta:[ This field is beta and subject to change. ] - -Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. +a| Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. May be filtered to protect sensitive information. diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml index 9b74b8e01a..5d9d5b098b 100644 --- a/experimental/generated/ecs/ecs_flat.yml +++ b/experimental/generated/ecs/ecs_flat.yml @@ -8888,7 +8888,6 @@ process.entry_leader.working_directory: short: The working directory of the process. type: keyword process.env_vars: - beta: This field is beta and subject to change. dashed_name: process-env-vars description: 'Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml index 0eee0300d9..fad9d210b0 100644 --- a/experimental/generated/ecs/ecs_nested.yml +++ b/experimental/generated/ecs/ecs_nested.yml @@ -11098,7 +11098,6 @@ process: short: The working directory of the process. type: keyword process.env_vars: - beta: This field is beta and subject to change. dashed_name: process-env-vars description: 'Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml index e5f035baa7..5246b72cc7 100644 --- a/generated/ecs/ecs_flat.yml +++ b/generated/ecs/ecs_flat.yml @@ -8819,7 +8819,6 @@ process.entry_leader.working_directory: short: The working directory of the process. type: keyword process.env_vars: - beta: This field is beta and subject to change. dashed_name: process-env-vars description: 'Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml index 048948d37f..4556bda9e7 100644 --- a/generated/ecs/ecs_nested.yml +++ b/generated/ecs/ecs_nested.yml @@ -11018,7 +11018,6 @@ process: short: The working directory of the process. type: keyword process.env_vars: - beta: This field is beta and subject to change. dashed_name: process-env-vars description: 'Array of environment variable bindings. Captured from a snapshot of the environment at the time of execution. diff --git a/schemas/process.yml b/schemas/process.yml index 674cfae2b6..2447d1a51f 100644 --- a/schemas/process.yml +++ b/schemas/process.yml @@ -307,7 +307,6 @@ - name: env_vars level: extended type: keyword - beta: This field is beta and subject to change. short: Array of environment variable bindings. description: > Array of environment variable bindings. From 7ba62a3614916bd50032aa241aa39e4527fe4696 Mon Sep 17 00:00:00 2001 From: Michael Wolf Date: Wed, 24 Jan 2024 10:46:05 -0800 Subject: [PATCH 2/4] Promote process.io and process.tty fields to GA (#2317) Remove process.io and process.tty fields from beta, and promote to GA. These fields have stabilized and are used in released features, so they can leave beta. --- CHANGELOG.next.md | 1 + docs/fields/field-details.asciidoc | 44 ++++++----------------- experimental/generated/ecs/ecs_flat.yml | 11 ------ experimental/generated/ecs/ecs_nested.yml | 11 ------ generated/ecs/ecs_flat.yml | 11 ------ generated/ecs/ecs_nested.yml | 11 ------ schemas/process.yml | 11 ------ 7 files changed, 12 insertions(+), 88 deletions(-) diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 198542f139..b67cd5af89 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -18,6 +18,7 @@ Thanks, you're awesome :-) --> * Added `volume.*` as beta field set. #2269 * Advanced `process.env_vars` to GA. #2315 +* Advanced `process.io` and `process.tty` fields to GA. #2317 #### Improvements diff --git a/docs/fields/field-details.asciidoc b/docs/fields/field-details.asciidoc index 52a4f8769b..ad2f9d8ab1 100644 --- a/docs/fields/field-details.asciidoc +++ b/docs/fields/field-details.asciidoc @@ -8182,9 +8182,7 @@ example: `True` [[field-process-io]] <> -a| beta:[ This field is beta and subject to change. ] - -A chunk of input or output (IO) from a single process. +a| A chunk of input or output (IO) from a single process. This field only appears on the top level process object, which is the process that wrote the output or read the input. @@ -8202,9 +8200,7 @@ type: object [[field-process-io-bytes-skipped]] <> -a| beta:[ This field is beta and subject to change. ] - -An array of byte offsets and lengths denoting where IO data has been skipped. +a| An array of byte offsets and lengths denoting where IO data has been skipped. type: object @@ -8223,9 +8219,7 @@ Note: this field should contain an array of values. [[field-process-io-bytes-skipped-length]] <> -a| beta:[ This field is beta and subject to change. ] - -The length of bytes skipped. +a| The length of bytes skipped. type: long @@ -8241,9 +8235,7 @@ type: long [[field-process-io-bytes-skipped-offset]] <> -a| beta:[ This field is beta and subject to change. ] - -The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. +a| The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. type: long @@ -8259,9 +8251,7 @@ type: long [[field-process-io-max-bytes-per-process-exceeded]] <> -a| beta:[ This field is beta and subject to change. ] - -If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. +a| If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. type: boolean @@ -8277,9 +8267,7 @@ type: boolean [[field-process-io-text]] <> -a| beta:[ This field is beta and subject to change. ] - -A chunk of output or input sanitized to UTF-8. +a| A chunk of output or input sanitized to UTF-8. Best efforts are made to ensure complete lines are captured in these events. Assumptions should NOT be made that multiple lines will appear in the same event. TTY output may contain terminal control codes such as for cursor movement, so some string queries may not match due to terminal codes inserted between characters of a word. @@ -8297,9 +8285,7 @@ type: wildcard [[field-process-io-total-bytes-captured]] <> -a| beta:[ This field is beta and subject to change. ] - -The total number of bytes captured in this event. +a| The total number of bytes captured in this event. type: long @@ -8315,9 +8301,7 @@ type: long [[field-process-io-total-bytes-skipped]] <> -a| beta:[ This field is beta and subject to change. ] - -The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure this value is always zero +a| The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure this value is always zero type: long @@ -8333,9 +8317,7 @@ type: long [[field-process-io-type]] <> -a| beta:[ This field is beta and subject to change. ] - -The type of object on which the IO action (read or write) was taken. +a| The type of object on which the IO action (read or write) was taken. Currently only 'tty' is supported. Other types may be added in the future for 'file' and 'socket' support. @@ -8593,9 +8575,7 @@ example: `1` [[field-process-tty-columns]] <> -a| beta:[ This field is beta and subject to change. ] - -The number of character columns per line. e.g terminal width +a| The number of character columns per line. e.g terminal width Terminal sizes can change, so this value reflects the maximum value for a given IO event. i.e. where event.action = 'text_output' @@ -8613,9 +8593,7 @@ example: `80` [[field-process-tty-rows]] <> -a| beta:[ This field is beta and subject to change. ] - -The number of character rows in the terminal. e.g terminal height +a| The number of character rows in the terminal. e.g terminal height Terminal sizes can change, so this value reflects the maximum value for a given IO event. i.e. where event.action = 'text_output' diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml index 5d9d5b098b..e3c678dd5c 100644 --- a/experimental/generated/ecs/ecs_flat.yml +++ b/experimental/generated/ecs/ecs_flat.yml @@ -9448,7 +9448,6 @@ process.interactive: short: Whether the process is connected to an interactive shell. type: boolean process.io: - beta: This field is beta and subject to change. dashed_name: process-io description: 'A chunk of input or output (IO) from a single process. @@ -9461,7 +9460,6 @@ process.io: short: A chunk of input or output (IO) from a single process. type: object process.io.bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped description: An array of byte offsets and lengths denoting where IO data has been skipped. @@ -9473,7 +9471,6 @@ process.io.bytes_skipped: short: An array of byte offsets and lengths denoting where IO data has been skipped. type: object process.io.bytes_skipped.length: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-length description: The length of bytes skipped. flat_name: process.io.bytes_skipped.length @@ -9483,7 +9480,6 @@ process.io.bytes_skipped.length: short: The length of bytes skipped. type: long process.io.bytes_skipped.offset: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-offset description: The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. @@ -9495,7 +9491,6 @@ process.io.bytes_skipped.offset: length bytes were skipped. type: long process.io.max_bytes_per_process_exceeded: - beta: This field is beta and subject to change. dashed_name: process-io-max-bytes-per-process-exceeded description: If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. @@ -9507,7 +9502,6 @@ process.io.max_bytes_per_process_exceeded: configuration setting. type: boolean process.io.text: - beta: This field is beta and subject to change. dashed_name: process-io-text description: 'A chunk of output or input sanitized to UTF-8. @@ -9522,7 +9516,6 @@ process.io.text: short: A chunk of output or input sanitized to UTF-8. type: wildcard process.io.total_bytes_captured: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-captured description: The total number of bytes captured in this event. flat_name: process.io.total_bytes_captured @@ -9532,7 +9525,6 @@ process.io.total_bytes_captured: short: The total number of bytes captured in this event. type: long process.io.total_bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-skipped description: The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure @@ -9545,7 +9537,6 @@ process.io.total_bytes_skipped: such as buffer size limits. type: long process.io.type: - beta: This field is beta and subject to change. dashed_name: process-io-type description: 'The type of object on which the IO action (read or write) was taken. @@ -12602,7 +12593,6 @@ process.tty.char_device.minor: short: The TTY character device's minor number. type: long process.tty.columns: - beta: This field is beta and subject to change. dashed_name: process-tty-columns description: 'The number of character columns per line. e.g terminal width @@ -12616,7 +12606,6 @@ process.tty.columns: short: The number of character columns per line. e.g terminal width type: long process.tty.rows: - beta: This field is beta and subject to change. dashed_name: process-tty-rows description: 'The number of character rows in the terminal. e.g terminal height diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml index fad9d210b0..dd47d98b2f 100644 --- a/experimental/generated/ecs/ecs_nested.yml +++ b/experimental/generated/ecs/ecs_nested.yml @@ -11658,7 +11658,6 @@ process: short: Whether the process is connected to an interactive shell. type: boolean process.io: - beta: This field is beta and subject to change. dashed_name: process-io description: 'A chunk of input or output (IO) from a single process. @@ -11671,7 +11670,6 @@ process: short: A chunk of input or output (IO) from a single process. type: object process.io.bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped description: An array of byte offsets and lengths denoting where IO data has been skipped. @@ -11684,7 +11682,6 @@ process: skipped. type: object process.io.bytes_skipped.length: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-length description: The length of bytes skipped. flat_name: process.io.bytes_skipped.length @@ -11694,7 +11691,6 @@ process: short: The length of bytes skipped. type: long process.io.bytes_skipped.offset: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-offset description: The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. @@ -11706,7 +11702,6 @@ process: where length bytes were skipped. type: long process.io.max_bytes_per_process_exceeded: - beta: This field is beta and subject to change. dashed_name: process-io-max-bytes-per-process-exceeded description: If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. @@ -11718,7 +11713,6 @@ process: configuration setting. type: boolean process.io.text: - beta: This field is beta and subject to change. dashed_name: process-io-text description: 'A chunk of output or input sanitized to UTF-8. @@ -11734,7 +11728,6 @@ process: short: A chunk of output or input sanitized to UTF-8. type: wildcard process.io.total_bytes_captured: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-captured description: The total number of bytes captured in this event. flat_name: process.io.total_bytes_captured @@ -11744,7 +11737,6 @@ process: short: The total number of bytes captured in this event. type: long process.io.total_bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-skipped description: The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure @@ -11757,7 +11749,6 @@ process: restrictions such as buffer size limits. type: long process.io.type: - beta: This field is beta and subject to change. dashed_name: process-io-type description: 'The type of object on which the IO action (read or write) was taken. @@ -14820,7 +14811,6 @@ process: short: The TTY character device's minor number. type: long process.tty.columns: - beta: This field is beta and subject to change. dashed_name: process-tty-columns description: 'The number of character columns per line. e.g terminal width @@ -14834,7 +14824,6 @@ process: short: The number of character columns per line. e.g terminal width type: long process.tty.rows: - beta: This field is beta and subject to change. dashed_name: process-tty-rows description: 'The number of character rows in the terminal. e.g terminal height diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml index 5246b72cc7..468e30d9c6 100644 --- a/generated/ecs/ecs_flat.yml +++ b/generated/ecs/ecs_flat.yml @@ -9379,7 +9379,6 @@ process.interactive: short: Whether the process is connected to an interactive shell. type: boolean process.io: - beta: This field is beta and subject to change. dashed_name: process-io description: 'A chunk of input or output (IO) from a single process. @@ -9392,7 +9391,6 @@ process.io: short: A chunk of input or output (IO) from a single process. type: object process.io.bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped description: An array of byte offsets and lengths denoting where IO data has been skipped. @@ -9404,7 +9402,6 @@ process.io.bytes_skipped: short: An array of byte offsets and lengths denoting where IO data has been skipped. type: object process.io.bytes_skipped.length: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-length description: The length of bytes skipped. flat_name: process.io.bytes_skipped.length @@ -9414,7 +9411,6 @@ process.io.bytes_skipped.length: short: The length of bytes skipped. type: long process.io.bytes_skipped.offset: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-offset description: The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. @@ -9426,7 +9422,6 @@ process.io.bytes_skipped.offset: length bytes were skipped. type: long process.io.max_bytes_per_process_exceeded: - beta: This field is beta and subject to change. dashed_name: process-io-max-bytes-per-process-exceeded description: If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. @@ -9438,7 +9433,6 @@ process.io.max_bytes_per_process_exceeded: configuration setting. type: boolean process.io.text: - beta: This field is beta and subject to change. dashed_name: process-io-text description: 'A chunk of output or input sanitized to UTF-8. @@ -9453,7 +9447,6 @@ process.io.text: short: A chunk of output or input sanitized to UTF-8. type: wildcard process.io.total_bytes_captured: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-captured description: The total number of bytes captured in this event. flat_name: process.io.total_bytes_captured @@ -9463,7 +9456,6 @@ process.io.total_bytes_captured: short: The total number of bytes captured in this event. type: long process.io.total_bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-skipped description: The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure @@ -9476,7 +9468,6 @@ process.io.total_bytes_skipped: such as buffer size limits. type: long process.io.type: - beta: This field is beta and subject to change. dashed_name: process-io-type description: 'The type of object on which the IO action (read or write) was taken. @@ -12533,7 +12524,6 @@ process.tty.char_device.minor: short: The TTY character device's minor number. type: long process.tty.columns: - beta: This field is beta and subject to change. dashed_name: process-tty-columns description: 'The number of character columns per line. e.g terminal width @@ -12547,7 +12537,6 @@ process.tty.columns: short: The number of character columns per line. e.g terminal width type: long process.tty.rows: - beta: This field is beta and subject to change. dashed_name: process-tty-rows description: 'The number of character rows in the terminal. e.g terminal height diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml index 4556bda9e7..4aec3d3fd5 100644 --- a/generated/ecs/ecs_nested.yml +++ b/generated/ecs/ecs_nested.yml @@ -11578,7 +11578,6 @@ process: short: Whether the process is connected to an interactive shell. type: boolean process.io: - beta: This field is beta and subject to change. dashed_name: process-io description: 'A chunk of input or output (IO) from a single process. @@ -11591,7 +11590,6 @@ process: short: A chunk of input or output (IO) from a single process. type: object process.io.bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped description: An array of byte offsets and lengths denoting where IO data has been skipped. @@ -11604,7 +11602,6 @@ process: skipped. type: object process.io.bytes_skipped.length: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-length description: The length of bytes skipped. flat_name: process.io.bytes_skipped.length @@ -11614,7 +11611,6 @@ process: short: The length of bytes skipped. type: long process.io.bytes_skipped.offset: - beta: This field is beta and subject to change. dashed_name: process-io-bytes-skipped-offset description: The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. @@ -11626,7 +11622,6 @@ process: where length bytes were skipped. type: long process.io.max_bytes_per_process_exceeded: - beta: This field is beta and subject to change. dashed_name: process-io-max-bytes-per-process-exceeded description: If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. @@ -11638,7 +11633,6 @@ process: configuration setting. type: boolean process.io.text: - beta: This field is beta and subject to change. dashed_name: process-io-text description: 'A chunk of output or input sanitized to UTF-8. @@ -11654,7 +11648,6 @@ process: short: A chunk of output or input sanitized to UTF-8. type: wildcard process.io.total_bytes_captured: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-captured description: The total number of bytes captured in this event. flat_name: process.io.total_bytes_captured @@ -11664,7 +11657,6 @@ process: short: The total number of bytes captured in this event. type: long process.io.total_bytes_skipped: - beta: This field is beta and subject to change. dashed_name: process-io-total-bytes-skipped description: The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure @@ -11677,7 +11669,6 @@ process: restrictions such as buffer size limits. type: long process.io.type: - beta: This field is beta and subject to change. dashed_name: process-io-type description: 'The type of object on which the IO action (read or write) was taken. @@ -14740,7 +14731,6 @@ process: short: The TTY character device's minor number. type: long process.tty.columns: - beta: This field is beta and subject to change. dashed_name: process-tty-columns description: 'The number of character columns per line. e.g terminal width @@ -14754,7 +14744,6 @@ process: short: The number of character columns per line. e.g terminal width type: long process.tty.rows: - beta: This field is beta and subject to change. dashed_name: process-tty-rows description: 'The number of character rows in the terminal. e.g terminal height diff --git a/schemas/process.yml b/schemas/process.yml index 2447d1a51f..91c8ef98ef 100644 --- a/schemas/process.yml +++ b/schemas/process.yml @@ -361,7 +361,6 @@ - name: tty.rows level: extended type: long - beta: This field is beta and subject to change. short: The number of character rows in the terminal. e.g terminal height description: > The number of character rows in the terminal. e.g terminal height @@ -372,7 +371,6 @@ - name: tty.columns level: extended type: long - beta: This field is beta and subject to change. short: The number of character columns per line. e.g terminal width description: > The number of character columns per line. e.g terminal width @@ -383,7 +381,6 @@ - name: io level: extended type: object - beta: This field is beta and subject to change. short: A chunk of input or output (IO) from a single process. description: > A chunk of input or output (IO) from a single process. @@ -393,7 +390,6 @@ - name: io.type level: extended type: keyword - beta: This field is beta and subject to change. short: The type of object on which the IO action (read or write) was taken. description: > The type of object on which the IO action (read or write) was taken. @@ -403,7 +399,6 @@ - name: io.text level: extended type: wildcard - beta: This field is beta and subject to change. short: A chunk of output or input sanitized to UTF-8. description: > A chunk of output or input sanitized to UTF-8. @@ -413,14 +408,12 @@ - name: io.total_bytes_captured level: extended type: long - beta: This field is beta and subject to change. description: > The total number of bytes captured in this event. - name: io.total_bytes_skipped level: extended type: long - beta: This field is beta and subject to change. short: The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. description: > The total number of bytes that were not captured due to implementation restrictions such as buffer size limits. Implementors should strive to ensure this value is always zero @@ -428,14 +421,12 @@ - name: io.max_bytes_per_process_exceeded level: extended type: boolean - beta: This field is beta and subject to change. description: > If true, the process producing the output has exceeded the max_kilobytes_per_process configuration setting. - name: io.bytes_skipped level: extended type: object - beta: This field is beta and subject to change. description: > An array of byte offsets and lengths denoting where IO data has been skipped. @@ -445,13 +436,11 @@ - name: io.bytes_skipped.offset level: extended type: long - beta: This field is beta and subject to change. description: > The byte offset into this event's io.text (or io.bytes in the future) where length bytes were skipped. - name: io.bytes_skipped.length level: extended type: long - beta: This field is beta and subject to change. description: > The length of bytes skipped. From 4115b40ecb52c1c1e6d549d4e406dd53ced9bcab Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 5 Feb 2024 14:17:05 -0600 Subject: [PATCH 3/4] bring CONTRIBUTING doc up-to-date (#2316) --- CONTRIBUTING.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41319de4a5..0e9c40ddce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,19 +99,10 @@ Please follow these guidelines when submitting Issues: ## Feature freezes and branching -ECS follows a two-stage feature freeze approach using the concepts of Soft Feature Freezes (SFF) and Hard Feature Freezes (HFF). +For an upcoming release, ECS uses a feature freeze (FF) approach. A release branch is cut from `main` for an upcoming +release. When a branch is frozen, changes are limited to bug fixes or doc updates. -Once a branch enters SFF, only minor and low-impact features can be added. The ECS team will rely on the “scope of impact” assessment in the ECS RFC process to help assess the potential impact of a proposed change. - -When a branch enters HFF, from that point onward all new features of any size must be contributed to the next ECS version. - -For people contributing to the ECS repo, this change means there are two branches at any given time that are accepting at least some sort of feature changes. Here's an example using ECS 8.1: - -| Branch | Version | Change scope | -| ------ | ------- | ------------ | -| `main` | 8.2 | Any enhancements or otherwise | -| `8.1` | 8.1 | SFF: Can have low impact enhancements | -| `8.0` | 8.0 | HFF: Only bug fixes, tooling, docs, etc | +Any schema changes or tooling updates will be merged into `main` for the next ECS version. ### Changelogs @@ -222,6 +213,12 @@ The [schemas](schemas) directory contains the files which define the Elastic Com Users consuming ECS to generate something for other use cases should use the `generated/ecs/*.yml` files. More detail can be found [here](generated/README.md). +### Subset Files + +The [schemas/subsets](schemas/subsets/) directory contains the configuration to control advanced field nesting use cases. +The config is used with the `--subset` option to control which field sets or specific fields appear in the final generated +artifacts. + ## Additional Resources * [ECS Guidelines and Best Practices](https://www.elastic.co/guide/en/ecs/current/ecs-guidelines.html) From ceacf7b6b383b30f22f0a3e16729a1ab1f5e72d8 Mon Sep 17 00:00:00 2001 From: Nassim Kammah Date: Fri, 9 Feb 2024 20:33:10 +0100 Subject: [PATCH 4/4] Update docs-preview link (#2318) Following the migration from Jenkins to Buildkite, docs previews are now available at _bk_. More context in https://github.com/elastic/docs/pull/2898 --- .github/workflows/docs-preview-comment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-preview-comment.yml b/.github/workflows/docs-preview-comment.yml index 484e1b83d0..34371e767b 100644 --- a/.github/workflows/docs-preview-comment.yml +++ b/.github/workflows/docs-preview-comment.yml @@ -15,7 +15,7 @@ jobs: with: script: | const pr = context.payload.pull_request; - const comment = `Documentation changes preview: https://${context.repo.repo}_${pr.number}.docs-preview.app.elstc.co/diff`; + const comment = `Documentation changes preview: https://${context.repo.repo}_bk_${pr.number}.docs-preview.app.elstc.co/diff`; github.rest.issues.createComment({ issue_number: context.issue.number,