feat(fluentbit): add enable_flb_null to fluentbit filter params

Signed-off-by: Siarhei Rasiukevich <[email protected]>

Author: CharlieR-o-o-t

apis/fluentbit/v1alpha2/plugins/filter/lua_types.go

@@ -36,6 +36,9 @@ type Lua struct {
 	// If enabled, Lua script will be executed in protected mode.
 	// It prevents to crash when invalid Lua script is executed. Default is true.
 	ProtectedMode *bool `json:"protectedMode,omitempty"`
+	// If enabled, null will be converted to flb_null in Lua.
+	// This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+	EnableFlbNull *bool `json:"enable_flb_null,omitempty"`
 	// By default when the Lua script is invoked, the record timestamp is passed as a
 	// Floating number which might lead to loss precision when the data is converted back.
 	// If you desire timestamp precision enabling this option will pass the timestamp as
@@ -90,6 +93,10 @@ func (l *Lua) Params(_ plugins.SecretLoader) (*params.KVs, error) {
 		kvs.Insert("protected_mode", strconv.FormatBool(*l.ProtectedMode))
 	}
 
+	if l.EnableFlbNull != nil {
+		kvs.Insert("enable_flb_null", strconv.FormatBool(*l.EnableFlbNull))
+	}
+
 	if l.TimeAsTable {
 		kvs.Insert("time_as_table", "true")
 	}

apis/fluentbit/v1alpha2/plugins/filter/zz_generated.deepcopy.go

@@ -2,7 +2,7 @@ apiVersion: v2
 name: fluent-bit-crds
 description: A helm chart for Fluent-Bit custom resource definitions (CRDs) used by fluent-operator.
 type: application
-version: 0.2.0
+version: 0.2.1
 appVersion: v3.5.0
 keywords:
   - logging

charts/fluent-bit-crds/Chart.yaml

@@ -429,6 +429,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.

charts/fluent-bit-crds/templates/fluentbit.fluent.io_clusterfilters.yaml

@@ -429,6 +429,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.

charts/fluent-bit-crds/templates/fluentbit.fluent.io_filters.yaml

@@ -426,6 +426,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.

config/crd/bases/fluentbit.fluent.io_clusterfilters.yaml

@@ -426,6 +426,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.

config/crd/bases/fluentbit.fluent.io_filters.yaml

@@ -11,4 +11,5 @@ The Lua Filter allows you to modify the incoming records using custom Lua Script
 | typeIntKey | If these keys are matched, the fields are converted to integer. If more than one key, delimit by space. Note that starting from Fluent Bit v1.6 integer data types are preserved and not converted to double as in previous versions. | []string |
 | typeArrayKey | If these keys are matched, the fields are handled as array. If more than one key, delimit by space. It is useful the array can be empty. | []string |
 | protectedMode | If enabled, Lua script will be executed in protected mode. It prevents to crash when invalid Lua script is executed. Default is true. | *bool |
+| enable_flb_null | If enabled, null will be converted to flb_null in Lua. This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false. | *bool |
 | timeAsTable | By default when the Lua script is invoked, the record timestamp is passed as a Floating number which might lead to loss precision when the data is converted back. If you desire timestamp precision enabling this option will pass the timestamp as a Lua table with keys sec for seconds since epoch and nsec for nanoseconds. | bool |

docs/plugins/fluentbit/filter/lua.md

@@ -425,6 +425,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.
@@ -15389,6 +15394,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.

manifests/setup/fluent-operator-crd.yaml

@@ -425,6 +425,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.
@@ -15389,6 +15394,11 @@ spec:
                           description: Inline LUA code instead of loading from a path
                             via script.
                           type: string
+                        enable_flb_null:
+                          description: |-
+                            If enabled, null will be converted to flb_null in Lua.
+                            This helps prevent removing key/value since nil is a special value to remove key/value from map in Lua. Default value: false.
+                          type: boolean
                         protectedMode:
                           description: |-
                             If enabled, Lua script will be executed in protected mode.