Adopt slog.Logger

This removes the custom logger interface and adopts the new go 1.21 structured logger

Author: cschleiden

activity/logger.go

@@ -2,12 +2,12 @@ package activity
 
 import (
 	"context"
+	"log/slog"
 
 	"github.com/cschleiden/go-workflows/internal/activity"
-	"github.com/cschleiden/go-workflows/log"
 )
 
 // Logger returns a logger with the workflow instance this activity is executed for set as default fields
-func Logger(ctx context.Context) log.Logger {
+func Logger(ctx context.Context) *slog.Logger {
 	return activity.GetActivityState(ctx).Logger
 }

activitytester/activitytester.go

@@ -2,16 +2,15 @@ package activitytester
 
 import (
 	"context"
+	"log/slog"
 
 	"github.com/cschleiden/go-workflows/internal/activity"
 	"github.com/cschleiden/go-workflows/internal/core"
-	dlogger "github.com/cschleiden/go-workflows/internal/logger"
-	"github.com/cschleiden/go-workflows/log"
 )
 
-func WithActivityTestState(ctx context.Context, activityID, instanceID string, logger log.Logger) context.Context {
+func WithActivityTestState(ctx context.Context, activityID, instanceID string, logger *slog.Logger) context.Context {
 	if logger == nil {
-		logger = dlogger.NewDefaultLogger()
+		logger = slog.Default()
 	}
 
 	return activity.WithActivityState(ctx, activity.NewActivityState(activityID, core.NewWorkflowInstance(instanceID, ""), logger))

backend/backend.go

@@ -3,13 +3,13 @@ package backend
 import (
 	"context"
 	"errors"
+	"log/slog"
 
 	"github.com/cschleiden/go-workflows/internal/contextpropagation"
 	"github.com/cschleiden/go-workflows/internal/converter"
 	core "github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/task"
-	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/cschleiden/go-workflows/workflow"
 	"go.opentelemetry.io/otel/trace"
@@ -72,7 +72,7 @@ type Backend interface {
 	GetStats(ctx context.Context) (*Stats, error)
 
 	// Logger returns the configured logger for the backend
-	Logger() log.Logger
+	Logger() *slog.Logger
 
 	// Tracer returns the configured trace provider for the backend
 	Tracer() trace.Tracer

backend/mock_Backend.go

@@ -7,6 +7,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log/slog"
 	"strings"
 	"time"
 
@@ -17,7 +18,6 @@ import (
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/metrickeys"
 	"github.com/cschleiden/go-workflows/internal/task"
-	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/cschleiden/go-workflows/workflow"
 	_ "github.com/go-sql-driver/mysql"
@@ -63,7 +63,7 @@ type mysqlBackend struct {
 	options    backend.Options
 }
 
-func (b *mysqlBackend) Logger() log.Logger {
+func (b *mysqlBackend) Logger() *slog.Logger {
 	return b.options.Logger
 }
 

backend/mysql/mysql.go

@@ -1,21 +1,20 @@
 package backend
 
 import (
+	"log/slog"
 	"time"
 
 	"github.com/cschleiden/go-workflows/internal/contextpropagation"
 	"github.com/cschleiden/go-workflows/internal/converter"
-	"github.com/cschleiden/go-workflows/internal/logger"
 	mi "github.com/cschleiden/go-workflows/internal/metrics"
 	"github.com/cschleiden/go-workflows/internal/tracing"
-	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/cschleiden/go-workflows/workflow"
 	"go.opentelemetry.io/otel/trace"
 )
 
 type Options struct {
-	Logger log.Logger
+	Logger *slog.Logger
 
 	Metrics metrics.Client
 
@@ -46,7 +45,7 @@ var DefaultOptions Options = Options{
 	WorkflowLockTimeout: time.Minute,
 	ActivityLockTimeout: time.Minute * 2,
 
-	Logger:         logger.NewDefaultLogger(),
+	Logger:         slog.Default(),
 	Metrics:        mi.NewNoopMetricsClient(),
 	TracerProvider: trace.NewNoopTracerProvider(),
 	Converter:      converter.DefaultConverter,
@@ -62,7 +61,7 @@ func WithStickyTimeout(timeout time.Duration) BackendOption {
 	}
 }
 
-func WithLogger(logger log.Logger) BackendOption {
+func WithLogger(logger *slog.Logger) BackendOption {
 	return func(o *Options) {
 		o.Logger = logger
 	}
@@ -100,7 +99,7 @@ func ApplyOptions(opts ...BackendOption) Options {
 	}
 
 	if options.Logger == nil {
-		options.Logger = logger.NewDefaultLogger()
+		options.Logger = slog.Default()
 	}
 
 	return options

backend/options.go

@@ -3,6 +3,7 @@ package redis
 import (
 	"context"
 	"fmt"
+	"log/slog"
 	"time"
 
 	"github.com/cschleiden/go-workflows/backend"
@@ -11,7 +12,6 @@ import (
 	"github.com/cschleiden/go-workflows/internal/core"
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/metrickeys"
-	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/redis/go-redis/v9"
 	"go.opentelemetry.io/otel/trace"
@@ -86,7 +86,7 @@ type activityData struct {
 	Event    *history.Event         `json:"event,omitempty"`
 }
 
-func (rb *redisBackend) Logger() log.Logger {
+func (rb *redisBackend) Logger() *slog.Logger {
 	return rb.options.Logger
 }
 

backend/redis/redis.go

@@ -7,6 +7,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"log/slog"
 	"strings"
 	"time"
 
@@ -17,7 +18,6 @@ import (
 	"github.com/cschleiden/go-workflows/internal/history"
 	"github.com/cschleiden/go-workflows/internal/metrickeys"
 	"github.com/cschleiden/go-workflows/internal/task"
-	"github.com/cschleiden/go-workflows/log"
 	"github.com/cschleiden/go-workflows/metrics"
 	"github.com/cschleiden/go-workflows/workflow"
 	"github.com/google/uuid"
@@ -67,7 +67,7 @@ type sqliteBackend struct {
 
 var _ backend.Backend = (*sqliteBackend)(nil)
 
-func (sb *sqliteBackend) Logger() log.Logger {
+func (sb *sqliteBackend) Logger() *slog.Logger {
 	return sb.options.Logger
 }
 

backend/sqlite/sqlite.go

@@ -6,6 +6,7 @@ import (
 	"flag"
 	"fmt"
 	"log"
+	"log/slog"
 	"os"
 	"sync"
 	"time"
@@ -38,7 +39,7 @@ func main() {
 	defer cancel()
 
 	mm := newMemMetrics()
-	ba := getBackend(*b, backend.WithLogger(&nullLogger{}), backend.WithMetrics(mm))
+	ba := getBackend(*b, backend.WithLogger(slog.New(&nullHandler{})), backend.WithMetrics(mm))
 
 	wo := worker.DefaultWorkerOptions
 	wo.WorkflowExecutorCacheSize = *cacheSize

bench/main.go

@@ -1,30 +1,31 @@
 package main
 
-import "github.com/cschleiden/go-workflows/log"
+import (
+	"context"
+	"log/slog"
+)
 
-type nullLogger struct {
-	defaultFields []interface{}
+type nullHandler struct {
 }
 
-// Debug implements log.Logger
-func (*nullLogger) Debug(msg string, fields ...interface{}) {
+// Enabled implements slog.Handler.
+func (*nullHandler) Enabled(context.Context, slog.Level) bool {
+	return false
 }
 
-// Error implements log.Logger
-func (*nullLogger) Error(msg string, fields ...interface{}) {
+// Handle implements slog.Handler.
+func (*nullHandler) Handle(context.Context, slog.Record) error {
+	return nil
 }
 
-// Panic implements log.Logger
-func (*nullLogger) Panic(msg string, fields ...interface{}) {
-}
-
-// Warn implements log.Logger
-func (*nullLogger) Warn(msg string, fields ...interface{}) {
+// WithAttrs implements slog.Handler.
+func (nl *nullHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
+	return nl
 }
 
-// With implements log.Logger
-func (nl *nullLogger) With(fields ...interface{}) log.Logger {
+// WithGroup implements slog.Handler.
+func (nl *nullHandler) WithGroup(name string) slog.Handler {
 	return nl
 }
 
-var _ log.Logger = (*nullLogger)(nil)
+var _ slog.Handler = (*nullHandler)(nil)