root: allow disabling log file

Author: guggero

cmd/chantools/root.go

@@ -47,15 +47,13 @@ const (
 )
 
 var (
-	Testnet bool
-	Regtest bool
-	Signet  bool
+	Testnet   bool
+	Regtest   bool
+	Signet    bool
+	NoLogFile bool
+
+	log btclog.Logger
 
-	logWriter = build.NewRotatingLogWriter()
-	subLogMgr = build.NewSubLoggerManager(build.NewDefaultLogHandlers(
-		build.DefaultLogConfig(), logWriter,
-	)...)
-	log         = build.NewSubLogger("CHAN", genSubLogger(subLogMgr))
 	chainParams = &chaincfg.MainNetParams
 )
 
@@ -103,6 +101,11 @@ func main() {
 		&Signet, "signet", "s", false, "Indicates if the public "+
 			"signet parameters should be used",
 	)
+	rootCmd.PersistentFlags().BoolVar(
+		&NoLogFile, "nologfile", false, "If set, no log file "+
+			"will be created. This is useful for testing purposes "+
+			"where we don't want to create a log file.",
+	)
 
 	rootCmd.AddCommand(
 		newChanBackupCommand(),
@@ -328,28 +331,34 @@ func readInput(input string) ([]byte, error) {
 }
 
 func setupLogging() {
-	setSubLogger("CHAN", log)
-	addSubLogger("CHDB", channeldb.UseLogger)
-	addSubLogger("BCKP", chanbackup.UseLogger)
-	addSubLogger("PEER", peer.UseLogger)
-
-	err := logWriter.InitLogRotator(
-		&build.FileLoggerConfig{
-			Compressor:     build.Gzip,
-			MaxLogFiles:    3,
-			MaxLogFileSize: 10,
-		},
-		"./results/chantools.log",
-	)
-	if err != nil {
-		panic(err)
-	}
-
+	logWriter := build.NewRotatingLogWriter()
 	subLogMgr := build.NewSubLoggerManager(build.NewDefaultLogHandlers(
 		build.DefaultLogConfig(), logWriter,
 	)...)
 
-	err = build.ParseAndSetDebugLevels("debug", subLogMgr)
+	log = build.NewSubLogger("CHAN", genSubLogger(subLogMgr))
+	log.SetLevel(btclog.LevelDebug)
+
+	setSubLogger(subLogMgr, "CHAN", log)
+	addSubLogger(subLogMgr, "CHDB", channeldb.UseLogger)
+	addSubLogger(subLogMgr, "BCKP", chanbackup.UseLogger)
+	addSubLogger(subLogMgr, "PEER", peer.UseLogger)
+
+	if !NoLogFile {
+		err := logWriter.InitLogRotator(
+			&build.FileLoggerConfig{
+				Compressor:     build.Gzip,
+				MaxLogFiles:    3,
+				MaxLogFileSize: 10,
+			},
+			"./results/chantools.log",
+		)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	err := build.ParseAndSetDebugLevels("debug", subLogMgr)
 	if err != nil {
 		panic(err)
 	}
@@ -364,17 +373,19 @@ func genSubLogger(mgr *build.SubLoggerManager) func(string) btclog.Logger {
 
 // addSubLogger is a helper method to conveniently create and register the
 // logger of one or more sub systems.
-func addSubLogger(subsystem string, useLoggers ...func(btclog.Logger)) {
+func addSubLogger(subLogMgr *build.SubLoggerManager, subsystem string,
+	useLoggers ...func(btclog.Logger)) {
+
 	// Create and register just a single logger to prevent them from
 	// overwriting each other internally.
 	logger := build.NewSubLogger(subsystem, genSubLogger(subLogMgr))
-	setSubLogger(subsystem, logger, useLoggers...)
+	setSubLogger(subLogMgr, subsystem, logger, useLoggers...)
 }
 
 // setSubLogger is a helper method to conveniently register the logger of a sub
 // system.
-func setSubLogger(subsystem string, logger btclog.Logger,
-	useLoggers ...func(btclog.Logger)) {
+func setSubLogger(subLogMgr *build.SubLoggerManager, subsystem string,
+	logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
 
 	subLogMgr.RegisterSubLogger(subsystem, logger)
 	for _, useLogger := range useLoggers {

doc/chantools.md

@@ -12,10 +12,11 @@ https://github.com/lightninglabs/chantools/.
 ### Options
 
 ```
-  -h, --help      help for chantools
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+  -h, --help        help for chantools
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_chanbackup.md

@@ -33,9 +33,10 @@ chantools chanbackup \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_closepoolaccount.md

@@ -48,9 +48,10 @@ chantools closepoolaccount \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_compactdb.md

@@ -31,9 +31,10 @@ chantools compactdb \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_createwallet.md

@@ -33,9 +33,10 @@ chantools createwallet \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_deletepayments.md

@@ -34,9 +34,10 @@ chantools deletepayments --failedonly \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_doublespendinputs.md

@@ -40,9 +40,10 @@ chantools doublespendinputs \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_dropchannelgraph.md

@@ -44,9 +44,10 @@ chantools dropchannelgraph \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_dropgraphzombies.md

@@ -35,9 +35,10 @@ chantools dropgraphzombies \
 ### Options inherited from parent commands
 
 ```
-  -r, --regtest   Indicates if regtest parameters should be used
-  -s, --signet    Indicates if the public signet parameters should be used
-  -t, --testnet   Indicates if testnet parameters should be used
+      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest     Indicates if regtest parameters should be used
+  -s, --signet      Indicates if the public signet parameters should be used
+  -t, --testnet     Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO