feat: add latest syslog-ng stats syntax by default but do not enforce it if the old syntax is used explicitly

Signed-off-by: Peter Wilcsinszky <[email protected]>

Author: pepov

config/crd/bases/logging.banzaicloud.io_loggings.yaml

@@ -13660,6 +13660,13 @@ spec:
                     type: object
                   globalOptions:
                     properties:
+                      stats:
+                        properties:
+                          freq:
+                            type: integer
+                          level:
+                            type: integer
+                        type: object
                       stats_freq:
                         type: integer
                       stats_level:

e2e/charts/logging-operator/crds/logging.banzaicloud.io_loggings.yaml

@@ -13660,6 +13660,13 @@ spec:
                     type: object
                   globalOptions:
                     properties:
+                      stats:
+                        properties:
+                          freq:
+                            type: integer
+                          level:
+                            type: integer
+                        type: object
                       stats_freq:
                         type: integer
                       stats_level:

pkg/sdk/logging/api/v1beta1/syslogng_types.go

@@ -61,6 +61,15 @@ type SyslogNGTLS struct {
 }
 
 type GlobalOptions struct {
+	// deprecated use stats/level from 4.1+
 	StatsLevel *int `json:"stats_level,omitempty"`
-	StatsFreq  *int `json:"stats_freq,omitempty"`
+	// deprecated use stats/freq from 4.1+
+	StatsFreq *int `json:"stats_freq,omitempty"`
+	// TODO switch to this by default
+	Stats *Stats `json:"stats,omitempty"`
+}
+
+type Stats struct {
+	Level *int `json:"level,omitempty"`
+	Freq  *int `json:"freq,omitempty"`
 }

pkg/sdk/logging/api/v1beta1/zz_generated.deepcopy.go

@@ -65,8 +65,15 @@ func configRenderer(in Input) (render.Renderer, error) {
 	// TODO: this should happen at the spec level, in something like `SyslogNGSpec.FinalGlobalOptions() GlobalOptions`
 	if in.Logging.Spec.SyslogNGSpec.Metrics != nil {
 		setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions, &v1beta1.GlobalOptions{})
-		setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsFreq, amp(10))
-		setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsLevel, amp(2))
+		if in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsFreq != nil ||
+			in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsLevel != nil {
+			setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsFreq, amp(10))
+			setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.StatsLevel, amp(2))
+		} else {
+			setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.Stats, &v1beta1.Stats{})
+			setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.Stats.Freq, amp(10))
+			setDefault(&in.Logging.Spec.SyslogNGSpec.GlobalOptions.Stats.Level, amp(2))
+		}
 	}
 
 	globalOptions := renderAny(in.Logging.Spec.SyslogNGSpec.GlobalOptions, in.SecretLoaderFactory.SecretLoaderForNamespace(in.Logging.Namespace))

pkg/sdk/logging/model/syslogng/config/config.go

@@ -18,13 +18,14 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
-	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/syslogng/filter"
-	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/syslogng/output"
 	"github.com/cisco-open/operator-tools/pkg/secret"
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
+	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/syslogng/filter"
+	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/syslogng/output"
 )
 
 func TestRenderConfigInto(t *testing.T) {
@@ -168,6 +169,78 @@ options {
     stats_freq(0);
 };
 
+source "main_input" {
+    channel {
+        source {
+            network(flags("no-parse") port(601) transport("tcp"));
+        };
+        parser {
+            json-parser(prefix("json."));
+        };
+    };
+};
+`,
+		},
+		"global options default": {
+			input: Input{
+				Logging: v1beta1.Logging{
+					Spec: v1beta1.LoggingSpec{
+						SyslogNGSpec: &v1beta1.SyslogNGSpec{
+							Metrics: &v1beta1.Metrics{
+								Path: "/metrics",
+							},
+							GlobalOptions: &v1beta1.GlobalOptions{},
+						},
+					},
+				},
+				SourcePort:          601,
+				SecretLoaderFactory: &TestSecretLoaderFactory{},
+			},
+			wantOut: `@version: current
+
+@include "scl.conf"
+
+options {
+    stats(level(2) freq(10));
+};
+
+source "main_input" {
+    channel {
+        source {
+            network(flags("no-parse") port(601) transport("tcp"));
+        };
+        parser {
+            json-parser(prefix("json."));
+        };
+    };
+};
+`,
+		},
+		"global options_new_stats": {
+			input: Input{
+				Logging: v1beta1.Logging{
+					Spec: v1beta1.LoggingSpec{
+						SyslogNGSpec: &v1beta1.SyslogNGSpec{
+							GlobalOptions: &v1beta1.GlobalOptions{
+								Stats: &v1beta1.Stats{
+									Level: amp(3),
+									Freq:  amp(0),
+								},
+							},
+						},
+					},
+				},
+				SourcePort:          601,
+				SecretLoaderFactory: &TestSecretLoaderFactory{},
+			},
+			wantOut: `@version: current
+
+@include "scl.conf"
+
+options {
+    stats(level(3) freq(0));
+};
+
 source "main_input" {
     channel {
         source {