remove legacy logger

Author: joao-r-reis

address_translators_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file

cluster.go

@@ -259,33 +259,17 @@ type ClusterConfig struct {
 	// If not provided, Dialer will be used instead.
 	HostDialer HostDialer
 
-	// Deprecated: use StructuredLogger instead, Logger and LegacyLogLevel will be removed in the future.
-	//
-	// Logger for this ClusterConfig.
-	// If not specified, defaults to the gocql.defaultLogger.
-	Logger StdLogger
-
 	// StructuredLogger for this ClusterConfig.
-	// If not specified, Logger will be used instead (note that Logger is deprecated).
 	//
-	// There are 3 built in implementations of StructuredLogger:
+	// You can change the log level of the default logger by creating a new logger using gocql.NewLogger and providing it here.
+	//
+	//There are 3 built in implementations of StructuredLogger:
 	//  - std library "log" package: gocql.NewLogger
 	//  - zerolog: gocqlzerolog.NewZerologLogger
 	//  - zap: gocqlzap.NewZapLogger
 	//
-	// The logger created by gocql.NewLogger behaves in a similar way as the legacy default logger, but you can set a log level.
-	//
 	// You can also provide your own logger implementation of the StructuredLogger interface.
-	StructuredLogger StructuredLogger
-
-	// Deprecated: use StructuredLogger instead, Logger and LegacyLogLevel will be removed in the future.
-	//
-	// LegacyLogLevel for this ClusterConfig, this is only applied for legacy loggers (field Logger).
-	// This log level is not applied to StructuredLogger because the log level is already a part of the interface
-	// so the implementation can decide when not to log something.
-	//
-	// If not specified, LogLevelNone will be used as the default.
-	LegacyLogLevel LogLevel
+	Logger StructuredLogger
 
 	// Tracer will be used for all queries. Alternatively it can be set of on a
 	// per query basis.
@@ -333,20 +317,16 @@ func NewCluster(hosts ...string) *ClusterConfig {
 		ConvictionPolicy:       &SimpleConvictionPolicy{},
 		ReconnectionPolicy:     &ConstantReconnectionPolicy{MaxRetries: 3, Interval: 1 * time.Second},
 		WriteCoalesceWaitTime:  200 * time.Microsecond,
-		LegacyLogLevel:         LogLevelNone,
 		NextPagePrefetch:       0.25,
 	}
 	return cfg
 }
 
