Feat: Added ETW logging support for CNS.

cns/azure-cns-windows.yaml

@@ -112,5 +112,6 @@ data:
           "NodeSyncIntervalInSeconds": 30
       },
       "ChannelMode": "CRD",
-      "InitializeFromCNI": true
+      "InitializeFromCNI": true,
+      "EnableETWLogging": true
     }

cns/configuration/configuration.go

@@ -57,6 +57,7 @@ type CNSConfig struct {
 	UseHTTPS                    bool
 	WatchPods                   bool `json:"-"`
 	WireserverIP                string
+	EnableETWLogging            bool
 }
 
 type TelemetrySettings struct {

cns/logger/cnslogger.go

@@ -8,6 +8,8 @@ import (
 	"github.com/Azure/azure-container-networking/cns/types"
 	"github.com/Azure/azure-container-networking/log"
 	"github.com/pkg/errors"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 )
 
 type CNSLogger struct {
@@ -17,6 +19,9 @@ type CNSLogger struct {
 	DisableMetricLogging bool
 	DisableEventLogging  bool
 
+	zapLogger        *zap.Logger
+	enableETWLogging bool
+
 	m            sync.RWMutex
 	Orchestrator string
 	NodeID       string
@@ -28,7 +33,19 @@ func NewCNSLogger(fileName string, logLevel, logTarget int, logDir string) (*CNS
 		return nil, errors.Wrap(err, "could not get new logger")
 	}
 
-	return &CNSLogger{logger: l}, nil
+	zapLogger, err := initZapLogger(zapcore.DebugLevel, getJSONEncoder())
+	if err != nil {
+		return nil, errors.Wrap(err, "could not get ETW logger")
+	}
+
+	return &CNSLogger{
+		logger:    l,
+		zapLogger: zapLogger,
+	}, nil
+}
+
+func (c *CNSLogger) EnableETWLogging(enableETWLogging bool) {
+	c.enableETWLogging = enableETWLogging
 }
 
 func (c *CNSLogger) InitAI(aiConfig aitelemetry.AIConfig, disableTraceLogging, disableMetricLogging, disableEventLogging bool) {
@@ -70,6 +87,10 @@ func (c *CNSLogger) SetContextDetails(orchestrator, nodeID string) {
 func (c *CNSLogger) Printf(format string, args ...any) {
 	c.logger.Logf(format, args...)
 
+	if c.enableETWLogging {
+		c.zapLogger.Info(fmt.Sprintf(format, args...))
+	}
+
 	if c.th == nil || c.DisableTraceLogging {
 		return
 	}
@@ -81,6 +102,10 @@ func (c *CNSLogger) Printf(format string, args ...any) {
 func (c *CNSLogger) Debugf(format string, args ...any) {
 	c.logger.Debugf(format, args...)
 
+	if c.enableETWLogging {
+		c.zapLogger.Debug(fmt.Sprintf(format, args...))
+	}
+
 	if c.th == nil || c.DisableTraceLogging {
 		return
 	}
@@ -92,6 +117,10 @@ func (c *CNSLogger) Debugf(format string, args ...any) {
 func (c *CNSLogger) Warnf(format string, args ...any) {
 	c.logger.Warnf(format, args...)
 
+	if c.enableETWLogging {
+		c.zapLogger.Warn(fmt.Sprintf(format, args...))
+	}
+
 	if c.th == nil || c.DisableTraceLogging {
 		return
 	}
@@ -103,6 +132,10 @@ func (c *CNSLogger) Warnf(format string, args ...any) {
 func (c *CNSLogger) Errorf(format string, args ...any) {
 	c.logger.Errorf(format, args...)
 
+	if c.enableETWLogging {
+		c.zapLogger.Error(fmt.Sprintf(format, args...))
+	}
+
 	if c.th == nil || c.DisableTraceLogging {
 		return
 	}

cns/logger/cnslogger_linux.go

@@ -0,0 +1,14 @@
+package logger
+
+import (
+	"go.uber.org/zap/zapcore"
+)
+
+const (
+	// LogPath is the path where log files are stored.
+	LogPath = "/var/log/"
+)
+
+func GetPlatformCores(_ zapcore.Level, _ zapcore.Encoder) (zapcore.Core, error) {
+	return nil, nil
+}

cns/logger/cnslogger_windows.go

@@ -0,0 +1,29 @@
+package logger
+
+import (
+	"github.com/Azure/azure-container-networking/zapetw"
+	"github.com/pkg/errors"
+	"go.uber.org/zap/zapcore"
+)
+
+const (
+	// LogPath is the path where log files are stored.
+	LogPath         = ""
+	etwCNSEventName = "AzureCNS"
+)
+
+func GetPlatformCores(loggingLevel zapcore.Level, encoder zapcore.Encoder) (zapcore.Core, error) {
+	etwcore, err := GetETWCore(loggingLevel, encoder)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to get ETW core")
+	}
+	return etwcore, nil
+}
+
+func GetETWCore(loggingLevel zapcore.Level, encoder zapcore.Encoder) (zapcore.Core, error) {
+	etwcore, err := zapetw.NewETWCore(etwCNSEventName, encoder, loggingLevel)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to create ETW core")
+	}
+	return etwcore, nil
+}

cns/logger/log.go

@@ -33,6 +33,10 @@ func SetContextDetails(orchestrator, nodeID string) {
 	Log.SetContextDetails(orchestrator, nodeID)
 }
 
+func EnableETWLogging(enableETWLogging bool) {
+	Log.EnableETWLogging(enableETWLogging)
+}
+
 func Printf(format string, args ...any) {
 	Log.Printf(format, args...)
 }

cns/logger/zaplogger.go

@@ -0,0 +1,24 @@
+package logger
+
+import (
+	"os"
+
+	"github.com/pkg/errors"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+func initZapLogger(loggingLevel zapcore.Level, encoder zapcore.Encoder) (*zap.Logger, error) {
+	platformCore, err := GetPlatformCores(loggingLevel, encoder)
+	if err != nil {
+		return nil, errors.Wrap(err, "failed to get Platform cores")
+	}
+	// Create a new logger with the platform core.
+	return zap.New(platformCore, zap.AddCaller()).With(zap.Int("pid", os.Getpid())), nil
+}
+
+func getJSONEncoder() zapcore.Encoder {
+	encoderConfig := zap.NewProductionEncoderConfig()
+	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
+	return zapcore.NewJSONEncoder(encoderConfig)
+}

cns/service/main.go

@@ -578,6 +578,9 @@ func main() {
 		}
 	}
 
+	if cnsconfig.EnableETWLogging {
+		logger.EnableETWLogging(cnsconfig.EnableETWLogging)
+	}
 	logger.Printf("[Azure CNS] Using config: %+v", cnsconfig)
 
 	_, envEnableConflistGeneration := os.LookupEnv(envVarEnableCNIConflistGeneration)