Skip to content

Commit

Permalink
fixup: Respond to review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
marun committed Nov 21, 2024
1 parent 63b0ff2 commit caa9980
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 10 deletions.
3 changes: 2 additions & 1 deletion config/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/ava-labs/avalanchego/utils/compression"
"github.com/ava-labs/avalanchego/utils/constants"
"github.com/ava-labs/avalanchego/utils/dynamicip"
"github.com/ava-labs/avalanchego/utils/logging"
"github.com/ava-labs/avalanchego/utils/ulimit"
"github.com/ava-labs/avalanchego/utils/units"
"github.com/ava-labs/avalanchego/vms/components/gas"
Expand Down Expand Up @@ -142,7 +143,7 @@ func addNodeFlags(fs *pflag.FlagSet) {
fs.String(LogsDirKey, defaultLogDir, "Logging directory for Avalanche")
fs.String(LogLevelKey, "info", "The log level. Should be one of {verbo, debug, trace, info, warn, error, fatal, off}")
fs.String(LogDisplayLevelKey, "", "The log display level. If left blank, will inherit the value of log-level. Otherwise, should be one of {verbo, debug, trace, info, warn, error, fatal, off}")
fs.String(LogFormatKey, "auto", "The structure of log format. Defaults to 'auto' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {auto, plain, colors, json}")
fs.String(LogFormatKey, logging.FormatModeAuto, fmt.Sprintf("The structure of log format. Defaults to '%s' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {%s, plain, colors, json}", logging.FormatModeAuto, logging.FormatModeAuto))
fs.Uint(LogRotaterMaxSizeKey, 8, "The maximum file size in megabytes of the log file before it gets rotated.")
fs.Uint(LogRotaterMaxFilesKey, 7, "The maximum number of old log files to retain. 0 means retain all old log files.")
fs.Uint(LogRotaterMaxAgeKey, 0, "The maximum number of days to retain old log files based on the timestamp encoded in their filename. 0 means retain all old log files.")
Expand Down
3 changes: 3 additions & 0 deletions tests/antithesis/avalanchego/gencomposeconfig/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
package main

import (
"os"

"go.uber.org/zap"

"github.com/ava-labs/avalanchego/tests"
Expand All @@ -20,5 +22,6 @@ func main() {
tests.NewDefaultLogger("").Fatal("failed to generate compose config",
zap.Error(err),
)
os.Exit(1)
}
}
3 changes: 3 additions & 0 deletions tests/antithesis/xsvm/gencomposeconfig/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
package main

import (
"os"

"go.uber.org/zap"

"github.com/ava-labs/avalanchego/genesis"
Expand All @@ -25,5 +27,6 @@ func main() {
tests.NewDefaultLogger("").Fatal("failed to generate compose config",
zap.Error(err),
)
os.Exit(1)
}
}
7 changes: 2 additions & 5 deletions tests/e2e/etna/suites.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,10 @@ var _ = ginkgo.Describe("[Etna]", func() {
require.NoError(err)

now := time.Now()
msg := "etna is activated"
if !upgrades.IsEtnaActivated(now) {
msg = "etna is not activated"
}
tc.Log().Info(msg,
tc.Log().Info("detected if Etna is activated",
zap.Time("now", now),
zap.Time("etnaTime", upgrades.EtnaTime),
zap.Bool("isEtnaActivated", upgrades.IsEtnaActivated(now)),
)
})
})
2 changes: 1 addition & 1 deletion tests/fixture/bootstrapmonitor/cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func main() {
rootCmd.PersistentFlags().StringVar(&podName, "pod-name", os.Getenv("POD_NAME"), "The name of the pod")
rootCmd.PersistentFlags().StringVar(&nodeContainerName, "node-container-name", "", "The name of the node container in the pod")
rootCmd.PersistentFlags().StringVar(&dataDir, "data-dir", "", "The path of the data directory used for the bootstrap job")
rootCmd.PersistentFlags().StringVar(&rawLogFormat, "log-format", "auto", "The structure of log format. Defaults to 'auto' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {auto, plain, colors, json}")
rootCmd.PersistentFlags().StringVar(&rawLogFormat, "log-format", logging.FormatModeAuto, fmt.Sprintf("The structure of log format. Defaults to '%s' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {%s, plain, colors, json}", logging.FormatModeAuto, logging.FormatModeAuto))

versionCmd := &cobra.Command{
Use: "version",
Expand Down
3 changes: 2 additions & 1 deletion tests/fixture/tmpnet/cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (

"github.com/ava-labs/avalanchego/tests"
"github.com/ava-labs/avalanchego/tests/fixture/tmpnet"
"github.com/ava-labs/avalanchego/utils/logging"
"github.com/ava-labs/avalanchego/version"
)

Expand All @@ -37,7 +38,7 @@ func main() {
Short: "tmpnetctl commands",
}
rootCmd.PersistentFlags().StringVar(&networkDir, "network-dir", os.Getenv(tmpnet.NetworkDirEnvName), "The path to the configuration directory of a temporary network")
rootCmd.PersistentFlags().StringVar(&rawLogFormat, "log-format", "auto", "The structure of log format. Defaults to 'auto' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {auto, plain, colors, json}")
rootCmd.PersistentFlags().StringVar(&rawLogFormat, "log-format", logging.FormatModeAuto, fmt.Sprintf("The structure of log format. Defaults to '%s' which formats terminal-like logs, when the output is a terminal. Otherwise, should be one of {%s, plain, colors, json}", logging.FormatModeAuto, logging.FormatModeAuto))

versionCmd := &cobra.Command{
Use: "version",
Expand Down
2 changes: 1 addition & 1 deletion tests/log.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func NewSimpleLogger(writeCloser io.WriteCloser) logging.Logger {
}

func NewDefaultLogger(prefix string) logging.Logger {
log, err := LoggerForFormat(prefix, "auto")
log, err := LoggerForFormat(prefix, logging.FormatModeAuto)
if err != nil {
// This should never happen since auto is a valid log format
panic(err)
Expand Down
4 changes: 3 additions & 1 deletion utils/logging/format.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ const (
Colors
JSON

FormatModeAuto = "auto"

termTimeFormat = "[01-02|15:04:05.000]"
)

Expand Down Expand Up @@ -58,7 +60,7 @@ func ToFormat(h string, fd uintptr) (Format, error) {
return Colors, nil
case "JSON":
return JSON, nil
case "AUTO":
case strings.ToUpper(FormatModeAuto):
if !term.IsTerminal(int(fd)) {
return Plain, nil
}
Expand Down

0 comments on commit caa9980

Please sign in to comment.