-func (cfg *ClusterConfig) newLogger() loggerAdapter {
-	if cfg.StructuredLogger != nil {
-		return newInternalLoggerFromAdvancedLogger(cfg.StructuredLogger)
-	}
-	if cfg.Logger == nil {
-		return newInternalLoggerFromStdLogger(&defaultLogger{}, cfg.LegacyLogLevel)
+func (cfg *ClusterConfig) newLogger() StructuredLogger {
+	if cfg.Logger != nil {
+		return cfg.Logger
 	}
-	return newInternalLoggerFromStdLogger(cfg.Logger, cfg.LegacyLogLevel)
+	return NewLogger(LogLevelNone)
 }
 
 // CreateSession initializes the cluster based on this config and returns a
@@ -359,7 +339,7 @@ func (cfg *ClusterConfig) CreateSession() (*Session, error) {
 // if defined, to translate the given address and port into a possibly new address
 // and port, If no AddressTranslator or if an error occurs, the given address and
 // port will be returned.
-func (cfg *ClusterConfig) translateAddressPort(addr net.IP, port int, logger internalLogger) (net.IP, int) {
+func (cfg *ClusterConfig) translateAddressPort(addr net.IP, port int, logger StructuredLogger) (net.IP, int) {
 	if cfg.AddressTranslator == nil || len(addr) == 0 {
 		return addr, port
 	}

cluster_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -60,23 +63,23 @@ func TestNewCluster_WithHosts(t *testing.T) {
 func TestClusterConfig_translateAddressAndPort_NilTranslator(t *testing.T) {
 	cfg := NewCluster()
 	assertNil(t, "cluster config address translator", cfg.AddressTranslator)
-	newAddr, newPort := cfg.translateAddressPort(net.ParseIP("10.0.0.1"), 1234, nilInternalLogger)
+	newAddr, newPort := cfg.translateAddressPort(net.ParseIP("10.0.0.1"), 1234, nopLoggerSingleton)
 	assertTrue(t, "same address as provided", net.ParseIP("10.0.0.1").Equal(newAddr))
 	assertEqual(t, "translated host and port", 1234, newPort)
 }
 
 func TestClusterConfig_translateAddressAndPort_EmptyAddr(t *testing.T) {
 	cfg := NewCluster()
 	cfg.AddressTranslator = staticAddressTranslator(net.ParseIP("10.10.10.10"), 5432)
-	newAddr, newPort := cfg.translateAddressPort(net.IP([]byte{}), 0, nilInternalLogger)
+	newAddr, newPort := cfg.translateAddressPort(net.IP([]byte{}), 0, nopLoggerSingleton)
 	assertTrue(t, "translated address is still empty", len(newAddr) == 0)
 	assertEqual(t, "translated port", 0, newPort)
 }
 
 func TestClusterConfig_translateAddressAndPort_Success(t *testing.T) {
 	cfg := NewCluster()
 	cfg.AddressTranslator = staticAddressTranslator(net.ParseIP("10.10.10.10"), 5432)
-	newAddr, newPort := cfg.translateAddressPort(net.ParseIP("10.0.0.1"), 2345, nilInternalLogger)
+	newAddr, newPort := cfg.translateAddressPort(net.ParseIP("10.0.0.1"), 2345, nopLoggerSingleton)
 	assertTrue(t, "translated address", net.ParseIP("10.10.10.10").Equal(newAddr))
 	assertEqual(t, "translated port", 5432, newPort)
 }

common_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file

compressor_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file

conn.go

@@ -133,20 +133,18 @@ type SslOptions struct {
 }
 
 type ConnConfig struct {
-	ProtoVersion     int
-	CQLVersion       string
-	Timeout          time.Duration
-	WriteTimeout     time.Duration
-	ConnectTimeout   time.Duration
-	Dialer           Dialer
-	HostDialer       HostDialer
-	Compressor       Compressor
-	Authenticator    Authenticator
-	AuthProvider     func(h *HostInfo) (Authenticator, error)
-	Keepalive        time.Duration
-	Logger           StdLogger
-	StructuredLogger StructuredLogger
-	LegacyLogLevel   LogLevel
+	ProtoVersion   int
+	CQLVersion     string
+	Timeout        time.Duration
+	WriteTimeout   time.Duration
+	ConnectTimeout time.Duration
+	Dialer         Dialer
+	HostDialer     HostDialer
+	Compressor     Compressor
+	Authenticator  Authenticator
+	AuthProvider   func(h *HostInfo) (Authenticator, error)
+	Keepalive      time.Duration
+	Logger         StructuredLogger
 
 	tlsConfig       *tls.Config
 	disableCoalesce bool
@@ -203,7 +201,7 @@ type Conn struct {
 
 	timeouts int64
 
-	logger internalLogger
+	logger StructuredLogger
 }
 
 // connect establishes a connection to a Cassandra node using session's connection config.

conn_test.go

@@ -41,6 +41,7 @@ import (
 	"math/rand"
 	"net"
 	"os"
+	"strconv"
 	"strings"
 	"sync"
 	"sync/atomic"
@@ -184,7 +185,7 @@ func newTestSession(proto protoVersion, addresses ...string) (*Session, error) {
 }
 
 func TestDNSLookupConnected(t *testing.T) {
-	log := &testLogger{}
+	log := newTestLogger(LogLevelDebug)
 
 	// Override the defaul DNS resolver and restore at the end
 	failDNS = true
@@ -195,7 +196,6 @@ func TestDNSLookupConnected(t *testing.T) {
 
 	cluster := NewCluster("cassandra1.invalid", srv.Address, "cassandra2.invalid")
 	cluster.Logger = log
-	cluster.LegacyLogLevel = LogLevelDebug
 	cluster.ProtoVersion = int(defaultProto)
 	cluster.disableControlConn = true
 
@@ -212,15 +212,14 @@ func TestDNSLookupConnected(t *testing.T) {
 }
 
 func TestDNSLookupError(t *testing.T) {
-	log := &testLogger{}
+	log := newTestLogger(LogLevelDebug)
 
 	// Override the defaul DNS resolver and restore at the end
 	failDNS = true
 	defer func() { failDNS = false }()
 
 	cluster := NewCluster("cassandra1.invalid", "cassandra2.invalid")
 	cluster.Logger = log
-	cluster.LegacyLogLevel = LogLevelDebug
 	cluster.ProtoVersion = int(defaultProto)
 	cluster.disableControlConn = true
 
@@ -242,7 +241,7 @@ func TestDNSLookupError(t *testing.T) {
 
 func TestStartupTimeout(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
-	log := &testLogger{}
+	log := newTestLogger(LogLevelDebug)
 
 	srv := NewTestServer(t, defaultProto, ctx)
 	defer srv.Stop()
@@ -253,7 +252,6 @@ func TestStartupTimeout(t *testing.T) {
 	startTime := time.Now()
 	cluster := NewCluster(srv.Address)
 	cluster.Logger = log
-	cluster.LegacyLogLevel = LogLevelDebug
 	cluster.ProtoVersion = int(defaultProto)
 	cluster.disableControlConn = true
 	// Set very long query connection timeout
@@ -352,15 +350,21 @@ func TestCancel(t *testing.T) {
 type testQueryObserver struct {
 	metrics map[string]*hostMetrics
 	verbose bool
-	logger  StdLogger
+	logger  StructuredLogger
 }
 
 func (o *testQueryObserver) ObserveQuery(ctx context.Context, q ObservedQuery) {
 	host := q.Host.ConnectAddress().String()
 	o.metrics[host] = q.Metrics
 	if o.verbose {
-		o.logger.Printf("Observed query %q. Returned %v rows, took %v on host %q with %v attempts and total latency %v. Error: %q\n",
-			q.Statement, q.Rows, q.End.Sub(q.Start), host, q.Metrics.Attempts, q.Metrics.TotalLatency, q.Err)
+		o.logger.Debug("Observed query %q. Returned %v rows, took %v on host %q with %v attempts and total latency %v. Error: %q\n",
+			newLogFieldString("stmt", q.Statement),
+			newLogFieldInt("rows", q.Rows),
+			newLogFieldString("duration", q.End.Sub(q.Start).String()),
+			newLogFieldString("host", host),
+			newLogFieldInt("attempts", q.Metrics.Attempts),
+			newLogFieldString("latency", strconv.FormatInt(q.Metrics.TotalLatency, 10)),
+			newLogFieldError("err", q.Err))
 	}
 }
 
@@ -412,7 +416,7 @@ func TestQueryRetry(t *testing.T) {
 }
 
 func TestQueryMultinodeWithMetrics(t *testing.T) {
-	log := &testLogger{}
+	log := newTestLogger(LogLevelDebug)
 	defer func() {
 		os.Stdout.WriteString(log.String())
 	}()
@@ -487,7 +491,7 @@ func (t *testRetryPolicy) GetRetryType(err error) RetryType {
 }
 
 func TestSpeculativeExecution(t *testing.T) {
-	log := &testLogger{}
+	log := newTestLogger(LogLevelDebug)
 	defer func() {
 		os.Stdout.WriteString(log.String())
 	}()
@@ -720,7 +724,7 @@ func TestStream0(t *testing.T) {
 			r: bufio.NewReader(&buf),
 		},
 		streams: streams.New(protoVersion4),
-		logger:  newInternalLoggerFromStdLogger(&defaultLogger{}, LogLevelNone),
+		logger:  &defaultLogger{},
 	}
 
 	err := conn.recv(context.Background(), false)

connectionpool.go

@@ -143,20 +143,18 @@ func connConfig(cfg *ClusterConfig) (*ConnConfig, error) {
 	}
 
 	return &ConnConfig{
-		ProtoVersion:     cfg.ProtoVersion,
-		CQLVersion:       cfg.CQLVersion,
-		Timeout:          cfg.Timeout,
-		WriteTimeout:     cfg.WriteTimeout,
-		ConnectTimeout:   cfg.ConnectTimeout,
-		Dialer:           cfg.Dialer,
-		HostDialer:       hostDialer,
-		Compressor:       cfg.Compressor,
-		Authenticator:    cfg.Authenticator,
-		AuthProvider:     cfg.AuthProvider,
-		Keepalive:        cfg.SocketKeepalive,
-		Logger:           cfg.Logger,
-		StructuredLogger: cfg.StructuredLogger,
-		LegacyLogLevel:   cfg.LegacyLogLevel,
+		ProtoVersion:   cfg.ProtoVersion,
+		CQLVersion:     cfg.CQLVersion,
+		Timeout:        cfg.Timeout,
+		WriteTimeout:   cfg.WriteTimeout,
+		ConnectTimeout: cfg.ConnectTimeout,
+		Dialer:         cfg.Dialer,
+		HostDialer:     hostDialer,
+		Compressor:     cfg.Compressor,
+		Authenticator:  cfg.Authenticator,
+		AuthProvider:   cfg.AuthProvider,
+		Keepalive:      cfg.SocketKeepalive,
+		Logger:         cfg.Logger,
 	}, nil
 }
 
@@ -312,7 +310,7 @@ type hostConnPool struct {
 	filling bool
 
 	pos    uint32
-	logger internalLogger
+	logger StructuredLogger
 }
 
 func (h *hostConnPool) String() string {

control_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file

crc_test.go

@@ -1,3 +1,6 @@
+//go:build all || unit
+// +build all unit
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file