chore(logging)_: switch to zap.Logger as central logger

api/geth_backend.go

@@ -497,7 +497,7 @@ func (b *GethStatusBackend) setupLogSettings() error {
 		MaxBackups:      b.config.LogMaxBackups,
 		CompressRotated: b.config.LogCompressRotated,
 	}
-	if err := logutils.OverrideRootLogWithConfig(logSettings, false); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		return err
 	}
 	return nil

cmd/node-canary/main.go

@@ -9,8 +9,6 @@ import (
 	"path/filepath"
 	"time"
 
-	"golang.org/x/crypto/ssh/terminal"
-
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/p2p"
 	"github.com/ethereum/go-ethereum/p2p/enode"
@@ -25,13 +23,12 @@ import (
 var logger = log.New("package", "status-go/cmd/node-canary")
 
 var (
-	staticEnodeAddr  = flag.String("staticnode", "", "checks if static node talks waku protocol (e.g. enode://[email protected]:30303)")
-	minPow           = flag.Float64("waku.pow", params.WakuMinimumPoW, "PoW for messages to be added to queue, in float format")
-	ttl              = flag.Int("waku.ttl", params.WakuTTL, "Time to live for messages, in seconds")
-	homePath         = flag.String("home-dir", ".", "Home directory where state is stored")
-	logLevel         = flag.String("log", "INFO", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
-	logFile          = flag.String("logfile", "", "Path to the log file")
-	logWithoutColors = flag.Bool("log-without-color", false, "Disables log colors")
+	staticEnodeAddr = flag.String("staticnode", "", "checks if static node talks waku protocol (e.g. enode://[email protected]:30303)")
+	minPow          = flag.Float64("waku.pow", params.WakuMinimumPoW, "PoW for messages to be added to queue, in float format")
+	ttl             = flag.Int("waku.ttl", params.WakuTTL, "Time to live for messages, in seconds")
+	homePath        = flag.String("home-dir", ".", "Home directory where state is stored")
+	logLevel        = flag.String("log", "INFO", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
+	logFile         = flag.String("logfile", "", "Path to the log file")
 )
 
 func main() {
@@ -58,12 +55,12 @@ func main() {
 func init() {
 	flag.Parse()
 
-	colors := !(*logWithoutColors)
-	if colors {
-		colors = terminal.IsTerminal(int(os.Stdin.Fd()))
-	}
-
-	if err := logutils.OverrideRootLog(*logLevel != "", *logLevel, logutils.FileOptions{Filename: *logFile}, colors); err != nil {
+	err := logutils.OverrideRootLoggerWithConfig(logutils.LogSettings{
+		Enabled: *logLevel != "",
+		Level:   *logLevel,
+		File:    *logFile,
+	})
+	if err != nil {
 		stdlog.Fatalf("Error initializing logger: %s", err)
 	}
 }

cmd/ping-community/main.go

@@ -13,7 +13,6 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/ethereum/go-ethereum/log"
 
@@ -40,17 +39,16 @@ const (
 )
 
 var (
-	configFiles      configFlags
-	logLevel         = flag.String("log", "", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
-	logWithoutColors = flag.Bool("log-without-color", false, "Disables log colors")
-	ipcEnabled       = flag.Bool("ipc", false, "Enable IPC RPC endpoint")
-	ipcFile          = flag.String("ipcfile", "", "Set IPC file path")
-	seedPhrase       = flag.String("seed-phrase", "", "Seed phrase")
-	version          = flag.Bool("version", false, "Print version and dump configuration")
-	communityID      = flag.String("community-id", "", "The id of the community")
-	shardCluster     = flag.Int("shard-cluster", shard.MainStatusShardCluster, "The shard cluster in which the of the community is published")
-	shardIndex       = flag.Int("shard-index", shard.DefaultShardIndex, "The shard index in which the community is published")
-	chatID           = flag.String("chat-id", "", "The id of the chat")
+	configFiles  configFlags
+	logLevel     = flag.String("log", "", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
+	ipcEnabled   = flag.Bool("ipc", false, "Enable IPC RPC endpoint")
+	ipcFile      = flag.String("ipcfile", "", "Set IPC file path")
+	seedPhrase   = flag.String("seed-phrase", "", "Seed phrase")
+	version      = flag.Bool("version", false, "Print version and dump configuration")
+	communityID  = flag.String("community-id", "", "The id of the community")
+	shardCluster = flag.Int("shard-cluster", shard.MainStatusShardCluster, "The shard cluster in which the of the community is published")
+	shardIndex   = flag.Int("shard-index", shard.DefaultShardIndex, "The shard index in which the community is published")
+	chatID       = flag.String("chat-id", "", "The id of the chat")
 
 	dataDir   = flag.String("dir", getDefaultDataDir(), "Directory used by node to store data")
 	networkID = flag.Int(
@@ -73,8 +71,11 @@ func init() {
 
 // nolint:gocyclo
 func main() {
-	colors := terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLog(true, "ERROR", logutils.FileOptions{}, colors); err != nil {
+	err := logutils.OverrideRootLoggerWithConfig(logutils.LogSettings{
+		Enabled: true,
+		Level:   "ERROR",
+	})
+	if err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 
@@ -242,8 +243,7 @@ func setupLogging(config *params.NodeConfig) {
 		MaxBackups:      config.LogMaxBackups,
 		CompressRotated: config.LogCompressRotated,
 	}
-	colors := !(*logWithoutColors) && terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLogWithConfig(logSettings, colors); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 }

cmd/populate-db/main.go

@@ -14,7 +14,6 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/ethereum/go-ethereum/log"
 
@@ -47,19 +46,18 @@ const (
 )
 
 var (
-	configFiles      configFlags
-	logLevel         = flag.String("log", "", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
-	logWithoutColors = flag.Bool("log-without-color", false, "Disables log colors")
-	ipcEnabled       = flag.Bool("ipc", false, "Enable IPC RPC endpoint")
-	ipcFile          = flag.String("ipcfile", "", "Set IPC file path")
-	seedPhrase       = flag.String("seed-phrase", "", "Seed phrase")
-	version          = flag.Bool("version", false, "Print version and dump configuration")
-	nAddedContacts   = flag.Int("added-contacts", 100, "Number of added contacts to create")
-	nContacts        = flag.Int("contacts", 100, "Number of contacts to create")
-	nPublicChats     = flag.Int("public-chats", 5, "Number of public chats")
-	nCommunities     = flag.Int("communities", 5, "Number of communities")
-	nMessages        = flag.Int("number-of-messages", 0, "Number of messages for each chat")
-	nOneToOneChats   = flag.Int("one-to-one-chats", 5, "Number of one to one chats")
+	configFiles    configFlags
+	logLevel       = flag.String("log", "", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
+	ipcEnabled     = flag.Bool("ipc", false, "Enable IPC RPC endpoint")
+	ipcFile        = flag.String("ipcfile", "", "Set IPC file path")
+	seedPhrase     = flag.String("seed-phrase", "", "Seed phrase")
+	version        = flag.Bool("version", false, "Print version and dump configuration")
+	nAddedContacts = flag.Int("added-contacts", 100, "Number of added contacts to create")
+	nContacts      = flag.Int("contacts", 100, "Number of contacts to create")
+	nPublicChats   = flag.Int("public-chats", 5, "Number of public chats")
+	nCommunities   = flag.Int("communities", 5, "Number of communities")
+	nMessages      = flag.Int("number-of-messages", 0, "Number of messages for each chat")
+	nOneToOneChats = flag.Int("one-to-one-chats", 5, "Number of one to one chats")
 
 	dataDir   = flag.String("dir", getDefaultDataDir(), "Directory used by node to store data")
 	networkID = flag.Int(
@@ -82,8 +80,11 @@ func init() {
 
 // nolint:gocyclo
 func main() {
-	colors := terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLog(true, "ERROR", logutils.FileOptions{}, colors); err != nil {
+	err := logutils.OverrideRootLoggerWithConfig(logutils.LogSettings{
+		Enabled: true,
+		Level:   "ERROR",
+	})
+	if err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 
@@ -286,8 +287,7 @@ func setupLogging(config *params.NodeConfig) {
 		MaxBackups:      config.LogMaxBackups,
 		CompressRotated: config.LogCompressRotated,
 	}
-	colors := !(*logWithoutColors) && terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLogWithConfig(logSettings, colors); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 }

cmd/spiff-workflow/main.go

@@ -14,7 +14,6 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/ethereum/go-ethereum/log"
 	gethmetrics "github.com/ethereum/go-ethereum/metrics"
@@ -42,16 +41,15 @@ const (
 )
 
 var (
-	configFiles      configFlags
-	logLevel         = flag.String("log", "INFO", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
-	logWithoutColors = flag.Bool("log-without-color", false, "Disables log colors")
-	seedPhrase       = flag.String("seed-phrase", "", "Seed phrase")
-	version          = flag.Bool("version", false, "Print version and dump configuration")
-	apiModules       = flag.String("api-modules", "wakuext,ext,waku,ens", "API modules to enable in the HTTP server")
-	pprofEnabled     = flag.Bool("pprof", false, "Enable runtime profiling via pprof")
-	pprofPort        = flag.Int("pprof-port", 52525, "Port for runtime profiling via pprof")
-	metricsEnabled   = flag.Bool("metrics", false, "Expose ethereum metrics with debug_metrics jsonrpc call")
-	metricsPort      = flag.Int("metrics-port", 9305, "Port for the Prometheus /metrics endpoint")
+	configFiles    configFlags
+	logLevel       = flag.String("log", "INFO", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
+	seedPhrase     = flag.String("seed-phrase", "", "Seed phrase")
+	version        = flag.Bool("version", false, "Print version and dump configuration")
+	apiModules     = flag.String("api-modules", "wakuext,ext,waku,ens", "API modules to enable in the HTTP server")
+	pprofEnabled   = flag.Bool("pprof", false, "Enable runtime profiling via pprof")
+	pprofPort      = flag.Int("pprof-port", 52525, "Port for runtime profiling via pprof")
+	metricsEnabled = flag.Bool("metrics", false, "Expose ethereum metrics with debug_metrics jsonrpc call")
+	metricsPort    = flag.Int("metrics-port", 9305, "Port for the Prometheus /metrics endpoint")
 
 	dataDir   = flag.String("dir", getDefaultDataDir(), "Directory used by node to store data")
 	networkID = flag.Int(
@@ -74,8 +72,11 @@ func init() {
 
 // nolint:gocyclo
 func main() {
-	colors := terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLog(true, "ERROR", logutils.FileOptions{}, colors); err != nil {
+	err := logutils.OverrideRootLoggerWithConfig(logutils.LogSettings{
+		Enabled: true,
+		Level:   "ERROR",
+	})
+	if err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 
@@ -185,8 +186,7 @@ func setupLogging(config *params.NodeConfig) {
 		MaxBackups:      config.LogMaxBackups,
 		CompressRotated: config.LogCompressRotated,
 	}
-	colors := !(*logWithoutColors) && terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLogWithConfig(logSettings, colors); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 }

cmd/status-backend/main.go

@@ -3,9 +3,6 @@ package main
 import (
 	"flag"
 	stdlog "log"
-	"os"
-
-	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/ethereum/go-ethereum/log"
 
@@ -24,8 +21,7 @@ func init() {
 		MobileSystem: false,
 		Level:        "INFO",
 	}
-	colors := terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLogWithConfig(logSettings, colors); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		stdlog.Fatalf("failed to initialize log: %v", err)
 	}
 }

cmd/status-cli/util.go

@@ -32,7 +32,7 @@ func setupLogger(file string) *zap.Logger {
 		MaxBackups:      3,
 		CompressRotated: true,
 	}
-	if err := logutils.OverrideRootLogWithConfig(logSettings, false); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		zap.S().Fatalf("Error initializing logger: %v", err)
 	}
 	return logutils.ZapLogger()

cmd/statusd/main.go

@@ -16,7 +16,6 @@ import (
 
 	"github.com/google/uuid"
 	"github.com/okzk/sdnotify"
-	"golang.org/x/crypto/ssh/terminal"
 
 	"github.com/ethereum/go-ethereum/log"
 	gethmetrics "github.com/ethereum/go-ethereum/metrics"
@@ -46,7 +45,6 @@ const (
 var (
 	configFiles                    configFlags
 	logLevel                       = flag.String("log", "", `Log level, one of: "ERROR", "WARN", "INFO", "DEBUG", and "TRACE"`)
-	logWithoutColors               = flag.Bool("log-without-color", false, "Disables log colors")
 	ipcEnabled                     = flag.Bool("ipc", false, "Enable IPC RPC endpoint")
 	ipcFile                        = flag.String("ipcfile", "", "Set IPC file path")
 	pprofEnabled                   = flag.Bool("pprof", false, "Enable runtime profiling via pprof")
@@ -100,8 +98,11 @@ func init() {
 
 // nolint:gocyclo
 func main() {
-	colors := terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLog(true, "ERROR", logutils.FileOptions{}, colors); err != nil {
+	err := logutils.OverrideRootLoggerWithConfig(logutils.LogSettings{
+		Enabled: true,
+		Level:   "ERROR",
+	})
+	if err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 
@@ -400,8 +401,7 @@ func setupLogging(config *params.NodeConfig) {
 		MaxBackups:      config.LogMaxBackups,
 		CompressRotated: config.LogCompressRotated,
 	}
-	colors := !(*logWithoutColors) && terminal.IsTerminal(int(os.Stdin.Fd()))
-	if err := logutils.OverrideRootLogWithConfig(logSettings, colors); err != nil {
+	if err := logutils.OverrideRootLoggerWithConfig(logSettings); err != nil {
 		stdlog.Fatalf("Error initializing logger: %v", err)
 	}
 }

go.mod

@@ -287,7 +287,6 @@ require (
 	golang.org/x/mod v0.20.0 // indirect
 	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/sys v0.24.0 // indirect
-	golang.org/x/term v0.23.0 // indirect
 	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	lukechampine.com/blake3 v1.3.0 // indirect

go.sum

@@ -2720,8 +2720,6 @@ golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY=
 golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
 golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU=
 golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY=
-golang.org/x/term v0.23.0 h1:F6D4vR+EHoL9/sWAWgAR1H2DcHr4PareCbAaCo1RpuU=
-golang.org/x/term v0.23.0/go.mod h1:DgV24QBUrK6jhZXl+20l6UWznPlwAHm1Q1mGHtydmSk=
 golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

logutils/core.go

@@ -53,6 +53,14 @@ func (core *Core) Enabled(lvl zapcore.Level) bool {
 	return core.level.Enabled(lvl)
 }
 
+func (core *Core) Level() zapcore.Level {
+	return core.level.Level()
+}
+
+func (core *Core) SetLevel(lvl zapcore.Level) {
+	core.level.SetLevel(lvl)
+}
+
 func (core *Core) With(fields []zapcore.Field) zapcore.Core {
 	clonedEncoder := encoderWrapper{Encoder: core.getEncoder().Clone()}
 	for i := range fields {

logutils/logger.go

@@ -1,27 +1,52 @@
 package logutils
 
 import (
+	"io"
 	"sync"
+	"time"
 
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/status-im/status-go/protocol/zaputil"
 )
 
 var (
 	_zapLogger     *zap.Logger
 	_initZapLogger sync.Once
 )
 
-// ZapLogger creates a custom zap.Logger which will forward logs
-// to status-go logger.
 func ZapLogger() *zap.Logger {
 	_initZapLogger.Do(func() {
-		var err error
-		_zapLogger, err = NewZapLoggerWithAdapter(log.Root())
-		if err != nil {
-			panic(err)
-		}
+		_zapLogger = defaultLogger()
+
+		// forward geth logs to zap logger
+		_gethLogger := _zapLogger.Named("geth")
+		log.Root().SetHandler(gethAdapter(_gethLogger))
 	})
 	return _zapLogger
 }
+
+func defaultLogger() *zap.Logger {
+	core := NewCore(
+		defaultEncoder(),
+		zapcore.AddSync(io.Discard),
+		zap.NewAtomicLevelAt(zap.InfoLevel),
+	)
+	return zap.New(core)
+}
+
+func defaultEncoder() zapcore.Encoder {
+	encoderConfig := zap.NewDevelopmentEncoderConfig()
+	encoderConfig.EncodeTime = utcTimeEncoder(encoderConfig.EncodeTime)
+	encoderConfig.EncodeCaller = zapcore.FullCallerEncoder
+
+	return zaputil.NewConsoleHexEncoder(encoderConfig)
+}
+
+func utcTimeEncoder(encoder zapcore.TimeEncoder) zapcore.TimeEncoder {
+	return func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
+		encoder(t.UTC(), enc)
+	}
+}