backport: catch up the changes from v0.11 to v0.12 (#636)

chore: backport the changes from v0.11-dev to v0.12-dev

Author: shotonoff

CHANGELOG.md

@@ -5783,7 +5783,7 @@
 - Only run when applicable (#4752)
 - Check git diff on each job (#4770)
 - Checkout code before git diff check (#4779)
-- Add paths 
+- Add paths
 - Bump the timeout for test_coverage (#4864)
 - Migrate localnet to github actions (#4878)
 - Add timeouts (#4912)
@@ -6066,7 +6066,7 @@
 
 ### Swagger
 
-- Remove duplicate blockID 
+- Remove duplicate blockID
 - Define version (#4952)
 
 ### Template

cmd/tenderdash/main.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"context"
+	"fmt"
+	"io"
 	"os"
 
 	"github.com/tendermint/tendermint/cmd/tenderdash/commands"
@@ -21,10 +23,11 @@ func main() {
 		panic(err)
 	}
 
-	logger, err := log.NewDefaultLogger(conf.LogFormat, conf.LogLevel)
+	logger, stopFn, err := newLoggerFromConfig(conf)
 	if err != nil {
 		panic(err)
 	}
+	defer stopFn()
 
 	rcmd := commands.RootCommand(conf, logger)
 	rcmd.AddCommand(
@@ -64,3 +67,30 @@ func main() {
 		os.Exit(2)
 	}
 }
+
+func newLoggerFromConfig(conf *config.Config) (log.Logger, func(), error) {
+	var (
+		writer    io.Writer = os.Stderr
+		closeFunc           = func() {}
+		err       error
+	)
+	if conf.LogFilePath != "" {
+		file, err := os.OpenFile(conf.LogFilePath, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
+		if err != nil {
+			return nil, nil, fmt.Errorf("failed to create log writer: %w", err)
+		}
+		closeFunc = func() {
+			_ = file.Close()
+		}
+		writer = io.MultiWriter(writer, file)
+	}
+	writer, err = log.NewFormatter(conf.LogFormat, writer)
+	if err != nil {
+		return nil, nil, fmt.Errorf("failed to create log formatter: %w", err)
+	}
+	logger, err := log.NewLogger(conf.LogLevel, writer)
+	if err != nil {
+		return nil, nil, err
+	}
+	return logger, closeFunc, nil
+}

config/config.go

@@ -214,6 +214,9 @@ type BaseConfig struct { //nolint: maligned
 	// Output format: 'plain' (colored text) or 'json'
 	LogFormat string `mapstructure:"log-format"`
 
+	// Path to the log file. This parameter is an additional option to the existing stderr output
+	LogFilePath string `mapstructure:"log-file-path"`
+
 	// Path to the JSON file containing the initial validator set and other meta data
 	Genesis string `mapstructure:"genesis-file"`
 

config/toml.go

@@ -135,6 +135,9 @@ log-level = "{{ .BaseConfig.LogLevel }}"
 # Output format: 'plain' (colored text) or 'json'
 log-format = "{{ .BaseConfig.LogFormat }}"
 
+# Path to the log file. This parameter is an additional option to the existing stderr output
+log-file-path = "{{ .BaseConfig.LogFilePath }}"
+
 ##### additional base config options #####
 
 # Path to the JSON file containing the initial validator set and other meta data
@@ -468,7 +471,7 @@ fetchers = "{{ .StateSync.Fetchers }}"
 [consensus]
 
 wal-file = "{{ js .Consensus.WalPath }}"
-# wal-skip-rounds-to-last set to true will skip replaying all non-committed rounds stored in 
+# wal-skip-rounds-to-last set to true will skip replaying all non-committed rounds stored in
 # WAL, increasing performance in a significant way. It should be set to false by default, as it
 # can have security side-effects.
 wal-skip-rounds-to-last = "{{ .Consensus.WalSkipRoundsToLast }}"

libs/log/default.go

@@ -104,6 +104,27 @@ func OverrideWithNewLogger(logger Logger, format, level string) error {
 	return nil
 }
 
+// NewFormatter creates a new formatter for the given format. If the format is empty or unsupported then returns error.
+func NewFormatter(format string, w io.Writer) (io.Writer, error) {
+	switch strings.ToLower(format) {
+	case LogFormatPlain, LogFormatText:
+		return zerolog.ConsoleWriter{
+			Out:        w,
+			NoColor:    true,
+			TimeFormat: time.RFC3339Nano,
+			FormatLevel: func(i interface{}) string {
+				if ll, ok := i.(string); ok {
+					return strings.ToUpper(ll)
+				}
+				return "????"
+			},
+		}, nil
+	case LogFormatJSON:
+		return w, nil
+	}
+	return nil, fmt.Errorf("unsupported log format: %s", format)
+}
+
 func getLogFields(keyVals ...interface{}) map[string]interface{} {
 	if len(keyVals)%2 != 0 {
 		return nil