migrate gokit/logex to log/slog

Author: joonas-fi

cmd/edgerouter/discovery.go

@@ -13,6 +13,7 @@ import (
 	"github.com/function61/edgerouter/pkg/erconfig"
 	"github.com/function61/edgerouter/pkg/erdiscovery"
 	"github.com/function61/edgerouter/pkg/erdiscovery/defaultdiscovery"
+	"github.com/function61/edgerouter/pkg/todoupgradegokit/slogshim"
 	"github.com/function61/gokit/jsonfile"
 	"github.com/function61/gokit/osutil"
 	"github.com/scylladb/termtables"
@@ -195,5 +196,5 @@ func discoveryEntry() *cobra.Command {
 }
 
 func newDefaultDiscoveryWithoutLogger() (erdiscovery.ReaderWriter, error) {
-	return defaultdiscovery.New(nil)
+	return defaultdiscovery.New(slogshim.NewWithOutput(io.Discard))
 }

cmd/edgerouter/main.go

@@ -2,16 +2,17 @@
 package main
 
 import (
+	"log/slog"
 	"os"
 
 	"github.com/function61/edgerouter/pkg/erbackend/turbochargerbackend/turbochargererdeploy"
 	"github.com/function61/edgerouter/pkg/erlambdacli"
 	"github.com/function61/edgerouter/pkg/ers3cli"
 	"github.com/function61/edgerouter/pkg/erserver"
+	"github.com/function61/edgerouter/pkg/todoupgradegokit/slogshim"
 	"github.com/function61/edgerouter/pkg/turbocharger/turbochargerdeploy"
 	"github.com/function61/eventhorizon/pkg/ehcli"
 	"github.com/function61/gokit/dynversion"
-	"github.com/function61/gokit/logex"
 	"github.com/function61/gokit/osutil"
 	"github.com/spf13/cobra"
 )
@@ -42,12 +43,12 @@ func serveEntry() *cobra.Command {
 		Short: "Runs the HTTP server",
 		Args:  cobra.NoArgs,
 		Run: func(cmd *cobra.Command, args []string) {
-			rootLogger := logex.StandardLogger()
+			logger := slogshim.New()
 
 			osutil.ExitIfError(erserver.Serve(
-				osutil.CancelOnInterruptOrTerminate(rootLogger),
+				osutil.CancelOnInterruptOrTerminate(slogshim.ToStd(logger, slog.LevelInfo)),
 				erserver.DefaultConfigDir,
-				rootLogger))
+				logger))
 		},
 	}
 }

pkg/erbackend/lambdabackend/lambdabackend.go

@@ -8,7 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
-	"log"
+	"log/slog"
 	"net"
 	"net/http"
 	"net/url"
@@ -28,7 +28,7 @@ type lambdaBackend struct {
 	isPayloadV2  bool // https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
 }
 
