More modernizing logging

Ported block_device/nbd
Made the native CGO return distinct errors in set_edid
Made the cgo_linux (go code) report C-level error return codes
Use defer for server and listener cleanup. Try doing a timeboxed GracefulStop of the server

Author: IDisposable

block_device.go

@@ -9,7 +9,6 @@ import (
 
 	"github.com/jetkvm/kvm/internal/logging"
 	"github.com/pojntfx/go-nbd/pkg/server"
-	"github.com/rs/zerolog"
 )
 
 type remoteImageBackend struct {
@@ -63,14 +62,18 @@ type NBDDevice struct {
 	serverConn net.Conn
 	clientConn net.Conn
 	dev        *os.File
-
-	l *zerolog.Logger
 }
 
 func NewNBDDevice() *NBDDevice {
 	return &NBDDevice{}
 }
 
+func (d *NBDDevice) getLogger() *logging.Context {
+	return logging.GetSubsystemLogger("nbd").
+		Str("socket_path", nbdSocketPath).
+		Str("device_path", nbdDevicePath)
+}
+
 func (d *NBDDevice) Start() error {
 	var err error
 
@@ -83,19 +86,10 @@ func (d *NBDDevice) Start() error {
 		return err
 	}
 
-	if d.l == nil {
-		scopedLogger := logging.GetSubsystemLogger("nbd").
-			With().
-			Str("socket_path", nbdSocketPath).
-			Str("device_path", nbdDevicePath).
-			Logger()
-		d.l = &scopedLogger
-	}
-
 	// Remove the socket file if it already exists
 	if _, err := os.Stat(nbdSocketPath); err == nil {
 		if err := os.Remove(nbdSocketPath); err != nil {
-			d.l.Error().Err(err).Msg("failed to remove existing socket file")
+			d.getLogger().Error().Err(err).Msg("failed to remove existing socket file")
 			os.Exit(1)
 		}
 	}
@@ -137,5 +131,5 @@ func (d *NBDDevice) runServerConn() {
 			SupportsMultiConn:  false,
 		})
 
-	d.l.Info().Err(err).Msg("nbd server exited")
+	d.getLogger().Info().Err(err).Msg("nbd server exited")
 }

block_device_linux.go

@@ -11,14 +11,14 @@ func (d *NBDDevice) runClientConn() {
 		ExportName: "jetkvm",
 		BlockSize:  uint32(4 * 1024),
 	})
-	d.l.Info().Err(err).Msg("nbd client exited")
+	d.getLogger().Info().Err(err).Msg("nbd client exited")
 }
 
 func (d *NBDDevice) Close() {
 	if d.dev != nil {
 		err := client.Disconnect(d.dev)
 		if err != nil {
-			d.l.Warn().Err(err).Msg("error disconnecting nbd client")
+			d.getLogger().Warn().Err(err).Msg("error disconnecting nbd client")
 		}
 		_ = d.dev.Close()
 	}

block_device_notlinux.go

@@ -7,11 +7,11 @@ import (
 )
 
 func (d *NBDDevice) runClientConn() {
-	d.l.Error().Msg("platform not supported")
+	d.getLogger().Error().Msg("platform not supported")
 	os.Exit(1)
 }
 
 func (d *NBDDevice) Close() {
-	d.l.Error().Msg("platform not supported")
+	d.getLogger().Error().Msg("platform not supported")
 	os.Exit(1)
 }

cloud.go

@@ -21,7 +21,6 @@ import (
 
 	"github.com/coder/websocket"
 	"github.com/gin-gonic/gin"
-	"github.com/rs/zerolog"
 )
 
 type CloudRegisterRequest struct {
@@ -325,19 +324,13 @@ func runWebsocketClient() error {
 	header.Set("Authorization", "Bearer "+config.CloudToken)
 	dialCtx, cancelDial := context.WithTimeout(context.Background(), CloudWebSocketConnectTimeout)
 
-	l := logging.GetSubsystemLogger("websocket").
-		With().
-		Str("source", wsURL.Host).
-		Str("sourceType", "cloud").
-		Logger()
-
-	scopedLogger := &l
+	logger := logging.GetSubsystemLogger("websocket").Str("source", wsURL.Host).Str("sourceType", "cloud")
 
 	defer cancelDial()
 	c, resp, err := websocket.Dial(dialCtx, wsURL.String(), &websocket.DialOptions{
 		HTTPHeader: header,
 		OnPingReceived: func(ctx context.Context, payload []byte) bool {
-			scopedLogger.Debug().Bytes("payload", payload).Int("length", len(payload)).Msg("ping frame received")
+			logger.Debug().Bytes("payload", payload).Int("length", len(payload)).Msg("ping frame received")
 
 			metricConnectionTotalPingReceivedCount.WithLabelValues("cloud", wsURL.Host).Inc()
 			metricConnectionLastPingReceivedTimestamp.WithLabelValues("cloud", wsURL.Host).SetToCurrentTime()
@@ -359,15 +352,12 @@ func runWebsocketClient() error {
 
 	if connectionId == "" {
 		connectionId = uuid.New().String()
-		scopedLogger.Warn().
+		logger.Warn().
 			Str("connectionId", connectionId).
 			Msg("no connection id received from the server, generating a new one")
 	}
 
-	lWithConnectionId := scopedLogger.With().
-		Str("connectionID", connectionId).
-		Logger()
-	scopedLogger = &lWithConnectionId
+	logger = logger.With().Str("connectionID", connectionId)
 
 	cloudLogger := logging.GetSubsystemLogger("cloud")
 
@@ -391,7 +381,7 @@ func runWebsocketClient() error {
 	wsResetMetrics(true, "cloud", wsURL.Host)
 
 	// we don't have a source for the cloud connection
-	return handleWebRTCSignalWsMessages(c, true, wsURL.Host, connectionId, scopedLogger)
+	return handleWebRTCSignalWsMessages(c, true, wsURL.Host, connectionId)
 }
 
 func authenticateSession(ctx context.Context, c *websocket.Conn, req WebRTCSessionRequest) error {
@@ -431,7 +421,6 @@ func handleSessionRequest(
 	req WebRTCSessionRequest,
 	isCloudConnection bool,
 	source string,
-	scopedLogger *zerolog.Logger,
 ) error {
 	var sourceType string
 	if isCloudConnection {

display.go

@@ -193,7 +193,6 @@ func requestDisplayUpdate(shouldWakeDisplay bool, reason string) {
 		if shouldWakeDisplay {
 			wakeDisplay(false, reason)
 		}
-		logging.GetSubsystemLogger("display").Debug().Msg("display updating")
 		// TODO: only run once regardless how many pending updates
 		updateDisplay()
 	}()

internal/hidrpc/log.go

@@ -5,5 +5,5 @@ import (
 )
 
 func GetHidRpcLoggingContext() *logging.Context {
-	return logging.NewContext(logging.GetSubsystemLogger("hidrpc"))
+	return logging.GetSubsystemLogger("hidrpc")
 }