enable json output format for logger (berachain#58)

* enable json output format for logger

* address

* linter

go.mod

@@ -3,6 +3,7 @@ module github.com/berachain/offchain-sdk
 go 1.21
 
 require (
+	cosmossdk.io/log v1.3.0
 	github.com/alitto/pond v1.8.3
 	github.com/aws/aws-sdk-go-v2 v1.23.1
 	github.com/aws/aws-sdk-go-v2/config v1.18.45
@@ -15,7 +16,6 @@ require (
 	github.com/hashicorp/golang-lru/v2 v2.0.7
 	github.com/huandu/skiplist v1.2.0
 	github.com/prometheus/client_golang v1.17.0
-	github.com/rs/zerolog v1.31.0
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/viper v1.17.0
 	github.com/stretchr/testify v1.8.4
@@ -114,7 +114,7 @@ require (
 	github.com/golangci/misspell v0.4.1 // indirect
 	github.com/golangci/revgrep v0.0.0-20220804021717-745bb2f7c2e6 // indirect
 	github.com/golangci/unconvert v0.0.0-20180507085042-28b1c447d1f4 // indirect
-	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/gordonklaus/ineffassign v0.0.0-20230610083614-0e73809eb601 // indirect
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
@@ -179,6 +179,7 @@ require (
 	github.com/quasilyte/stdinfo v0.0.0-20220114132959-f7386bf02567 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/rogpeppe/go-internal v1.11.0 // indirect
+	github.com/rs/zerolog v1.31.0 // indirect
 	github.com/ryancurrah/gomodguard v1.3.0 // indirect
 	github.com/ryanrolds/sqlclosecheck v0.4.0 // indirect
 	github.com/sagikazarmark/locafero v0.3.0 // indirect
@@ -231,7 +232,7 @@ require (
 	golang.org/x/exp/typeparams v0.0.0-20230307190834-24139beb5833 // indirect
 	golang.org/x/mod v0.12.0 // indirect
 	golang.org/x/sync v0.5.0 // indirect
-	golang.org/x/sys v0.14.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/tools v0.13.0 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect

go.sum

@@ -39,6 +39,8 @@ cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohl
 cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs=
 cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0=
 cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3fOKtUw0Xmo=
+cosmossdk.io/log v1.3.0 h1:L0Z0XstClo2kOU4h3V1iDoE5Ji64sg5HLOogzGg67Oo=
+cosmossdk.io/log v1.3.0/go.mod h1:HIDyvWLqZe2ovlWabsDN4aPMpY/nUEquAhgfTf2ZzB8=
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 github.com/4meepo/tagalign v1.3.2 h1:1idD3yxlRGV18VjqtDbqYvQ5pXqQS0wO2dn6M3XstvI=
 github.com/4meepo/tagalign v1.3.2/go.mod h1:Q9c1rYMZJc9dPRkbQPpcBNCLEmY2njbAsXhQOZFE2dE=
@@ -397,8 +399,8 @@ github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
@@ -1095,8 +1097,8 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q=
-golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
+golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
@@ -1323,6 +1325,8 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gotest.tools/v3 v3.5.1 h1:EENdUnS3pdur5nybKYIh2Vfgc8IUNBjxDPSjtiJcOzU=
+gotest.tools/v3 v3.5.1/go.mod h1:isy3WKz7GK6uNw/sbHzfKBLvlvXwUyV06n6brMxxopU=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

log/log.go

@@ -4,10 +4,10 @@ import (
 	"io"
 	"time"
 
-	"github.com/rs/zerolog"
+	"cosmossdk.io/log"
 )
 
-// Logger is the interface for the logger. It's a wrapper around zerolog.
+// Logger is the interface for the logger. It's based on cosmossdk.io/log.
 type Logger interface {
 	// Info takes a message and a set of key/value pairs and logs with level INFO.
 	// The key of the tuple must be a string.
@@ -28,74 +28,54 @@ type Logger interface {
 	// With returns a new wrapped logger with additional context provided by a set
 	With(keyVals ...any) Logger
 
-	// Fatal takes a message and a set of key/value pairs and logs with level FATAL.
-	Fatal(msg string, keyVals ...any)
-
 	// Impl returns the underlying logger implementation
 	// It is used to access the full functionalities of the underlying logger
 	// Advanced users can type cast the returned value to the actual logger
 	Impl() any
 }
 
-// zeroLogWrapper is the implementation of the Logger interface.
-// It wraps a zerolog logger.
-type zeroLogWrapper struct {
-	*zerolog.Logger
-}
-
-// Info takes a message and a set of key/value pairs and logs with level INFO.
-// The key of the tuple must be a string.
-func (l zeroLogWrapper) Info(msg string, keyVals ...interface{}) {
-	l.Logger.Info().Fields(keyVals).Msg(msg)
-}
-
-// Error takes a message and a set of key/value pairs and logs with level DEBUG.
-// The key of the tuple must be a string.
-func (l zeroLogWrapper) Error(msg string, keyVals ...interface{}) {
-	l.Logger.Error().Fields(keyVals).Msg(msg)
-}
-
-// Warn takes a message and a set of key/value pairs and logs with level WARN.
-// The key of the tuple must be a string.
-func (l zeroLogWrapper) Warn(msg string, keyVals ...interface{}) {
-	l.Logger.Warn().Fields(keyVals).Msg(msg)
-}
-
-// Debug takes a message and a set of key/value pairs and logs with level ERR.
-// The key of the tuple must be a string.
-func (l zeroLogWrapper) Debug(msg string, keyVals ...interface{}) {
-	l.Logger.Debug().Fields(keyVals).Msg(msg)
-}
-
-// Fatal takes a message and a set of key/value pairs and logs with level FATAL.
-func (l zeroLogWrapper) Fatal(msg string, keyVals ...interface{}) {
-	l.Logger.Fatal().Fields(keyVals).Msg(msg)
+// loggerImpl is the implementation of the Logger interface.
+type loggerImpl struct {
+	log.Logger
 }
 
 // With returns a new wrapped logger with additional context provided by a set.
-func (l zeroLogWrapper) With(keyVals ...interface{}) Logger {
-	logger := l.Logger.With().Fields(keyVals).Logger()
-	return zeroLogWrapper{&logger}
-}
-
-// Impl returns the underlying zerolog logger.
-// It can be used to used zerolog structured API directly instead of the wrapper.
-func (l zeroLogWrapper) Impl() interface{} {
-	return l.Logger
+func (l *loggerImpl) With(keyVals ...any) Logger {
+	logger := l.Logger.With(keyVals...)
+	return &loggerImpl{logger}
 }
 
 // NewLogger creates a new logger with the given writer and runner name.
-// The logger is a wrapper around zerolog.
+// The logger is a wrapper around cosmossdk logger.
 func NewLogger(dst io.Writer, runner string) Logger {
-	output := zerolog.ConsoleWriter{Out: dst, TimeFormat: time.Kitchen}
-	logger := zerolog.New(output).With().Timestamp().Str("namespace", runner).Logger()
-	return zeroLogWrapper{&logger}
+	opts := []log.Option{
+		log.ColorOption(true),
+		log.TimeFormatOption(time.RFC3339),
+	}
+	logger := log.NewLogger(dst, opts...)
+	return &loggerImpl{logger.With("namespace", runner)}
 }
 
-// NewBlankLogger creates a new logger with the given writer and runner name.
-// The logger is a wrapper around zerolog.
+// NewJsonLogger creates a new logger with the given writer and runner name.
+// It sets the output of the logger to JSON.
+func NewJSONLogger(dst io.Writer, runner string) Logger {
+	opts := []log.Option{
+		log.OutputJSONOption(),
+		log.TimeFormatOption(time.RFC3339),
+	}
+
+	logger := log.NewLogger(dst, opts...)
+	return &loggerImpl{logger.With("namespace", runner)}
+}
+
+// NewBlankLogger creates a new logger with the given writer.
+// The logger is a wrapper around cosmossdk logger.
 func NewBlankLogger(dst io.Writer) Logger {
-	output := zerolog.ConsoleWriter{Out: dst, TimeFormat: time.Kitchen}
-	logger := zerolog.New(output).With().Timestamp().Logger()
-	return zeroLogWrapper{&logger}
+	opts := []log.Option{
+		log.ColorOption(true),
+		log.TimeFormatOption(time.Kitchen),
+	}
+
+	logger := log.NewLogger(dst, opts...)
+	return &loggerImpl{logger}
 }