Skip to content

feat(fluentbit): add retainMetadataInForwardMode to forward output pl… #1973

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

Open
joshuabaird wants to merge 8 commits into
base: master
Choose a base branch
from
Open

feat(fluentbit): add retainMetadataInForwardMode to forward output pl… #1973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
595ef04
feat(fluentbit): add retainMetadataInForwardMode to forward output pl…
joshuabaird May 27, 2026
ede78ff
chore: regenerate CRDs with retainMetadataInForwardMode field
joshuabaird May 27, 2026
67ac5b1
docs: add retainMetadataInForwardMode to forward output docs
joshuabaird May 27, 2026
b62b0d3
feat(helm): expose retainMetadataInForwardMode in fluent-operator chart
joshuabaird May 27, 2026
509aa36
chore: regenerate Output CRD with retainMetadataInForwardMode field
joshuabaird May 27, 2026
f0c721b
chore: regenerate deepcopy with retainMetadataInForwardMode field
joshuabaird May 27, 2026
2bfaab9
test(fluentbit): add forward output RetainMetadataInForwardMode test
joshuabaird May 27, 2026
3a050c4
Merge branch 'master' into chore/fluentbit/retain-metadata-in-forward
joshuabaird May 27, 2026
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
49 changes: 49 additions & 0 deletions apis/fluentbit/v1alpha2/clusteroutput_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,3 +523,52 @@ func TestLokiOutputWithStructuredMetadata_LoadAsYaml(t *testing.T) {
g.Expect(err).NotTo(HaveOccurred())
g.Expect(result).To(Equal(expected))
}

