replace logrus with zap

renproject · Jul 16, 2020 · bffe4ee · bffe4ee
1 parent a87ba49
commit bffe4ee
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 63 deletions.
diff --git a/aw.go b/aw.go
@@ -12,6 +12,7 @@ import (
 	"github.com/renproject/aw/transport"
 	"github.com/renproject/aw/wire"
 	"github.com/renproject/id"
+	"go.uber.org/zap"
 )
 
 type Builder struct {
@@ -53,7 +54,7 @@ func (builder *Builder) WithPrivKey(privKey *id.PrivKey) *Builder {
 		builder.contentResolver,
 	)
 	if err := builder.peer.Addr.Sign(builder.handshaker.PrivKey); err != nil {
-		builder.opts.Logger.Fatalf("signing address=%v: %v", builder.peer.Addr, err)
+		builder.opts.Logger.Fatal("signing address", zap.String("address", builder.peer.Addr.String()), zap.Error(err))
 	}
 	return builder
 }
@@ -70,7 +71,7 @@ func (builder *Builder) WithContentResolver(contentResolver dht.ContentResolver)
 func (builder *Builder) WithAddr(addr wire.Address) *Builder {
 	builder.peer.Addr = addr
 	if err := builder.peer.Addr.Sign(builder.handshaker.PrivKey); err != nil {
-		builder.opts.Logger.Fatalf("signing address=%v: %v", addr, err)
+		builder.opts.Logger.Fatal("signing address", zap.String("address", addr.String()), zap.Error(err))
 	}
 	return builder
 }

diff --git a/go.mod b/go.mod
@@ -8,7 +8,6 @@ require (
 	github.com/onsi/gomega v1.10.1
 	github.com/renproject/id v0.4.2
 	github.com/renproject/surge v1.2.5
-	github.com/sirupsen/logrus v1.4.2
 	go.uber.org/zap v1.15.0
 	golang.org/x/time v0.0.0-20190308202827-9d24e82272b4
 )
diff --git a/go.sum b/go.sum
@@ -266,9 +266,6 @@ github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
-github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
-github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
-github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
 github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/spaolacci/murmur3 v1.0.1-0.20190317074736-539464a789e9/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=

diff --git a/gossip/gossip.go b/gossip/gossip.go
@@ -2,6 +2,7 @@ package gossip
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"math/rand"
 	"sync"
