RSDK-9742: Add event logger support for windows.

go.mod

@@ -82,7 +82,7 @@ require (
 	golang.org/x/image v0.19.0
 	golang.org/x/mobile v0.0.0-20240112133503-c713f31d574b
 	golang.org/x/sync v0.8.0
-	golang.org/x/sys v0.27.0
+	golang.org/x/sys v0.29.0
 	golang.org/x/term v0.25.0
 	golang.org/x/text v0.19.0
 	golang.org/x/time v0.6.0

go.sum

@@ -1778,8 +1778,8 @@ golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
-golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
+golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20220526004731-065cf7ba2467/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=

logging/appender.go

@@ -36,6 +36,19 @@ func NewWriterAppender(writer io.Writer) ConsoleAppender {
 	return ConsoleAppender{writer}
 }
 
+func ZapcoreFieldsToJSON(fields []zapcore.Field) (string, error) {
+	// Use zap's json encoder which will encode our slice of fields in-order. As opposed to the
+	// random iteration order of a map. Call it with an empty Entry object such that only the fields
+	// become "map-ified".
+	jsonEncoder := zapcore.NewJSONEncoder(zapcore.EncoderConfig{SkipLineEnding: true})
+	buf, err := jsonEncoder.EncodeEntry(zapcore.Entry{}, fields)
+	if err != nil {
+		return "", err
+	}
+
+	return string(buf.Bytes()), nil
+}
+
 // Write outputs the log entry to the underlying stream.
 func (appender ConsoleAppender) Write(entry zapcore.Entry, fields []zapcore.Field) error {
 	const maxLength = 10
@@ -54,17 +67,11 @@ func (appender ConsoleAppender) Write(entry zapcore.Entry, fields []zapcore.Fiel
 		return nil
 	}
 
-	// Use zap's json encoder which will encode our slice of fields in-order. As opposed to the
-	// random iteration order of a map. Call it with an empty Entry object such that only the fields
-	// become "map-ified".
-	jsonEncoder := zapcore.NewJSONEncoder(zapcore.EncoderConfig{SkipLineEnding: true})
-	buf, err := jsonEncoder.EncodeEntry(zapcore.Entry{}, fields)
+	fieldsJSON, err := ZapcoreFieldsToJSON(fields)
 	if err != nil {
-		// Log what we have and return the error.
 		fmt.Fprintln(appender.Writer, strings.Join(toPrint, "\t")) //nolint:errcheck
-		return err
 	}
-	toPrint = append(toPrint, string(buf.Bytes()))
+	toPrint = append(toPrint, fieldsJSON)
 
 	fmt.Fprintln(appender.Writer, strings.Join(toPrint, "\t")) //nolint:errcheck
 	return nil

logging/noop_event_logger.go

@@ -0,0 +1,5 @@
+//go:build !windows
+
+package logging
+
+func RegisterEventLogger(rootLogger Logger) {}

logging/windows_event_logger.go

@@ -0,0 +1,63 @@
+//go:build windows
+
+package logging
+
+import (
+	"strings"
+
+	"go.uber.org/zap/zapcore"
+	"golang.org/x/sys/windows/svc/eventlog"
+)
+
+func RegisterEventLogger(rootLogger Logger) {
+	log, err := eventlog.Open("viam-server")
+	if err != nil {
+		rootLogger.Errorw("Unable to open windows event log", "err", err)
+	}
+	rootLogger.AddAppender(&eventLogger{log})
+}
+
+type eventLogger struct {
+	log *eventlog.Log
+}
+
+func getMessage(entry zapcore.Entry, fields []zapcore.Field) string {
+	const maxLength = 10
+	toPrint := make([]string, 0, maxLength)
+	// We use UTC such that logs from different `viam-server`s can have their logs compared without
+	// needing them to be configured in the same timezone.
+	toPrint = append(toPrint, entry.Time.UTC().Format(DefaultTimeFormatStr))
+	toPrint = append(toPrint, strings.ToUpper(entry.Level.String()))
+	toPrint = append(toPrint, entry.LoggerName)
+	if entry.Caller.Defined {
+		toPrint = append(toPrint, callerToString(&entry.Caller))
+	}
+	toPrint = append(toPrint, entry.Message)
+	if len(fields) == 0 {
+		return strings.Join(toPrint, "\t")
+	}
+
+	fieldsJSON, err := ZapcoreFieldsToJSON(fields)
+	if err != nil {
+		return strings.Join(toPrint, "\t")
+	}
+	toPrint = append(toPrint, fieldsJSON)
+
+	return strings.Join(toPrint, "\t")
+}
+
+func (el *eventLogger) Write(entry zapcore.Entry, fields []zapcore.Field) error {
+	switch entry.Level {
+	case zapcore.DebugLevel, zapcore.InfoLevel:
+		el.log.Info(0, getMessage(entry, fields))
+	case zapcore.WarnLevel:
+		el.log.Warning(0, getMessage(entry, fields))
+	default: // includes zapcore.ErrorLevel and "more threatening" levels
+		el.log.Error(0, getMessage(entry, fields))
+	}
+	return nil
+}
+
+func (el *eventLogger) Sync() error {
+	return nil
+}

web/server/entrypoint.go

@@ -116,6 +116,7 @@ func RunServer(ctx context.Context, args []string, _ logging.Logger) (err error)
 	}
 
 	logger, registry := logging.NewLoggerWithRegistry("rdk")
+	logging.RegisterEventLogger(logger)
 	logging.ReplaceGlobal(logger)
 	config.InitLoggingSettings(logger, argsParsed.Debug)