Control plane support log output as json (#7455)

* Control plane support log output as json

Signed-off-by: zirain <[email protected]>

* gen

Signed-off-by: zirain <[email protected]>

---------

Signed-off-by: zirain <[email protected]>

Author: zirain

api/v1alpha1/envoygateway_types.go

@@ -199,8 +199,22 @@ type EnvoyGatewayLogging struct {
 	//
 	// +kubebuilder:default={default: info}
 	Level map[EnvoyGatewayLogComponent]LogLevel `json:"level,omitempty"`
+	// Encoder defines the log encoder format.
+	// If unspecified, defaults to "Text".
+	//
+	// +optional
+	Encoder *EnvoyGatewayLogEncoder `json:"encoder,omitempty"`
 }
 
+type EnvoyGatewayLogEncoder string
+
+const (
+	// EnvoyGatewayLogEncoderText defines the "Text" log encoder.
+	EnvoyGatewayLogEncoderText EnvoyGatewayLogEncoder = "Text"
+	// EnvoyGatewayLogEncoderJSON defines the "JSON" log encoder.
+	EnvoyGatewayLogEncoderJSON EnvoyGatewayLogEncoder = "JSON"
+)
+
 // EnvoyGatewayLogComponent defines a component that supports a configured logging level.
 // +kubebuilder:validation:Enum=default;provider;gateway-api;xds-translator;xds-server;xds;infrastructure;global-ratelimit
 type EnvoyGatewayLogComponent string

api/v1alpha1/zz_generated.deepcopy.go

@@ -112,7 +112,21 @@ func (l Logger) Sugar() *zap.SugaredLogger {
 
 func initZapLogger(w io.Writer, logging *egv1a1.EnvoyGatewayLogging, level egv1a1.LogLevel) *zap.Logger {
 	parseLevel, _ := zapcore.ParseLevel(string(logging.DefaultEnvoyGatewayLoggingLevel(level)))
-	core := zapcore.NewCore(zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig()), zapcore.AddSync(w), zap.NewAtomicLevelAt(parseLevel))
+	cfg := zap.NewDevelopmentEncoderConfig()
+	var encoder zapcore.Encoder
+	logEncoder := egv1a1.EnvoyGatewayLogEncoderText
+	if logging != nil && logging.Encoder != nil {
+		logEncoder = *logging.Encoder
+	}
+
+	switch logEncoder {
+	case egv1a1.EnvoyGatewayLogEncoderJSON:
+		encoder = zapcore.NewJSONEncoder(cfg)
+	default:
+		encoder = zapcore.NewConsoleEncoder(cfg)
+	}
+
+	core := zapcore.NewCore(encoder, zapcore.AddSync(w), zap.NewAtomicLevelAt(parseLevel))
 
 	return zap.New(core, zap.AddCaller())
 }

internal/logging/log.go

@@ -1423,6 +1423,21 @@ _Appears in:_
 | `global-ratelimit` | LogComponentGlobalRateLimitRunner defines the "global-ratelimit" runner component.<br /> | 
 
 
+#### EnvoyGatewayLogEncoder
+
+_Underlying type:_ _string_
+
+
+
+_Appears in:_
+- [EnvoyGatewayLogging](#envoygatewaylogging)
+
+| Value | Description |
+| ----- | ----------- |
+| `Text` | EnvoyGatewayLogEncoderText defines the "Text" log encoder.<br /> | 
+| `JSON` | EnvoyGatewayLogEncoderJSON defines the "JSON" log encoder.<br /> | 
+
+
 #### EnvoyGatewayLogging
 
 
@@ -1436,6 +1451,7 @@ _Appears in:_
 | Field | Type | Required | Default | Description |
 | ---   | ---  | ---      | ---     | ---         |
 | `level` | _object (keys:[EnvoyGatewayLogComponent](#envoygatewaylogcomponent), values:[LogLevel](#loglevel))_ |  true  | \{ default:info \} | Level is the logging level. If unspecified, defaults to "info".<br />EnvoyGatewayLogComponent options: default/provider/gateway-api/xds-translator/xds-server/infrastructure/global-ratelimit.<br />LogLevel options: debug/info/error/warn. |
+| `encoder` | _[EnvoyGatewayLogEncoder](#envoygatewaylogencoder)_ |  false  |  | Encoder defines the log encoder format.<br />If unspecified, defaults to "Text". |
 
 
 #### EnvoyGatewayMetricSink