Skip to content

Commit

Permalink
Promote process.io and process.tty fields to GA (elastic#2317)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mjwolf authored Jan 24, 2024
1 parent 375a4dd commit 7ba62a3
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 88 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
44 changes: 11 additions & 33 deletions docs/fields/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8182,9 +8182,7 @@ example: `True`
[[field-process-io]]
<<field-process-io, 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.

Expand All @@ -8202,9 +8200,7 @@ type: object
[[field-process-io-bytes-skipped]]
<<field-process-io-bytes-skipped, 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

Expand All @@ -8223,9 +8219,7 @@ Note: this field should contain an array of values.
[[field-process-io-bytes-skipped-length]]
<<field-process-io-bytes-skipped-length, 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

Expand All @@ -8241,9 +8235,7 @@ type: long
[[field-process-io-bytes-skipped-offset]]
<<field-process-io-bytes-skipped-offset, 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

Expand All @@ -8259,9 +8251,7 @@ type: long
[[field-process-io-max-bytes-per-process-exceeded]]
<<field-process-io-max-bytes-per-process-exceeded, 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

Expand All @@ -8277,9 +8267,7 @@ type: boolean
[[field-process-io-text]]
<<field-process-io-text, 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.

Expand All @@ -8297,9 +8285,7 @@ type: wildcard
[[field-process-io-total-bytes-captured]]
<<field-process-io-total-bytes-captured, 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

Expand All @@ -8315,9 +8301,7 @@ type: long
[[field-process-io-total-bytes-skipped]]
<<field-process-io-total-bytes-skipped, 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

Expand All @@ -8333,9 +8317,7 @@ type: long
[[field-process-io-type]]
<<field-process-io-type, 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.

Expand Down Expand Up @@ -8593,9 +8575,7 @@ example: `1`
[[field-process-tty-columns]]
<<field-process-tty-columns, 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'

Expand All @@ -8613,9 +8593,7 @@ example: `80`
[[field-process-tty-rows]]
<<field-process-tty-rows, 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'

Expand Down
11 changes: 0 additions & 11 deletions experimental/generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
11 changes: 0 additions & 11 deletions experimental/generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
11 changes: 0 additions & 11 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
Loading

0 comments on commit 7ba62a3

Please sign in to comment.