Merge pull request #419 from bane-labs/reduce-logs-verbosity

dBFT: add ability to customize log level

Author: roman-khimov

Makefile

@@ -107,6 +107,7 @@ define run_node
 		--metrics \
 		--nat $(NAT_POLICY) \
 		--netrestrict $(RESTRICTED_NETWORK) \
+		--dbft.loglevel debug \
 		$(7) >  $(1)/$(2)/geth_node.log 2>&1 &
 endef
 

cmd/geth/main.go

@@ -131,6 +131,7 @@ var (
 		utils.AntiMEVKeyStoreFlag,
 		utils.AntiMEVEnforceECDSABlockSignatureSchemeFlag,
 		utils.AntiMEVPasswordFlag,
+		utils.DBFTLogLevelFlag,
 		utils.NATFlag,
 		utils.NoDiscoverFlag,
 		utils.DiscoveryV4Flag,

cmd/utils/flags.go

@@ -587,6 +587,11 @@ var (
 		Usage:    "Disables db compaction after import",
 		Category: flags.LoggingCategory,
 	}
+	DBFTLogLevelFlag = &cli.StringFlag{
+		Name:     "dbft.loglevel",
+		Usage:    `Logging level to use for dBFT consensus engine events. The following values are supported: "debug", "info" (default), "warn", "error", "dpanic", "panic", "fatal"`,
+		Category: flags.LoggingCategory,
+	}
 
 	// MISC settings
 	SyncTargetFlag = &cli.StringFlag{
@@ -1742,6 +1747,9 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
 	if ctx.IsSet(AntiMEVEnforceECDSABlockSignatureSchemeFlag.Name) {
 		cfg.AntiMEVEnforceECDSABlockSignatureScheme = ctx.Bool(AntiMEVEnforceECDSABlockSignatureSchemeFlag.Name)
 	}
+	if ctx.IsSet(DBFTLogLevelFlag.Name) {
+		cfg.DBFTLogLevel = ctx.String(DBFTLogLevelFlag.Name)
+	}
 	if !ctx.Bool(SnapshotFlag.Name) || cfg.SnapshotCache == 0 {
 		// If snap-sync is requested, this flag is also required
 		if cfg.SyncMode == downloader.SnapSync {

consensus/dbft/dbft.go

@@ -63,6 +63,7 @@ import (
 	"github.com/nspcc-dev/dbft"
 	"github.com/nspcc-dev/dbft/timer"
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 	"golang.org/x/crypto/sha3"
 	"golang.org/x/exp/slices"
 )
@@ -234,6 +235,7 @@ type config struct {
 	dkgEnablingHeight      int64
 	antiMEVEnablingHeight  int64
 	enforceECDSASignatures bool
+	logLevel               *zap.AtomicLevel
 }
 
 // New creates a DBFT proof-of-authority consensus engine with the initial
@@ -284,10 +286,11 @@ func New(chainCfg *params.ChainConfig, _ ethdb.Database) (*DBFT, error) {
 	}
 
 	var err error
-	logger, err := zap.NewDevelopment()
+	logger, logLevel, err := buildLogger()
 	if err != nil {
 		return nil, fmt.Errorf("failed to initialize dBFT logger: %w", err)
 	}
+	c.config.logLevel = logLevel
 	dbftCfg := []func(*dbft.Config[common.Hash]){
 		dbft.WithTimer[common.Hash](timer.New()),
 		dbft.WithLogger[common.Hash](logger),
@@ -333,6 +336,23 @@ func New(chainCfg *params.ChainConfig, _ ethdb.Database) (*DBFT, error) {
 	return c, nil
 }
 
+// buildLogger builds zap logger for dbft library events logging with Info level
+// used as a default.
+func buildLogger() (*zap.Logger, *zap.AtomicLevel, error) {
+	cc := zap.NewProductionConfig()
+	cc.DisableCaller = true
+	cc.DisableStacktrace = true
+	cc.EncoderConfig.EncodeDuration = zapcore.StringDurationEncoder
+	cc.EncoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
+	cc.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
+	cc.Encoding = "console"
+	cc.Level = zap.NewAtomicLevelAt(zapcore.InfoLevel)
+	cc.Sampling = nil
+
+	log, err := cc.Build()
+	return log, &cc.Level, err
+}
+
 // getKeyPairCb is a dbft library setting callback.
 func (c *DBFT) getKeyPairCb(keys []dbft.PublicKey) (int, dbft.PrivateKey, dbft.PublicKey) {
 	c.lock.RLock()
@@ -1211,7 +1231,7 @@ func (c *DBFT) newLocalPool(parent *types.Header) *legacypool.LegacyPool {
 	return p
 }
 
-// ValidateDecryptedTx checks the validity of the transaction to determine whether the outer envelope transaction should be replaced.
+// validateDecryptedTx checks the validity of the transaction to determine whether the outer envelope transaction should be replaced.
 func (c *DBFT) validateDecryptedTx(head *types.Header, decryptedTx *types.Transaction, envelope *types.Transaction) error {
 	// Make sure the transaction is signed properly and has the same sender and nonce with envelope
 	if decryptedTx.Nonce() != envelope.Nonce() {
@@ -1356,6 +1376,20 @@ func (c *DBFT) WithEthAPIBackend(b ethapi.Backend) {
 	c.txAPI = ethapi.NewTransactionAPI(b, new(ethapi.AddrLocker))
 }
 
+// WithLogLevel updates dBFT logger log level to the provided one if specified.
+func (c *DBFT) WithLogLevel(logLevel string) error {
+	if len(logLevel) == 0 {
+		return nil
+	}
+
+	level, err := zapcore.ParseLevel(logLevel)
+	if err != nil {
+		return fmt.Errorf("unexpected dBFT log level %s: %w", logLevel, err)
+	}
+	c.config.logLevel.SetLevel(level)
+	return nil
+}
+
 // EnforceECDSASignatures enforces ECDSA multisignature block signing scheme.
 // This setting will be applied starting from NeoXAMEV fork.
 func (c *DBFT) EnforceECDSASignatures() {

eth/backend.go

@@ -300,6 +300,10 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 		bft.WithTxPool(eth.TxPool())
 		bft.WithRequestTxs(eth.handler.BroadcastRequestTxs)
 		bft.WithMux(eth.EventMux())
+		err := bft.WithLogLevel(config.DBFTLogLevel)
+		if err != nil {
+			return nil, err
+		}
 		if config.AntiMEVEnforceECDSABlockSignatureScheme {
 			bft.EnforceECDSASignatures()
 		}

eth/ethconfig/config.go

@@ -165,6 +165,11 @@ type Config struct {
 	// AntiMEVEnforceECDSABlockSignatureScheme enables ECDSA multisignatures for
 	// block signing instead of threshold-based.
 	AntiMEVEnforceECDSABlockSignatureScheme bool `toml:",omitempty"`
+
+	// DBFTLogLevel is a dBFT engine log level. The following values are allowed:
+	// "debug", "info", "warn", "error", "dpanic", "panic", "fatal". If not specified,
+	// "info" is used.
+	DBFTLogLevel string `toml:",omitempty"`
 }
 
 // CreateConsensusEngine creates a consensus engine for the given chain config.