refactor(backport): remove unused loggers and log fields (#4180) (#4269)

* chore: remove unused Headers logger

* refactor: remove (mostly) unused GasPrice logger

* refactor: replace logs.FieldMethod with With().Caller() and standardize logs.FieldModule values

* refactor: remove (mostly) unused log fields FieldTracker and FieldConfirmationMode

* refactor: replace missed log instances of '.' for '_'

Author: renan061

changelog.md

@@ -11,6 +11,7 @@
 ### Refactor
 
 * [4144](https://github.com/zeta-chain/node/pull/4144) - standardize structured logging for zetaclient
+* [4180](https://github.com/zeta-chain/node/pull/4180) - remove unused loggers and log fields
 
 ### Fixes
 

pkg/chains/chain.go

@@ -117,8 +117,8 @@ func (chain Chain) IsTONChain() bool {
 
 func (chain Chain) LogFields() map[string]any {
 	return map[string]any{
-		logs.FieldChain:        chain.ChainId,
-		logs.FieldChainNetwork: chain.Network.String(),
+		logs.FieldChain:   chain.ChainId,
+		logs.FieldNetwork: chain.Network.String(),
 	}
 }
 

pkg/scheduler/scheduler.go

@@ -103,7 +103,7 @@ func (s *Scheduler) Register(ctx context.Context, exec Executable, opts ...Opt)
 	task.logger = newTaskLogger(task, config, s.logger)
 	task.ticker = newTickable(task, config)
 
-	task.logger.Info().Msgf("Starting scheduler task %s", task.name)
+	task.logger.Info().Str("started_task", task.name).Msg("starting scheduler task")
 	bg.Work(ctx, task.ticker.Start, bg.WithLogger(task.logger))
 
 	s.mu.Lock()
@@ -153,7 +153,7 @@ func (s *Scheduler) StopGroup(group Group) {
 	s.logger.Info().
 		Int("tasks", len(selectedTasks)).
 		Str("group", string(group)).
-		Msg("Stopping scheduler group")
+		Msg("stopping scheduler group")
 
 	// Stop all selected tasks concurrently
 	var wg sync.WaitGroup
@@ -171,7 +171,7 @@ func (s *Scheduler) StopGroup(group Group) {
 
 // Stop stops the task and offloads it from the scheduler.
 func (t *Task) Stop() {
-	t.logger.Info().Msgf("Stopping scheduler task %s", t.name)
+	t.logger.Info().Str("stopped_task", t.name).Msg("stopping scheduler task")
 	start := time.Now()
 
 	t.ticker.Stop()
@@ -181,7 +181,7 @@ func (t *Task) Stop() {
 	t.scheduler.mu.Unlock()
 
 	timeTakenMS := time.Since(start).Milliseconds()
-	t.logger.Info().Int64("time_taken_ms", timeTakenMS).Msg("Stopped scheduler task")
+	t.logger.Info().Int64("time_taken_ms", timeTakenMS).Msg("stopped scheduler task")
 }
 
 func (t *Task) Group() Group {
@@ -211,8 +211,8 @@ func (t *Task) execute(ctx context.Context) error {
 
 func newTaskLogger(task *Task, opts *taskOpts, logger zerolog.Logger) zerolog.Logger {
 	logOpts := logger.With().
-		Str("task.name", task.name).
-		Str("task.group", string(task.group))
+		Str("task_name", task.name).
+		Str("task_group", string(task.group))
 
 	if len(opts.logFields) > 0 {
 		logOpts = logOpts.Fields(opts.logFields)
@@ -223,7 +223,7 @@ func newTaskLogger(task *Task, opts *taskOpts, logger zerolog.Logger) zerolog.Lo
 		taskType = "block_ticker"
 	}
 
-	return logOpts.Str("task.type", taskType).Logger()
+	return logOpts.Str("task_type", taskType).Logger()
 }
 
 func newTickable(task *Task, opts *taskOpts) tickable {

pkg/scheduler/scheduler_test.go

@@ -40,8 +40,8 @@ func TestScheduler(t *testing.T) {
 		assert.Equal(t, int32(2), counter)
 
 		// Check logs
-		assert.Contains(t, ts.logger.String(), "Stopped scheduler task")
-		assert.Contains(t, ts.logger.String(), `"task.group":"default"`)
+		assert.Contains(t, ts.logger.String(), "stopped scheduler task")
+		assert.Contains(t, ts.logger.String(), `"task_group":"default"`)
 	})
 
 	t.Run("More opts", func(t *testing.T) {
@@ -79,7 +79,7 @@ func TestScheduler(t *testing.T) {
 		assert.Equal(t, int32(4), counter)
 
 		// Also check that log fields are present
-		assert.Contains(t, ts.logger.String(), `"task.name":"counter-inc","task.group":"my-custom-group"`)
+		assert.Contains(t, ts.logger.String(), `"task_name":"counter-inc","task_group":"my-custom-group"`)
 		assert.Contains(t, ts.logger.String(), `"blockchain":"doge","validators":["alice","bob"]`)
 	})
 
@@ -222,7 +222,7 @@ func TestScheduler(t *testing.T) {
 
 		// ASSERT #1
 		shutdownLogPattern := func(group, name string) string {
-			const pattern = `"task\.name":"%s","task\.group":"%s",.*"message":"Stopped scheduler task"`
+			const pattern = `"task_name":"%s","task_group":"%s",.*"message":"stopped scheduler task"`
 			return fmt.Sprintf(pattern, name, group)
 		}
 
@@ -272,8 +272,8 @@ func TestScheduler(t *testing.T) {
 
 		// ASSERT
 		assert.Equal(t, int64(21), counter)
-		assert.Contains(t, ts.logger.String(), "Stopped scheduler task")
-		assert.Contains(t, ts.logger.String(), `"task.type":"block_ticker"`)
+		assert.Contains(t, ts.logger.String(), "stopped scheduler task")
+		assert.Contains(t, ts.logger.String(), `"task_type":"block_ticker"`)
 	})
 
 	t.Run("Block tick: tick is slower than the block", func(t *testing.T) {

pkg/ticker/ticker.go

@@ -67,7 +67,7 @@ type Opt func(*Ticker)
 // WithLogger sets the logger for the Ticker.
 func WithLogger(log zerolog.Logger, name string) Opt {
 	return func(t *Ticker) {
-		t.logger = log.With().Str("ticker.name", name).Logger()
+		t.logger = log.With().Str("ticker_name", name).Logger()
 	}
 }
 

pkg/ticker/ticker_test.go

@@ -351,6 +351,6 @@ func TestTicker(t *testing.T) {
 
 		// ARRANGE
 		require.ErrorContains(t, err, "hey")
-		require.Contains(t, out.String(), `{"level":"info","ticker.name":"my-task","message":"Ticker stopped"}`)
+		require.Contains(t, out.String(), `{"level":"info","ticker_name":"my-task","message":"Ticker stopped"}`)
 	})
 }

zetaclient/chains/base/logger.go

@@ -39,12 +39,6 @@ type ObserverLogger struct {
 	// the logger for outbound transactions
 	Outbound zerolog.Logger
 
-	// the logger for the chain's gas price
-	GasPrice zerolog.Logger
-
-	// the logger for block headers
-	Headers zerolog.Logger
-
 	// the logger for the compliance check
 	Compliance zerolog.Logger
 }
@@ -60,7 +54,7 @@ func NewLogger(cfg config.Config) (Logger, error) {
 	augmentLogger := func(logger zerolog.Logger) zerolog.Logger {
 		level := zerolog.Level(cfg.LogLevel)
 
-		return logger.Level(level).With().Timestamp().Logger()
+		return logger.Level(level).With().Timestamp().Caller().Logger()
 	}
 
 	// create loggers based on configured level and format

zetaclient/chains/base/observer.go

@@ -280,7 +280,7 @@ func (ob *Observer) StopChannel() chan struct{} {
 // LoadLastBlockScanned loads last scanned block from environment variable or from database.
 // The last scanned block is the height from which the observer should continue scanning.
 func (ob *Observer) LoadLastBlockScanned() error {
-	logger := ob.logger.Chain.With().Str(logs.FieldMethod, "LoadLastBlockScanned").Logger()
+	logger := ob.logger.Chain
 
 	// get environment variable
 	envvar := EnvVarLatestBlockByChain(ob.chain)
@@ -338,7 +338,7 @@ func (ob *Observer) ReadLastBlockScannedFromDB() (uint64, error) {
 // LoadLastTxScanned loads last scanned tx from environment variable or from database.
 // The last scanned tx is the tx hash from which the observer should continue scanning.
 func (ob *Observer) LoadLastTxScanned() {
-	logger := ob.logger.Chain.With().Str(logs.FieldMethod, "LoadLastTxScanned").Logger()
+	logger := ob.logger.Chain
 
 	// get environment variable
 	envvar := EnvVarLatestTxByChain(ob.chain)
@@ -404,10 +404,9 @@ func (ob *Observer) PostVoteInbound(
 	)
 
 	logger := ob.logger.Inbound.With().
-		Str(logs.FieldMethod, "PostVoteInbound").
 		Str(logs.FieldTx, txHash).
 		Stringer(logs.FieldCoinType, coinType).
-		Stringer(logs.FieldConfirmationMode, msg.ConfirmationMode).
+		Stringer("confirmation_mode", msg.ConfirmationMode).
 		Logger()
 
 	cctxIndex := msg.Digest()
@@ -439,7 +438,7 @@ func (ob *Observer) PostVoteInbound(
 
 	logger = logger.With().
 		Str(logs.FieldZetaTx, zetaHash).
-		Str(logs.FieldBallot, ballot).
+		Str(logs.FieldBallotIndex, ballot).
 		Logger()
 
 	switch {
@@ -469,7 +468,7 @@ func newObserverLogger(chain chains.Chain, logger Logger) ObserverLogger {
 	withLogFields := func(l zerolog.Logger) zerolog.Logger {
 		return l.With().
 			Int64(logs.FieldChain, chain.ChainId).
-			Str(logs.FieldChainNetwork, chain.Network.String()).
+			Stringer(logs.FieldNetwork, chain.Network).
 			Logger()
 	}
 
@@ -480,8 +479,6 @@ func newObserverLogger(chain chains.Chain, logger Logger) ObserverLogger {
 		Chain:      log,
 		Inbound:    log.With().Str(logs.FieldModule, logs.ModNameInbound).Logger(),
 		Outbound:   log.With().Str(logs.FieldModule, logs.ModNameOutbound).Logger(),
-		GasPrice:   log.With().Str(logs.FieldModule, logs.ModNameGasPrice).Logger(),
-		Headers:    log.With().Str(logs.FieldModule, logs.ModNameHeaders).Logger(),
 		Compliance: complianceLog,
 	}
 }

zetaclient/chains/base/observer_test.go

@@ -214,8 +214,6 @@ func TestObserverGetterAndSetter(t *testing.T) {
 		logger.Chain.Info().Msg("print chain log")
 		logger.Inbound.Info().Msg("print inbound log")
 		logger.Outbound.Info().Msg("print outbound log")
-		logger.GasPrice.Info().Msg("print gasprice log")
-		logger.Headers.Info().Msg("print headers log")
 		logger.Compliance.Info().Msg("print compliance log")
 	})
 }

zetaclient/chains/base/signer.go

@@ -40,8 +40,8 @@ type Signer struct {
 func NewSigner(chain chains.Chain, tss interfaces.TSSSigner, logger Logger) *Signer {
 	withLogFields := func(log zerolog.Logger) zerolog.Logger {
 		return log.With().
+			Str(logs.FieldModule, logs.ModNameSigner).
 			Int64(logs.FieldChain, chain.ChainId).
-			Str(logs.FieldModule, "signer").
 			Logger()
 	}