Add shim log options

Signed-off-by: Austin Vazquez <austin.vazquez@docker.com>

Author: austinvazquez

pkg/logging/logging.go

@@ -31,18 +31,53 @@ import (
 	"github.com/containerd/log"
 )
 
+// Format identifies the encoding used for shim log output.
+type Format int
+
+const (
+	// FormatText emits human-readable slog text output (the default).
+	FormatText Format = iota
+	// FormatJSON emits one JSON object per line.
+	FormatJSON
+)
+
+// Option configures [SetupShimLog].
+type Option func(*shimLogConfig)
+
+type shimLogConfig struct {
+	format Format
+}
+
+// WithFormat sets the log output format. The default is [FormatText], which
+// preserves the existing shim log format. Pass [FormatJSON] to emit one JSON
+// object per line, which allows structured log consumers (e.g. sandboxd) to
+// unwrap records directly instead of treating each line as an opaque message.
+func WithFormat(f Format) Option {
+	return func(c *shimLogConfig) {
+		c.format = f
+	}
+}
+
 // SetupShimLog configures slog-based logging for the shim process.
 // It opens the platform-specific log output (FIFO on Unix, named pipe
-// on Windows), then creates a slog TextHandler and sets it as the
-// default logger with a "component=shim" attribute.
+// on Windows), then creates a slog handler and sets it as the default
+// logger with a "component=shim" attribute.
+//
+// The handler's format defaults to [FormatText]. Pass [WithFormat]([FormatJSON])
+// to emit JSON, which structured log consumers can unwrap directly.
 //
 // The base handler (without component) is stored for use by
 // [ForwardConsoleLogs] so that forwarded records carry their own
 // component rather than inheriting "shim".
 //
 // For the short-lived start and delete actions, only [log.UseSlog] is
 // called to route logrus through slog; the log output is not opened.
-func SetupShimLog() {
+func SetupShimLog(opts ...Option) {
+	cfg := shimLogConfig{format: FormatText}
+	for _, o := range opts {
+		o(&cfg)
+	}
+
 	log.UseSlog()
 
 	var (
@@ -81,7 +116,15 @@ func SetupShimLog() {
 		log.SetLevel("debug") //nolint:errcheck
 	}
 
-	handler := slog.NewTextHandler(w, &slog.HandlerOptions{Level: &level}).WithAttrs(attrs)
+	handlerOpts := &slog.HandlerOptions{Level: &level}
+	var handler slog.Handler
+	switch cfg.format {
+	case FormatJSON:
+		handler = slog.NewJSONHandler(w, handlerOpts)
+	default:
+		handler = slog.NewTextHandler(w, handlerOpts)
+	}
+	handler = handler.WithAttrs(attrs)
 	SetBaseHandler(handler)
 	slog.SetDefault(slog.New(handler).With("component", "shim"))
 }

pkg/logging/logging_test.go

@@ -235,6 +235,29 @@ func TestForwardConsoleLogs_DebugLevel(t *testing.T) {
 	}
 }
 
+func TestWithFormat(t *testing.T) {
+	cfg := shimLogConfig{format: FormatText}
+	WithFormat(FormatJSON)(&cfg)
+	if cfg.format != FormatJSON {
+		t.Errorf("WithFormat(FormatJSON): got %d, want %d", cfg.format, FormatJSON)
+	}
+
+	cfg = shimLogConfig{format: FormatJSON}
+	WithFormat(FormatText)(&cfg)
+	if cfg.format != FormatText {
+		t.Errorf("WithFormat(FormatText): got %d, want %d", cfg.format, FormatText)
+	}
+}
+
+func TestSetupShimLogDefaultIsText(t *testing.T) {
+	// FormatText must be the zero value so that a shimLogConfig without
+	// explicit initialisation defaults to text (backward-compatible).
+	var cfg shimLogConfig
+	if cfg.format != FormatText {
+		t.Errorf("zero-value shimLogConfig.format = %d, want FormatText (%d)", cfg.format, FormatText)
+	}
+}
+
 func TestForwardJSONLog_InvalidJSON(t *testing.T) {
 	SetBaseHandler(discardHandler{})
 	if forwardJSONLog("{not json") {