Skip to content

[release-6.2] LOG-7131: update documentation Tuning Delivery mode default settings #3057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged

[release-6.2] LOG-7131: update documentation Tuning Delivery mode default settings #3057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions api/observability/v1/output_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ type BaseOutputTuningSpec struct {
}

// DeliveryMode sets the delivery mode for log forwarding.
// This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
// In-memory buffers offer the highest performance due to low latency, but they have two limitations:
// they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
//
// +kubebuilder:validation:Enum:=AtLeastOnce;AtMostOnce
type DeliveryMode string
Expand Down
77 changes: 55 additions & 22 deletions bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,8 +906,11 @@ spec:
description: Tuning specs tuning for the output
properties:
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1099,8 +1102,11 @@ spec:
- zstd
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1248,8 +1254,11 @@ spec:
- zlib
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1363,8 +1372,11 @@ spec:
description: Tuning specs tuning for the output
properties:
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1511,8 +1523,11 @@ spec:
- zlib
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1646,8 +1661,11 @@ spec:
- lz4
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -1818,8 +1836,11 @@ spec:
- snappy
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -2042,8 +2063,11 @@ spec:
- snappy
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -2173,8 +2197,11 @@ spec:
- none
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -2290,8 +2317,11 @@ spec:
- gzip
type: string
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down Expand Up @@ -2489,8 +2519,11 @@ spec:
nullable: true
properties:
deliveryMode:
description: DeliveryMode sets the delivery mode for
log forwarding.
description: |-
DeliveryMode sets the delivery mode for log forwarding.
This optional setting. When it is left unset, the system defaults to using an in-memory buffer.
In-memory buffers offer the highest performance due to low latency, but they have two limitations:
they will consume memory, and they do not provide durability — buffered data is lost on process termination or failure.
enum:
- AtLeastOnce
- AtMostOnce
Expand Down
Loading