Provide clean method for overriding a logger and integrating with oth…

…er logging frameworks
radekg · Jan 12, 2022 · 5e441a9 · 5e441a9
1 parent 0f3714b
commit 5e441a9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/client/client.go b/client/client.go
@@ -25,6 +25,10 @@ type YBClient interface {
 	// Execute executes the payload against the service
 	// and populates the response with the response data.
 	Execute(payload, response protoreflect.ProtoMessage) error
+	// Allows configuring the logger used by the client.
+	// Uses go-hclog. Users can provide integrate with any logging
+	// framework using https://pkg.go.dev/github.com/hashicorp/go-hclog#InterceptLogger.
+	WithLogger(logger hclog.Logger) YBClient
 }
 
 var (
@@ -46,14 +50,19 @@ type defaultYBClient struct {
 }
 
 // NewYBClient constructs a new instance of the high-level YugabyteDB client.
-func NewYBClient(config *configs.YBClientConfig, logger hclog.Logger) YBClient {
+func NewYBClient(config *configs.YBClientConfig) YBClient {
 	return &defaultYBClient{
 		config: config.WithDefaults(),
 		lock:   &sync.Mutex{},
-		logger: logger,
+		logger: hclog.Default(),
 	}
 }
 
+func (c *defaultYBClient) WithLogger(logger hclog.Logger) YBClient {
+	c.logger = logger
+	return c
+}
+
 func (c *defaultYBClient) Close() error {
 	c.lock.Lock()
 	defer c.lock.Unlock()

diff --git a/testutils/master/master_test.go b/testutils/master/master_test.go
@@ -5,7 +5,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/hashicorp/go-hclog"
 	"github.com/radekg/yugabyte-db-go-client/client"
 	"github.com/radekg/yugabyte-db-go-client/configs"
 	"github.com/radekg/yugabyte-db-go-client/errors"
@@ -25,7 +24,7 @@ func TestMasterIntegration(t *testing.T) {
 	client := client.NewYBClient(&configs.YBClientConfig{
 		MasterHostPort: testCtx.MasterExternalAddresses(),
 		OpTimeout:      time.Duration(time.Second * 5),
-	}, hclog.Default())
+	})
 
 	common.Eventually(t, 15, func() error {
 		if err := client.Connect(); err != nil {
@@ -64,7 +63,7 @@ func TestMasterReconnect(t *testing.T) {
 		OpTimeout:              time.Duration(time.Second * 5),
 		MaxReconnectAttempts:   1,
 		ReconnectRetryInterval: time.Duration(time.Millisecond * 100),
-	}, hclog.Default())
+	})
 
 	errNotConnected := client.Execute(request, &ybApi.ListMastersResponsePB{})
 	assert.NotNil(t, errNotConnected, "expected an error")

diff --git a/testutils/tserver/tserver_test.go b/testutils/tserver/tserver_test.go
@@ -6,7 +6,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/hashicorp/go-hclog"
 	"github.com/radekg/yugabyte-db-go-client/client"
 	"github.com/radekg/yugabyte-db-go-client/configs"
 	"github.com/radekg/yugabyte-db-go-client/testutils/common"
@@ -30,7 +29,7 @@ func TestTServerIntegration(t *testing.T) {
 	client := client.NewYBClient(&configs.YBClientConfig{
 		MasterHostPort: masterTestCtx.MasterExternalAddresses(),
 		OpTimeout:      time.Duration(time.Second * 5),
-	}, hclog.Default())
+	})
 
 	common.Eventually(t, 15, func() error {
 		if err := client.Connect(); err != nil {
@@ -48,7 +47,7 @@ func TestTServerIntegration(t *testing.T) {
 		if err != nil {
 			return err
 		}
-		t.Log(" ==> Received master list", response)
+		t.Log("Received master list", response)
 		return nil
 	})