feat: replace zap with slog (#1527)

Author: IndraGunawan

caddy/caddy.go

@@ -7,6 +7,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log/slog"
 	"net/http"
 	"path/filepath"
 	"strconv"
@@ -23,7 +24,6 @@ import (
 	"github.com/caddyserver/caddy/v2/modules/caddyhttp/fileserver"
 	"github.com/caddyserver/caddy/v2/modules/caddyhttp/rewrite"
 	"github.com/dunglas/frankenphp"
-	"go.uber.org/zap"
 )
 
 const defaultDocumentRoot = "public"
@@ -70,7 +70,7 @@ type FrankenPHPApp struct {
 	MaxWaitTime time.Duration `json:"max_wait_time,omitempty"`
 
 	metrics frankenphp.Metrics
-	logger  *zap.Logger
+	logger  *slog.Logger
 }
 
 // CaddyModule returns the Caddy module information.
@@ -83,7 +83,7 @@ func (f FrankenPHPApp) CaddyModule() caddy.ModuleInfo {
 
 // Provision sets up the module.
 func (f *FrankenPHPApp) Provision(ctx caddy.Context) error {
-	f.logger = ctx.Logger()
+	f.logger = ctx.Slogger()
 
 	if httpApp, err := ctx.AppIfConfigured("http"); err == nil {
 		if httpApp.(*caddyhttp.App).Metrics != nil {
@@ -345,7 +345,7 @@ type FrankenPHPModule struct {
 	resolvedDocumentRoot        string
 	preparedEnv                 frankenphp.PreparedEnv
 	preparedEnvNeedsReplacement bool
-	logger                      *zap.Logger
+	logger                      *slog.Logger
 }
 
 // CaddyModule returns the Caddy module information.
@@ -358,7 +358,7 @@ func (FrankenPHPModule) CaddyModule() caddy.ModuleInfo {
 
 // Provision sets up the module.
 func (f *FrankenPHPModule) Provision(ctx caddy.Context) error {
-	f.logger = ctx.Logger()
+	f.logger = ctx.Slogger()
 
 	if f.Root == "" {
 		if frankenphp.EmbeddedAppPath == "" {

caddy/go.mod

@@ -18,7 +18,6 @@ require (
 	github.com/prometheus/client_golang v1.22.0
 	github.com/spf13/cobra v1.9.1
 	github.com/stretchr/testify v1.10.0
-	go.uber.org/zap v1.27.0
 )
 
 require github.com/smallstep/go-attestation v0.4.4-0.20240109183208-413678f90935 // indirect
@@ -186,6 +185,7 @@ require (
 	go.uber.org/automaxprocs v1.6.0 // indirect
 	go.uber.org/mock v0.5.1 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
 	go.uber.org/zap/exp v0.3.0 // indirect
 	golang.org/x/crypto v0.37.0 // indirect
 	golang.org/x/crypto/x509roots/fallback v0.0.0-20250418111936-9c1aa6af88df // indirect

caddy/php-server.go

@@ -3,6 +3,7 @@ package caddy
 import (
 	"encoding/json"
 	"log"
+	"log/slog"
 	"net/http"
 	"os"
 	"path/filepath"
@@ -11,7 +12,6 @@ import (
 	"time"
 
 	mercureModule "github.com/dunglas/mercure/caddy"
-	"go.uber.org/zap/zapcore"
 
 	"github.com/caddyserver/caddy/v2"
 	"github.com/caddyserver/caddy/v2/caddyconfig"
@@ -334,7 +334,7 @@ func cmdPHPServer(fs caddycmd.Flags) (int, error) {
 		cfg.Logging = &caddy.Logging{
 			Logs: map[string]*caddy.CustomLog{
 				"default": {
-					BaseLog: caddy.BaseLog{Level: zapcore.DebugLevel.CapitalString()},
+					BaseLog: caddy.BaseLog{Level: slog.LevelDebug.String()},
 				},
 			},
 		}

context.go

@@ -2,20 +2,19 @@ package frankenphp
 
 import (
 	"context"
+	"log/slog"
 	"net/http"
 	"os"
 	"strings"
 	"time"
-
-	"go.uber.org/zap"
 )
 
 // frankenPHPContext provides contextual information about the Request to handle.
 type frankenPHPContext struct {
 	documentRoot    string
 	splitPath       []string
 	env             PreparedEnv
-	logger          *zap.Logger
+	logger          *slog.Logger
 	request         *http.Request
 	originalRequest *http.Request
 

frankenphp.go

@@ -33,6 +33,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"log/slog"
 	"net/http"
 	"os"
 	"os/signal"
@@ -43,9 +44,6 @@ import (
 	"syscall"
 	"time"
 	"unsafe"
-
-	"go.uber.org/zap"
-	"go.uber.org/zap/zapcore"
 	// debug on Linux
 	//_ "github.com/ianlancetaylor/cgosymbolizer"
 )
@@ -66,7 +64,7 @@ var (
 	isRunning bool
 
 	loggerMu sync.RWMutex
-	logger   *zap.Logger
+	logger   *slog.Logger
 
 	metrics Metrics = nullMetrics{}
 
@@ -234,10 +232,9 @@ func Init(options ...Option) error {
 	}
 
 	if opt.logger == nil {
-		l, err := zap.NewDevelopment()
-		if err != nil {
-			return err
-		}
+		// set a default logger
+		// to disable logging, set the logger to slog.New(slog.NewTextHandler(io.Discard, nil))
+		l := slog.New(slog.NewTextHandler(os.Stdout, nil))
 
 		loggerMu.Lock()
 		logger = l
@@ -294,13 +291,9 @@ func Init(options ...Option) error {
 
 	initAutoScaling(mainThread)
 
-	if c := logger.Check(zapcore.InfoLevel, "FrankenPHP started 🐘"); c != nil {
-		c.Write(zap.String("php_version", Version().Version), zap.Int("num_threads", mainThread.numThreads), zap.Int("max_threads", mainThread.maxThreads))
-	}
+	logger.LogAttrs(nil, slog.LevelInfo, "FrankenPHP started 🐘", slog.String("php_version", Version().Version), slog.Int("num_threads", mainThread.numThreads), slog.Int("max_threads", mainThread.maxThreads))
 	if EmbeddedAppPath != "" {
-		if c := logger.Check(zapcore.InfoLevel, "embedded PHP app 📦"); c != nil {
-			c.Write(zap.String("path", EmbeddedAppPath))
-		}
+		logger.LogAttrs(nil, slog.LevelInfo, "embedded PHP app 📦", slog.String("path", EmbeddedAppPath))
 	}
 
 	return nil
@@ -435,9 +428,7 @@ func go_ub_write(threadIndex C.uintptr_t, cBuf *C.char, length C.int) (C.size_t,
 
 	i, e := writer.Write(unsafe.Slice((*byte)(unsafe.Pointer(cBuf)), length))
 	if e != nil {
-		if c := fc.logger.Check(zapcore.ErrorLevel, "write error"); c != nil {
-			c.Write(zap.Error(e))
-		}
+		fc.logger.LogAttrs(nil, slog.LevelError, "write error", slog.Any("error", e))
 	}
 
 	if fc.responseWriter == nil {
@@ -456,9 +447,7 @@ func go_apache_request_headers(threadIndex C.uintptr_t) (*C.go_string, C.size_t)
 	if fc.responseWriter == nil {
 		// worker mode, not handling a request
 
-		if c := logger.Check(zapcore.DebugLevel, "apache_request_headers() called in non-HTTP context"); c != nil {
-			c.Write(zap.String("worker", fc.scriptFilename))
-		}
+		logger.LogAttrs(nil, slog.LevelDebug, "apache_request_headers() called in non-HTTP context", slog.String("worker", fc.scriptFilename))
 
 		return nil, 0
 	}
@@ -489,9 +478,7 @@ func go_apache_request_headers(threadIndex C.uintptr_t) (*C.go_string, C.size_t)
 func addHeader(fc *frankenPHPContext, cString *C.char, length C.int) {
 	parts := strings.SplitN(C.GoStringN(cString, length), ": ", 2)
 	if len(parts) != 2 {
-		if c := fc.logger.Check(zapcore.DebugLevel, "invalid header"); c != nil {
-			c.Write(zap.String("header", parts[0]))
-		}
+		fc.logger.LogAttrs(nil, slog.LevelDebug, "invalid header", slog.String("header", parts[0]))
 
 		return
 	}
@@ -545,9 +532,7 @@ func go_sapi_flush(threadIndex C.uintptr_t) bool {
 	}
 
 	if err := http.NewResponseController(fc.responseWriter).Flush(); err != nil {
-		if c := fc.logger.Check(zapcore.ErrorLevel, "the current responseWriter is not a flusher"); c != nil {
-			c.Write(zap.Error(err))
-		}
+		logger.LogAttrs(nil, slog.LevelError, "the current responseWriter is not a flusher", slog.Any("error", err))
 	}
 
 	return false
@@ -600,24 +585,15 @@ func go_log(message *C.char, level C.int) {
 
 	switch le {
 	case emerg, alert, crit, err:
-		if c := logger.Check(zapcore.ErrorLevel, m); c != nil {
-			c.Write(zap.Stringer("syslog_level", syslogLevel(level)))
-		}
+		logger.LogAttrs(nil, slog.LevelError, m, slog.String("syslog_level", syslogLevel(level).String()))
 
 	case warning:
-		if c := logger.Check(zapcore.WarnLevel, m); c != nil {
-			c.Write(zap.Stringer("syslog_level", syslogLevel(level)))
-		}
-
+		logger.LogAttrs(nil, slog.LevelWarn, m, slog.String("syslog_level", syslogLevel(level).String()))
 	case debug:
-		if c := logger.Check(zapcore.DebugLevel, m); c != nil {
-			c.Write(zap.Stringer("syslog_level", syslogLevel(level)))
-		}
+		logger.LogAttrs(nil, slog.LevelDebug, m, slog.String("syslog_level", syslogLevel(level).String()))
 
 	default:
-		if c := logger.Check(zapcore.InfoLevel, m); c != nil {
-			c.Write(zap.Stringer("syslog_level", syslogLevel(level)))
-		}
+		logger.LogAttrs(nil, slog.LevelInfo, m, slog.String("syslog_level", syslogLevel(level).String()))
 	}
 }
 

frankenphp_test.go

@@ -11,6 +11,7 @@ import (
 	"fmt"
 	"io"
 	"log"
+	"log/slog"
 	"mime/multipart"
 	"net/http"
 	"net/http/cookiejar"
@@ -30,7 +31,7 @@ import (
 	"github.com/dunglas/frankenphp/internal/fastabs"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"go.uber.org/zap"
+	"go.uber.org/zap/exp/zapslog"
 	"go.uber.org/zap/zapcore"
 	"go.uber.org/zap/zaptest"
 	"go.uber.org/zap/zaptest/observer"
@@ -43,7 +44,7 @@ type testOptions struct {
 	env                map[string]string
 	nbParallelRequests int
 	realServer         bool
-	logger             *zap.Logger
+	logger             *slog.Logger
 	initOpts           []frankenphp.Option
 	phpIni             map[string]string
 }
@@ -60,7 +61,7 @@ func runTest(t *testing.T, test func(func(http.ResponseWriter, *http.Request), *
 	testDataDir := cwd + "/testdata/"
 
 	if opts.logger == nil {
-		opts.logger = zaptest.NewLogger(t)
+		opts.logger = slog.New(zapslog.NewHandler(zaptest.NewLogger(t).Core()))
 	}
 
 	initOpts := []frankenphp.Option{frankenphp.WithLogger(opts.logger)}
@@ -445,7 +446,7 @@ func TestLog_worker(t *testing.T) {
 }
 func testLog(t *testing.T, opts *testOptions) {
 	logger, logs := observer.New(zapcore.InfoLevel)
-	opts.logger = zap.New(logger)
+	opts.logger = slog.New(zapslog.NewHandler(logger))
 
 	runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
 		req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/log.php?i=%d", i), nil)
@@ -465,7 +466,7 @@ func testConnectionAbort(t *testing.T, opts *testOptions) {
 	testFinish := func(finish string) {
 		t.Run(fmt.Sprintf("finish=%s", finish), func(t *testing.T) {
 			logger, logs := observer.New(zapcore.InfoLevel)
-			opts.logger = zap.New(logger)
+			opts.logger = slog.New(zapslog.NewHandler(logger))
 
 			runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
 				req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/connectionStatusLog.php?i=%d&finish=%s", i, finish), nil)
@@ -819,7 +820,7 @@ func ExampleExecuteScriptCLI() {
 }
 
 func BenchmarkHelloWorld(b *testing.B) {
-	if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
+	if err := frankenphp.Init(frankenphp.WithLogger(slog.New(slog.NewTextHandler(io.Discard, nil)))); err != nil {
 		panic(err)
 	}
 	defer frankenphp.Shutdown()
@@ -847,7 +848,7 @@ func BenchmarkHelloWorld(b *testing.B) {
 }
 
 func BenchmarkEcho(b *testing.B) {
-	if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
+	if err := frankenphp.Init(frankenphp.WithLogger(slog.New(slog.NewTextHandler(io.Discard, nil)))); err != nil {
 		panic(err)
 	}
 	defer frankenphp.Shutdown()
@@ -914,7 +915,7 @@ func BenchmarkEcho(b *testing.B) {
 }
 
 func BenchmarkServerSuperGlobal(b *testing.B) {
-	if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
+	if err := frankenphp.Init(frankenphp.WithLogger(slog.New(slog.NewTextHandler(io.Discard, nil)))); err != nil {
 		panic(err)
 	}
 	defer frankenphp.Shutdown()

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/prometheus/client_golang v1.22.0
 	github.com/stretchr/testify v1.10.0
 	go.uber.org/zap v1.27.0
+	go.uber.org/zap/exp v0.3.0
 	golang.org/x/net v0.39.0
 )
 

go.sum

@@ -40,6 +40,8 @@ go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
 go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
 go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
+go.uber.org/zap/exp v0.3.0 h1:6JYzdifzYkGmTdRR59oYH+Ng7k49H9qVpWwNSsGJj3U=
+go.uber.org/zap/exp v0.3.0/go.mod h1:5I384qq7XGxYyByIhHm6jg5CHkGY0nsTfbDLgDDlgJQ=
 golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY=
 golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E=
 golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=

internal/testserver/main.go

@@ -1,19 +1,15 @@
 package main
 
 import (
+	"log/slog"
 	"net/http"
 	"os"
 
 	"github.com/dunglas/frankenphp"
-	"go.uber.org/zap"
 )
 
 func main() {
-	logger, err := zap.NewDevelopment()
-	if err != nil {
-		panic(err)
-	}
-
+	logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
 	if err := frankenphp.Init(frankenphp.WithLogger(logger)); err != nil {
 		panic(err)
 	}
@@ -35,5 +31,6 @@ func main() {
 		port = "8080"
 	}
 
-	logger.Fatal("server error", zap.Error(http.ListenAndServe(":"+port, nil)))
+	logger.LogAttrs(nil, slog.LevelError, "server error", slog.Any("error", http.ListenAndServe(":"+port, nil)))
+	os.Exit(1)
 }