replace github.com/siddontang/go-log with log/slog

Author: serprex

README.md

@@ -147,7 +147,6 @@ package main
 
 import (
 	"github.com/go-mysql-org/go-mysql/canal"
-	"github.com/siddontang/go-log/log"
 )
 
 type MyEventHandler struct {
@@ -537,26 +536,7 @@ We pass all tests in https://github.com/bradfitz/go-sql-test using go-mysql driv
 
 ## Logging
 
-Logging by default is send to stdout.
-
-To disable logging completely:
-```go
-import "github.com/siddontang/go-log/log"
-...
-        nullHandler, _ := log.NewNullHandler()
-        cfg.Logger = log.NewDefault(nullHandler)
-```
-
-To write logging to any [`io.Writer`](https://pkg.go.dev/io#Writer):
-```go
-import "github.com/siddontang/go-log/log"
-...
-        w := ...
-        streamHandler, _ := log.NewStreamHandler(w)
-        cfg.Logger = log.NewDefault(streamHandler)
-```
-
-Or you can implement your own [`log.Handler`](https://pkg.go.dev/github.com/siddontang/go-log/log#Handler).
+Logging uses log/slog.
 
 ## How to migrate to this repo
 To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`:

canal/canal.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"log/slog"
 	"net"
 	"os"
 	"regexp"
@@ -21,7 +22,6 @@ import (
 	"github.com/go-mysql-org/go-mysql/utils"
 	"github.com/pingcap/errors"
 	"github.com/pingcap/tidb/pkg/parser"
-	"github.com/siddontang/go-log/log"
 )
 
 // Canal can sync your MySQL data into everywhere, like Elasticsearch, Redis, etc...
@@ -64,8 +64,7 @@ var ErrExcludedTable = errors.New("excluded table meta")
 func NewCanal(cfg *Config) (*Canal, error) {
 	c := new(Canal)
 	if cfg.Logger == nil {
-		streamHandler, _ := log.NewStreamHandler(os.Stdout)
-		cfg.Logger = log.NewDefault(streamHandler)
+		cfg.Logger = slog.Default()
 	}
 	if cfg.Dialer == nil {
 		dialer := &net.Dialer{}

canal/canal_test.go

@@ -6,7 +6,6 @@ import (
 	"time"
 
 	"github.com/pingcap/tidb/pkg/parser"
-	"github.com/siddontang/go-log/log"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
@@ -99,7 +98,7 @@ func (s *canalTestSuite) SetupSuite() {
 
 	s.execute("SET GLOBAL binlog_format = 'ROW'")
 
-	s.c.SetEventHandler(&testEventHandler{})
+	s.c.SetEventHandler(&testEventHandler{T: s.T()})
 	go func() {
 		set, _ := mysql.ParseGTIDSet("mysql", "")
 		err = s.c.StartFromGTID(set)
@@ -126,10 +125,11 @@ func (s *canalTestSuite) execute(query string, args ...interface{}) *mysql.Resul
 
 type testEventHandler struct {
 	DummyEventHandler
+	T *testing.T
 }
 
 func (h *testEventHandler) OnRow(e *RowsEvent) error {
-	log.Infof("OnRow %s %v\n", e.Action, e.Rows)
+	h.T.Log("OnRow", e.Action, e.Rows)
 	umi, ok := e.Rows[0][4].(uint32) // 4th col is umi. mysqldump gives uint64 instead of uint32
 	if ok && (umi != umiA && umi != umiB && umi != umiC) {
 		return fmt.Errorf("invalid unsigned medium int %d", umi)

canal/config.go

@@ -2,15 +2,14 @@ package canal
 
 import (
 	"crypto/tls"
+	"log/slog"
 	"math/rand"
 	"net"
 	"os"
 	"time"
 
 	"github.com/BurntSushi/toml"
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
-	"github.com/siddontang/go-log/loggers"
 
 	"github.com/go-mysql-org/go-mysql/client"
 	"github.com/go-mysql-org/go-mysql/mysql"
@@ -101,7 +100,7 @@ type Config struct {
 	TLSConfig *tls.Config
 
 	// Set Logger
-	Logger loggers.Advanced
+	Logger *slog.Logger
 
 	// Set Dialer
 	Dialer client.Dialer
@@ -150,8 +149,7 @@ func NewDefaultConfig() *Config {
 	c.Dump.DiscardErr = true
 	c.Dump.SkipMasterData = false
 
-	streamHandler, _ := log.NewStreamHandler(os.Stdout)
-	c.Logger = log.NewDefault(streamHandler)
+	c.Logger = slog.Default()
 
 	dialer := &net.Dialer{}
 	c.Dialer = dialer.DialContext

canal/master.go

@@ -1,10 +1,10 @@
 package canal
 
 import (
+	"log/slog"
 	"sync"
 
 	"github.com/go-mysql-org/go-mysql/mysql"
-	"github.com/siddontang/go-log/loggers"
 )
 
 type masterInfo struct {
@@ -16,27 +16,27 @@ type masterInfo struct {
 
 	timestamp uint32
 
-	logger loggers.Advanced
+	logger *slog.Logger
 }
 
 func (m *masterInfo) Update(pos mysql.Position) {
-	m.logger.Debugf("update master position %s", pos)
+	m.logger.Debug("update master position", slog.Any("pos", pos))
 
 	m.Lock()
 	m.pos = pos
 	m.Unlock()
 }
 
 func (m *masterInfo) UpdateTimestamp(ts uint32) {
-	m.logger.Debugf("update master timestamp %d", ts)
+	m.logger.Debug("update master timestamp", slog.Int64("ts", int64(ts)))
 
 	m.Lock()
 	m.timestamp = ts
 	m.Unlock()
 }
 
 func (m *masterInfo) UpdateGTIDSet(gset mysql.GTIDSet) {
-	m.logger.Debugf("update master gtid set %s", gset)
+	m.logger.Debug("update master gtid set", slog.Any("gset", gset))
 
 	m.Lock()
 	m.gset = gset

client/pool_test.go

@@ -9,7 +9,6 @@ import (
 	"time"
 
 	"github.com/go-mysql-org/go-mysql/test_util"
-	"github.com/siddontang/go-log/log"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 )
@@ -30,7 +29,6 @@ func (s *poolTestSuite) TestPool_Close() {
 	addr := fmt.Sprintf("%s:%s", *test_util.MysqlHost, s.port)
 	pool, err := NewPoolWithOptions(addr, *testUser, *testPassword, "",
 		WithPoolLimits(5, 10, 5),
-		WithLogFunc(log.Debugf),
 	)
 	require.NoError(s.T(), err)
 
@@ -53,7 +51,6 @@ func (s *poolTestSuite) TestPool_WrongPassword() {
 
 	_, err := NewPoolWithOptions(addr, *testUser, "wrong-password", "",
 		WithPoolLimits(5, 10, 5),
-		WithLogFunc(log.Debugf),
 		WithNewPoolPingTimeout(time.Second),
 	)
 
@@ -71,7 +68,6 @@ func (s *poolTestSuite) TestPool_WrongAddr() {
 
 	_, err = NewPoolWithOptions(laddr.String(), *testUser, *testPassword, "",
 		WithPoolLimits(5, 10, 5),
-		WithLogFunc(log.Debugf),
 		WithNewPoolPingTimeout(time.Second),
 	)
 

driver/driver_options_test.go

@@ -16,7 +16,6 @@ import (
 	"time"
 
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
 	"github.com/stretchr/testify/require"
 
 	"github.com/go-mysql-org/go-mysql/client"
@@ -40,7 +39,6 @@ type mockHandler struct {
 }
 
 func TestDriverOptions_SetRetriesOn(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 	var wg sync.WaitGroup
@@ -66,7 +64,6 @@ func TestDriverOptions_SetRetriesOn(t *testing.T) {
 }
 
 func TestDriverOptions_SetRetriesOff(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 	var wg sync.WaitGroup
@@ -117,7 +114,6 @@ func TestDriverOptions_SetCompression(t *testing.T) {
 }
 
 func TestDriverOptions_ConnectTimeout(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 
@@ -135,7 +131,6 @@ func TestDriverOptions_ConnectTimeout(t *testing.T) {
 }
 
 func TestDriverOptions_BufferSize(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 
@@ -161,7 +156,6 @@ func TestDriverOptions_BufferSize(t *testing.T) {
 }
 
 func TestDriverOptions_ReadTimeout(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 
@@ -183,7 +177,6 @@ func TestDriverOptions_ReadTimeout(t *testing.T) {
 }
 
 func TestDriverOptions_writeTimeout(t *testing.T) {
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 
@@ -231,7 +224,6 @@ func TestDriverOptions_namedValueChecker(t *testing.T) {
 		return nil
 	})
 
-	log.SetLevel(log.LevelDebug)
 	srv := CreateMockServer(t)
 	defer srv.Stop()
 	conn, err := sql.Open("mysql", "root@127.0.0.1:3307/test?writeTimeout=1s")

dump/dumper.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"fmt"
 	"io"
+	"log/slog"
 	"net"
 	"os"
 	"os/exec"
@@ -12,8 +13,6 @@ import (
 
 	"github.com/go-mysql-org/go-mysql/mysql"
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
-	"github.com/siddontang/go-log/loggers"
 )
 
 // Unlick mysqldump, Dumper is designed for parsing and syning data easily.
@@ -51,7 +50,7 @@ type Dumper struct {
 	mysqldumpVersion    string
 	sourceDataSupported bool
 
-	Logger loggers.Advanced
+	Logger *slog.Logger
 }
 
 func NewDumper(executionPath string, addr string, user string, password string) (*Dumper, error) {
@@ -96,8 +95,7 @@ func NewDumper(executionPath string, addr string, user string, password string)
 
 	d.ErrOut = os.Stderr
 
-	streamHandler, _ := log.NewStreamHandler(os.Stdout)
-	d.Logger = log.NewDefault(streamHandler)
+	d.Logger = slog.Default()
 
 	return d, nil
 }
@@ -312,7 +310,7 @@ func (d *Dumper) Dump(w io.Writer) error {
 	}
 
 	args[passwordArgIndex] = "--password=******"
-	d.Logger.Infof("exec mysqldump with %v", args)
+	d.Logger.Info("exec mysqldump with", slog.Any("args", args))
 	args[passwordArgIndex] = passwordArg
 	cmd := exec.Command(d.ExecutionPath, args...)
 

go.mod

@@ -15,7 +15,6 @@ require (
 	github.com/pingcap/errors v0.11.5-0.20240311024730-e056997136bb
 	github.com/pingcap/tidb/pkg/parser v0.0.0-20241118164214-4f047be191be
 	github.com/shopspring/decimal v1.2.0
-	github.com/siddontang/go-log v0.0.0-20180807004314-8d05993dda07
 	github.com/stretchr/testify v1.8.4
 )
 

go.sum

@@ -48,8 +48,6 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ=
 github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
-github.com/siddontang/go-log v0.0.0-20180807004314-8d05993dda07 h1:oI+RNwuC9jF2g2lP0u0cVEEZrc/AYBCuFdvwrLWM/6Q=
-github.com/siddontang/go-log v0.0.0-20180807004314-8d05993dda07/go.mod h1:yFdBgwXP24JziuRl2NMUahT7nGLNOKi1SIiFxMttVD4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=

mysql/mariadb_gtid.go

@@ -3,12 +3,12 @@ package mysql
 import (
 	"bytes"
 	"fmt"
+	"log/slog"
 	"sort"
 	"strconv"
 	"strings"
 
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
 )
 
 // MariadbGTID represent mariadb gtid, [domain ID]-[server-id]-[sequence]
@@ -93,7 +93,7 @@ func (gtid *MariadbGTID) forward(newer *MariadbGTID) error {
 		| mysqld-bin.000001 | 2215 | Gtid              |       111 |        2257 | BEGIN GTID 0-111-6  |
 	*/
 	if newer.SequenceNumber <= gtid.SequenceNumber {
-		log.Warnf("out of order binlog appears with gtid %s vs current position gtid %s", newer, gtid)
+		slog.Warn("out of order binlog", slog.Any("new", newer), slog.Any("current", gtid))
 	}
 
 	gtid.ServerID = newer.ServerID

mysql/queryattributes.go

@@ -2,8 +2,8 @@ package mysql
 
 import (
 	"encoding/binary"
-
-	"github.com/siddontang/go-log/log"
+	"fmt"
+	"log/slog"
 )
 
 // Query Attributes in MySQL are key/value pairs passed along with COM_QUERY or COM_STMT_EXECUTE
@@ -27,7 +27,7 @@ func (qa *QueryAttribute) TypeAndFlag() []byte {
 	case uint64:
 		return []byte{MYSQL_TYPE_LONGLONG, PARAM_UNSIGNED}
 	default:
-		log.Warnf("query attribute with unsupported type %T", v)
+		slog.Warn("query attribute with unsupported type", slog.String("type", fmt.Sprintf("%T", v)))
 	}
 	return []byte{0x0, 0x0} // type 0x0, flag 0x0, to not break the protocol
 }
@@ -42,7 +42,7 @@ func (qa *QueryAttribute) ValueBytes() []byte {
 		binary.LittleEndian.PutUint64(b, v)
 		return b
 	default:
-		log.Warnf("query attribute with unsupported type %T", v)
+		slog.Warn("query attribute with unsupported type", slog.String("type", fmt.Sprintf("%T", v)))
 	}
 	return []byte{0x0} // 0 length value to not break the protocol
 }

replication/binlogstreamer.go

@@ -5,7 +5,6 @@ import (
 	"time"
 
 	"github.com/pingcap/errors"
-	"github.com/siddontang/go-log/log"
 )
 
 var (
@@ -74,8 +73,6 @@ func (s *BinlogStreamer) close() {
 func (s *BinlogStreamer) closeWithError(err error) {
 	if err == nil {
 		err = ErrSyncClosed
-	} else {
-		log.Errorf("close sync with err: %v", err)
 	}
 
 	select {