func TestForwardOutput_RetainMetadataInForwardMode(t *testing.T) {
g := NewGomegaWithT(t)
sl := plugins.NewSecretLoader(nil, "testnamespace")

// nil: field should be omitted
nilOut := ClusterOutputList{Items: []ClusterOutput{{
ObjectMeta: metav1.ObjectMeta{Name: "fwd-nil"},
Spec: OutputSpec{
Match: "kube.*",
Forward: &output.Forward{Host: "fluentd.svc", Port: utils.ToPtr[int32](24224)},
},
}}}
resultNil, err := nilOut.Load(sl)
g.Expect(err).NotTo(HaveOccurred())
g.Expect(resultNil).NotTo(ContainSubstring("Retain_Metadata_In_Forward_Mode"))

// false: field should be rendered as false
falseOut := ClusterOutputList{Items: []ClusterOutput{{
ObjectMeta: metav1.ObjectMeta{Name: "fwd-false"},
Spec: OutputSpec{
Match: "kube.*",
Forward: &output.Forward{
Host: "fluentd.svc",
Port: utils.ToPtr[int32](24224),
RetainMetadataInForwardMode: utils.ToPtr(false),
},
},
}}}
resultFalse, err := falseOut.Load(sl)
g.Expect(err).NotTo(HaveOccurred())
g.Expect(resultFalse).To(ContainSubstring("Retain_Metadata_In_Forward_Mode false"))

// true: field should be rendered as true
trueOut := ClusterOutputList{Items: []ClusterOutput{{
ObjectMeta: metav1.ObjectMeta{Name: "fwd-true"},
Spec: OutputSpec{
Match: "kube.*",
Forward: &output.Forward{
Host: "fluentd.svc",
Port: utils.ToPtr[int32](24224),
RetainMetadataInForwardMode: utils.ToPtr(true),
},
},
}}}
resultTrue, err := trueOut.Load(sl)
g.Expect(err).NotTo(HaveOccurred())
g.Expect(resultTrue).To(ContainSubstring("Retain_Metadata_In_Forward_Mode true"))
}
5 changes: 4 additions & 1 deletion apis/fluentbit/v1alpha2/plugins/output/forward_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ type Forward struct {
Password *plugins.Secret `json:"password,omitempty"`
// Default value of the auto-generated certificate common name (CN).
SelfHostname string `json:"selfHostname,omitempty"`
*plugins.TLS `json:"tls,omitempty"`
// Retain metadata when forwarding in forward mode.
RetainMetadataInForwardMode *bool `json:"retainMetadataInForwardMode,omitempty"`
*plugins.TLS `json:"tls,omitempty"`
// Include fluentbit networking options for this output-plugin
*plugins.Networking `json:"networking,omitempty"`
}
Expand Down Expand Up @@ -82,6 +84,7 @@ func (f *Forward) Params(sl plugins.SecretLoader) (*params.KVs, error) {
plugins.InsertKVField(kvs, "Time_as_Integer", f.TimeAsInteger)
plugins.InsertKVField(kvs, "Send_options", f.SendOptions)
plugins.InsertKVField(kvs, "Require_ack_response", f.RequireAckResponse)
plugins.InsertKVField(kvs, "Retain_Metadata_In_Forward_Mode", f.RetainMetadataInForwardMode)

return kvs, nil
}
5 changes: 5 additions & 0 deletions apis/fluentbit/v1alpha2/plugins/output/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions charts/fluent-operator-fluent-bit-crds/templates/fluentbit.fluent.io_clusteroutputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1156,6 +1156,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
3 changes: 3 additions & 0 deletions charts/fluent-operator-fluent-bit-crds/templates/fluentbit.fluent.io_outputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1156,6 +1156,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
3 changes: 3 additions & 0 deletions charts/fluent-operator/crds/fluentbit.fluent.io_clusteroutputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1154,6 +1154,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
3 changes: 3 additions & 0 deletions charts/fluent-operator/crds/fluentbit.fluent.io_outputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1154,6 +1154,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
3 changes: 3 additions & 0 deletions charts/fluent-operator/templates/fluentbit-output-forward.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ spec:
forward:
host: {{ printf "%s.%s.svc.cluster.local" .Values.fluentd.name .Release.Namespace | quote }}
port: {{ .Values.fluentd.forward.port }}
{{- if not (kindIs "invalid" .Values.fluentd.forward.retainMetadataInForwardMode) }}
retainMetadataInForwardMode: {{ .Values.fluentd.forward.retainMetadataInForwardMode }}
{{- end }}
{{- end }}
{{- end }}
{{- end }}
3 changes: 3 additions & 0 deletions charts/fluent-operator/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,9 @@ fluentd:
forward:
# -- Forward input port
port: 24224
# -- Retain metadata when forwarding in forward mode.
# Set to false for Fluentd compatibility with Fluent Bit v5.0.5+.
retainMetadataInForwardMode: ~
# -- Namespaces to watch for Fluentd resources
watchedNamespaces:
- kube-system
Expand Down
3 changes: 3 additions & 0 deletions config/crd/bases/fluentbit.fluent.io_clusteroutputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1155,6 +1155,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
3 changes: 3 additions & 0 deletions config/crd/bases/fluentbit.fluent.io_outputs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1155,6 +1155,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
1 change: 1 addition & 0 deletions docs/plugins/fluentbit/output/forward.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Forward is the protocol used by Fluentd to route messages between peers. <br />
| username | Specify the username to present to a Fluentd server that enables user_auth. | *[plugins.Secret](../secret.md) |
| password | Specify the password corresponding to the username. | *[plugins.Secret](../secret.md) |
| selfHostname | Default value of the auto-generated certificate common name (CN). | string |
| retainMetadataInForwardMode | Retain metadata when forwarding in forward mode. | *bool |
| tls | | *[plugins.TLS](../tls.md) |
| networking | Include fluentbit networking options for this output-plugin | *plugins.Networking |
6 changes: 6 additions & 0 deletions manifests/setup/fluent-operator-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5355,6 +5355,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down Expand Up @@ -35442,6 +35445,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
6 changes: 6 additions & 0 deletions manifests/setup/setup.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5355,6 +5355,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down Expand Up @@ -35442,6 +35445,9 @@ spec:
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
type: boolean
retainMetadataInForwardMode:
description: Retain metadata when forwarding in forward mode.
type: boolean
selfHostname:
description: Default value of the auto-generated certificate common
name (CN).
Expand Down
Loading