-func New(ctx context.Context, opts erconfig.BackendOptsAwsLambda, logger *log.Logger) (http.Handler, error) {
+func New(ctx context.Context, opts erconfig.BackendOptsAwsLambda, logger *slog.Logger) (http.Handler, error) {
 	awsConfig, err := config.LoadDefaultConfig(ctx, config.WithRegion(opts.RegionID))
 	if err != nil {
 		return nil, err

pkg/erbackend/reverseproxybackend/reverseproxy.go

@@ -7,7 +7,7 @@ import (
 	"crypto/tls"
 	"errors"
 	"fmt"
-	"log"
+	"log/slog"
 	"math/rand"
 	"net/http"
 	"net/http/httputil"
@@ -30,7 +30,7 @@ import (
 //   3) press F5 from browser. this'll inject 304 Not Modified into cache (browser expects 304 but CACHE NOT)
 //   4) now use cURL to request the same resource (= without caching), and you'll get 304 🤦
 
-func New(ctx context.Context, appID string, opts erconfig.BackendOptsReverseProxy, logger *log.Logger) (http.Handler, error) {
+func New(ctx context.Context, appID string, opts erconfig.BackendOptsReverseProxy, logger *slog.Logger) (http.Handler, error) {
 	handler, err := NewWithModifyResponse(appID, opts, nil)
 	if err != nil {
 		return nil, err

pkg/erbackend/turbochargerbackend/backend.go

@@ -4,31 +4,34 @@ package turbochargerbackend
 
 import (
 	"context"
-	"log"
+	"log/slog"
 	"net/http"
 	"strings"
 
 	"github.com/function61/edgerouter/pkg/turbocharger"
-	"github.com/function61/gokit/logex"
 )
 
 // doesn't do much more than binds a static manifest ID to the backend. in case the manifest changes
 // (a different version of a website gets deployed), that's an Edgerouter-level concern and it will make a new backend instance.
-func New(ctx context.Context, manifestID turbocharger.ObjectID, logger *log.Logger) (http.Handler, error) {
-	manifestHandler, err := turbocharger.GetManifestHandlerSingleton(ctx)
+func New(ctx context.Context, manifestID turbocharger.ObjectID, logger *slog.Logger) (http.Handler, error) {
+	manifestHandler, err := turbocharger.GetManifestHandlerSingleton(ctx, logger)
 	if err != nil {
 		return nil, err
 	}
 
-	logl := logex.Levels(logger)
+	backendLogger := logger.With("subsystem", "turbocharger-backend")
 
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if strings.HasSuffix(r.URL.Path, "/") { // "/foo/" => "/foo/index.html"
 			r.URL.Path += "index.html"
 		}
 
 		if err := manifestHandler.ServeHTTPFromManifest(manifestID, w, r); err != nil {
-			logl.Error.Println(err.Error())
+			backendLogger.Error("serve from manifest",
+				"error", err,
+				"manifest_id", manifestID.String(),
+				"path", r.URL.Path,
+			)
 		}
 	}), nil
 }

pkg/erbackend/turbochargerbackend/turbochargererdeploy/cli.go

@@ -4,11 +4,12 @@ package turbochargererdeploy
 import (
 	"context"
 	"fmt"
+	"log/slog"
 
 	"github.com/function61/edgerouter/pkg/erconfig"
 	"github.com/function61/edgerouter/pkg/erdiscovery/defaultdiscovery"
+	"github.com/function61/edgerouter/pkg/todoupgradegokit/slogshim"
 	"github.com/function61/edgerouter/pkg/turbocharger"
-	"github.com/function61/gokit/logex"
 	"github.com/function61/gokit/osutil"
 	"github.com/spf13/cobra"
 )
@@ -19,29 +20,27 @@ func CLIEntrypoint() *cobra.Command {
 		Short: "Deploys a static website from Turbocharger",
 		Args:  cobra.ExactArgs(2),
 		Run: func(cmd *cobra.Command, args []string) {
+			logger := slogshim.New()
 			osutil.ExitIfError(func() error {
 				manifestID, err := turbocharger.ObjectIDFromString(args[1])
 				if err != nil {
 					return err
 				}
 
 				return deploy(
-					osutil.CancelOnInterruptOrTerminate(logex.StandardLogger()),
+					osutil.CancelOnInterruptOrTerminate(slogshim.ToStd(logger, slog.LevelInfo)),
 					args[0],
-					*manifestID)
+					*manifestID,
+					logger)
 			}())
 		},
 	}
 }
 
 // atomically deploys a new version of a site by changing site's Turbocharger Manifest ID
 // (which is essentially a pointer to an immutable file list) in the app configuration.
-func deploy(
-	ctx context.Context,
-	applicationID string,
-	manifestID turbocharger.ObjectID,
-) error {
-	discoverySvc, err := defaultdiscovery.New(nil)
+func deploy(ctx context.Context, applicationID string, manifestID turbocharger.ObjectID, logger *slog.Logger) error {
+	discoverySvc, err := defaultdiscovery.New(logger)
 	if err != nil {
 		return err
 	}

pkg/erdiscovery/defaultdiscovery/default.go

@@ -3,20 +3,19 @@
 package defaultdiscovery
 
 import (
-	"log"
+	"log/slog"
 
 	"github.com/function61/edgerouter/pkg/erdiscovery"
 	"github.com/function61/edgerouter/pkg/erdiscovery/ehdiscovery"
 	"github.com/function61/eventhorizon/pkg/ehreader"
-	"github.com/function61/gokit/logex"
 )
 
 // currently uses ehdiscovery as default
-func New(logger *log.Logger) (erdiscovery.ReaderWriter, error) {
+func New(logger *slog.Logger) (erdiscovery.ReaderWriter, error) {
 	tenantCtx, err := ehreader.TenantCtxFrom(ehreader.ConfigFromEnv)
 	if err != nil {
 		return nil, err
 	}
 
-	return ehdiscovery.New(*tenantCtx, logex.Prefix("ehdiscovery", logger))
+	return ehdiscovery.New(*tenantCtx, logger)
 }

pkg/erdiscovery/dockerdiscovery/docker.go

@@ -4,7 +4,6 @@ package dockerdiscovery
 import (
 	"context"
 	"fmt"
-	"log"
 	"log/slog"
 	"net"
 	"net/http"
@@ -35,7 +34,7 @@ func HasConfigInEnv() bool {
 	return os.Getenv("DOCKER_URL") != ""
 }
 
-func New() (erdiscovery.Reader, error) {
+func New(logger *slog.Logger) (erdiscovery.Reader, error) {
 	dockerURL, err := envvar.Required("DOCKER_URL")
 	if err != nil {
 		return nil, err
@@ -67,13 +66,15 @@ func New() (erdiscovery.Reader, error) {
 		dockerNetworkName: dockerNetworkName,
 		dockerURL:         dockerURL,
 		dockerClient:      dockerClient,
+		logger:            logger,
 	}, nil
 }
 
 type dockerDiscovery struct {
 	dockerNetworkName string
 	dockerURL         string
 	dockerClient      *http.Client
+	logger            *slog.Logger
 }
 
 func (s *dockerDiscovery) ReadApplications(ctx context.Context) ([]erconfig.Application, error) {
@@ -82,7 +83,7 @@ func (s *dockerDiscovery) ReadApplications(ctx context.Context) ([]erconfig.Appl
 		return nil, err
 	}
 
-	bareContainers, err := discoverDockerContainers(ctx, s.dockerURL, s.dockerNetworkName, s.dockerClient, swarmServices)
+	bareContainers, err := discoverDockerContainers(ctx, s.dockerURL, s.dockerNetworkName, s.dockerClient, swarmServices, s.logger)
 	if err != nil {
 		return nil, err
 	}
@@ -96,7 +97,9 @@ func (s *dockerDiscovery) ReadApplications(ctx context.Context) ([]erconfig.Appl
 	for _, service := range swarmServicesAndBareContainers {
 		app, err := traefikAnnotationsToApp(service)
 		if err != nil {
-			log.Println(fmt.Errorf("%s: traefikAnnotationsToApp: %w", service.Name, err).Error())
+			s.logger.Error("traefikAnnotationsToApp",
+				"service", service.Name,
+				"error", err)
 			continue
 		}
 		if app == nil { // non-error skip
@@ -209,6 +212,7 @@ func discoverDockerContainers(
 	dockerNetworkName string,
 	dockerClient *http.Client,
 	alreadyDiscoveredFromSwarm []Service,
+	logger *slog.Logger,
 ) ([]Service, error) {
 	services := []Service{}
 
@@ -276,7 +280,7 @@ func discoverDockerContainers(
 		if settings, found := container.NetworkSettings.Networks["host"]; !ipFound() && found {
 			// when host network, settings doesn't specify IP address
 			if settings.IPAddress != "" {
-				slog.Warn("IPAddress not expected for host", "container", container.Id)
+				logger.Warn("IPAddress not expected for host", "container", container.Id)
 				continue
 			}
 			ipAddress = "127.0.0.1"

pkg/erdiscovery/ehdiscovery/ehdiscovery.go

@@ -3,7 +3,7 @@ package ehdiscovery
 
 import (
 	"context"
-	"log"
+	"log/slog"
 	"os"
 	"sort"
 	"sync"
@@ -12,10 +12,10 @@ import (
 	"github.com/function61/edgerouter/pkg/erconfig"
 	"github.com/function61/edgerouter/pkg/erdiscovery"
 	"github.com/function61/edgerouter/pkg/erdomain"
+	"github.com/function61/edgerouter/pkg/todoupgradegokit/slogshim"
 	"github.com/function61/eventhorizon/pkg/ehclient"
 	"github.com/function61/eventhorizon/pkg/ehevent"
 	"github.com/function61/eventhorizon/pkg/ehreader"
-	"github.com/function61/gokit/logex"
 )
 
 const (
@@ -30,20 +30,20 @@ type ehDiscovery struct {
 	tenantCtx ehreader.TenantCtx
 	reader    *ehreader.Reader
 	cursor    ehclient.Cursor
-	logl      *logex.Leveled
+	logger    *slog.Logger
 	apps      map[string]erconfig.Application
 	appsMu    sync.Mutex
 }
 
-func New(tenantCtx ehreader.TenantCtx, logger *log.Logger) (erdiscovery.ReaderWriter, error) {
+func New(tenantCtx ehreader.TenantCtx, logger *slog.Logger) (erdiscovery.ReaderWriter, error) {
 	d := &ehDiscovery{
 		tenantCtx: tenantCtx,
 		cursor:    ehclient.Beginning(tenantCtx.Stream(stream)),
-		logl:      logex.Levels(logger),
+		logger:    logger.With("subsystem", "ehdiscovery"),
 		apps:      map[string]erconfig.Application{},
 	}
 
-	d.reader = ehreader.New(d, tenantCtx.Client, logger)
+	d.reader = ehreader.New(d, tenantCtx.Client, slogshim.ToStd(logger.With("subsystem", "ehdiscovery/ehreader"), slog.LevelInfo))
 
 	return d, nil
 }
@@ -105,7 +105,7 @@ func (d *ehDiscovery) ProcessEvents(ctx context.Context, handle ehreader.EventPr
 }
 
 func (d *ehDiscovery) processEvent(ev ehevent.Event) error {
-	d.logl.Info.Println(ev.MetaType())
+	d.logger.Info(ev.MetaType())
 
 	switch e := ev.(type) {
 	case *erdomain.AppUpdated:

pkg/erdiscovery/ehdiscovery/ehdiscovery_test.go

@@ -2,11 +2,13 @@ package ehdiscovery
 
 import (
 	"context"
+	"io"
 	"testing"
 	"time"
 
 	"github.com/function61/edgerouter/pkg/erconfig"
 	"github.com/function61/edgerouter/pkg/erdomain"
+	"github.com/function61/edgerouter/pkg/todoupgradegokit/slogshim"
 	"github.com/function61/eventhorizon/pkg/ehevent"
 	"github.com/function61/eventhorizon/pkg/ehreader"
 	"github.com/function61/eventhorizon/pkg/ehreader/ehreadertest"
@@ -23,7 +25,7 @@ func TestDiscovery(t *testing.T) {
 
 	tenantCtx := ehreader.NewTenantCtx(ehreader.TenantId("42"), eventLog)
 
-	discovery, err := New(*tenantCtx, nil)
+	discovery, err := New(*tenantCtx, slogshim.NewWithOutput(io.Discard))
 	assert.Ok(t, err)
 
 	apps, err := discovery.ReadApplications(ctx)