@@ -12,6 +13,7 @@ import (
 	"github.com/renproject/aw/wire"
 	"github.com/renproject/id"
 	"github.com/renproject/surge"
+	"go.uber.org/zap"
 )
 
 var (
@@ -59,7 +61,7 @@ func New(opts Options, self id.Signatory, dht dht.DHT, trans *transport.Transpor
 }
 
 func (g *Gossiper) Run(ctx context.Context) {
-	g.opts.Logger.Infof("gossiping with alpha=%v", g.opts.Alpha)
+	g.opts.Logger.Info("gossiping", zap.Int("alpha", g.opts.Alpha))
 
 	for {
 		select {
@@ -70,7 +72,7 @@ func (g *Gossiper) Run(ctx context.Context) {
 				ctx, cancel := context.WithTimeout(ctx, g.opts.Timeout)
 				defer cancel()
 				if err := g.trans.Send(ctx, job.Address, job.Message); err != nil {
-					g.opts.Logger.Errorf("sending to address=%v: %v", job.Address, err)
+					g.opts.Logger.Error("sending", zap.String("to", job.Address.String()), zap.Error(err))
 				}
 			}()
 		}
@@ -92,7 +94,7 @@ func (g *Gossiper) Gossip(target, hash id.Hash, dataType uint8) {
 			ContentType: dataType,
 		})
 		if err != nil {
-			g.opts.Logger.Fatalf("marshaling push: %v", err)
+			g.opts.Logger.Fatal("marshaling push", zap.Error(err))
 		}
 		g.send(addr, wire.Message{
 			Version: wire.V1,
@@ -108,7 +110,7 @@ func (g *Gossiper) Gossip(target, hash id.Hash, dataType uint8) {
 		ContentType: dataType,
 	})
 	if err != nil {
-		g.opts.Logger.Fatalf("marshaling push: %v", err)
+		g.opts.Logger.Fatal("marshaling push", zap.Error(err))
 	}
 	g.sendToSubnet(target, wire.Message{
 		Version: wire.V1,
@@ -126,7 +128,7 @@ func (g *Gossiper) Sync(ctx context.Context, subnet, hash id.Hash, dataType uint
 	}
 	marshaledPullV1, err := surge.ToBinary(pullV1)
 	if err != nil {
-		g.opts.Logger.Fatalf("marshaling pull: %v", err)
+		g.opts.Logger.Fatal("marshaling pull", zap.Error(err))
 	}
 	msg := wire.Message{
 		Version: wire.V1,
@@ -207,7 +209,7 @@ func (g *Gossiper) DidReceivePush(version wire.Version, data []byte, from id.Sig
 			}
 			marshaledPullV1, err := surge.ToBinary(pullV1)
 			if err != nil {
-				g.opts.Logger.Fatalf("marshaling pull: %v", err)
+				g.opts.Logger.Fatal("marshaling pull", zap.Error(err))
 			}
 			msg := wire.Message{
 				Version: wire.V1,
@@ -231,7 +233,7 @@ func (g *Gossiper) DidReceivePushAck(version wire.Version, data []byte, from id.
 
 	pushAckV1 := wire.PushAckV1{}
 	if err := surge.FromBinary(&pushAckV1, data); err != nil {
-		g.opts.Logger.Fatalf("unmarshaling push ack: %v", err)
+		g.opts.Logger.Fatal("unmarshaling push ack", zap.Error(err))
 	}
 
 	//
@@ -274,7 +276,7 @@ func (g *Gossiper) DidReceivePull(version wire.Version, data []byte, from id.Sig
 	}
 	pullAckV1Marshaled, err := surge.ToBinary(pullAckV1)
 	if err != nil {
-		g.opts.Logger.Fatalf("marshaling pull: %v", err)
+		g.opts.Logger.Fatal("marshaling pull", zap.Error(err))
 	}
 	return wire.Message{Version: wire.V1, Type: wire.PullAck, Data: pullAckV1Marshaled}, nil
 }
@@ -337,7 +339,7 @@ func (g *Gossiper) sendToSubnet(subnet id.Hash, msg wire.Message) {
 		for _, addr := range addrs {
 			sig, err := addr.Signatory()
 			if err != nil {
-				g.opts.Logger.Errorf("failed to get signatory from %v: err", addr.String(), err)
+				g.opts.Logger.Error("bad signatory", zap.String("address", addr.String()), zap.Error(err))
 				continue
 			}
 			subnetSignatories = append(subnetSignatories, sig)
@@ -386,6 +388,6 @@ func (g *Gossiper) send(addr wire.Address, msg wire.Message) {
 		wire.Message
 	}{addr, msg}:
 	default:
-		g.opts.Logger.Warnf("sending to address=%v: too much back-pressure", addr)
+		g.opts.Logger.Warn("sending", zap.String("to", addr.String()), zap.Error(errors.New("too much back-pressure")))
 	}
 }
diff --git a/gossip/opt.go b/gossip/opt.go
@@ -3,7 +3,7 @@ package gossip
 import (
 	"time"
 
-	"github.com/sirupsen/logrus"
+	"go.uber.org/zap"
 )
 
 var (
@@ -14,7 +14,7 @@ var (
 )
 
 type Options struct {
-	Logger logrus.FieldLogger
+	Logger *zap.Logger
 
 	Alpha       int
 	Bias        float64
@@ -23,19 +23,20 @@ type Options struct {
 }
 
 func DefaultOptions() Options {
+	logger, err := zap.NewDevelopment()
+	if err != nil {
+		panic(err)
+	}
 	return Options{
-		Logger: logrus.New().
-			WithField("lib", "airwave").
-			WithField("pkg", "gossip").
-			WithField("com", "gossiper"),
+		Logger:      logger,
 		Alpha:       DefaultAlpha,
 		Bias:        DefaultBias,
 		Timeout:     DefaultTimeout,
 		MaxCapacity: DefaultMaxCapacity,
 	}
 }
 
-func (opts Options) WithLogger(logger logrus.FieldLogger) Options {
+func (opts Options) WithLogger(logger *zap.Logger) Options {
 	opts.Logger = logger
 	return opts
 }

diff --git a/handshake/opt.go b/handshake/opt.go
@@ -4,7 +4,7 @@ import (
 	"time"
 
 	"github.com/renproject/id"
-	"github.com/sirupsen/logrus"
+	"go.uber.org/zap"
 )
 
 var (
@@ -13,25 +13,26 @@ var (
 )
 
 type Options struct {
-	Logger  logrus.FieldLogger
+	Logger  *zap.Logger
 	PrivKey *id.PrivKey
 	Timeout time.Duration
 	Filter  Filter
 }
 
 func DefaultOptions() Options {
+	logger, err := zap.NewDevelopment()
+	if err != nil {
+		panic(err)
+	}
 	return Options{
-		Logger: logrus.New().
-			WithField("lib", "airwave").
-			WithField("pkg", "handshake").
-			WithField("com", "handshaker"),
+		Logger:  logger,
 		PrivKey: id.NewPrivKey(),
 		Timeout: DefaultTimeout,
 		Filter:  DefaultFilter,
 	}
 }
 
-func (opts Options) WithLogger(logger logrus.FieldLogger) Options {
+func (opts Options) WithLogger(logger *zap.Logger) Options {
 	opts.Logger = logger
 	return opts
 }

diff --git a/opt.go b/opt.go
@@ -1,21 +1,24 @@
 package aw
 
-import "github.com/sirupsen/logrus"
+import (
+	"go.uber.org/zap"
+)
 
 type Options struct {
-	Logger logrus.FieldLogger
+	Logger *zap.Logger
 }
 
 func DefaultOptions() Options {
+	logger, err := zap.NewDevelopment()
+	if err != nil {
+		panic(err)
+	}
 	return Options{
-		Logger: logrus.New().
-			WithField("lib", "airwave").
-			WithField("pkg", "aw").
-			WithField("com", "node"),
+		Logger: logger,
 	}
 }
 
-func (opts Options) WithLogger(logger logrus.FieldLogger) Options {
+func (opts Options) WithLogger(logger *zap.Logger) Options {
 	opts.Logger = logger
 	return opts
 }
diff --git a/peer/opt.go b/peer/opt.go
@@ -5,7 +5,7 @@ import (
 	"time"
 
 	"github.com/renproject/aw/wire"
-	"github.com/sirupsen/logrus"
+	"go.uber.org/zap"
 )
 
 var (
@@ -17,7 +17,7 @@ var (
 )
 
 type Options struct {
-	Logger logrus.FieldLogger
+	Logger *zap.Logger
 
 	Addr                 wire.Address
 	Alpha                int
@@ -27,11 +27,12 @@ type Options struct {
 }
 
 func DefaultOptions() Options {
+	logger, err := zap.NewDevelopment()
+	if err != nil {
+		panic(err)
+	}
 	return Options{
-		Logger: logrus.New().
-			WithField("lib", "airwave").
-			WithField("pkg", "peer").
-			WithField("com", "peer"),
+		Logger: logger,
 
 		Addr:                 DefaultAddr,
 		Alpha:                DefaultAlpha,