Allow per-subsystem log levels to be specified.
Now that each subsystem is capable of having its own log level, modify the -d/--debuglevel flag to allow them to be specified. Closes #48.
This commit is contained in:
parent
eb8688df79
commit
48ab97c271
2 changed files with 76 additions and 10 deletions
5
btcd.go
5
btcd.go
|
@ -32,11 +32,6 @@ func btcdMain() error {
|
||||||
}
|
}
|
||||||
cfg = tcfg
|
cfg = tcfg
|
||||||
|
|
||||||
// Change the logging level if needed.
|
|
||||||
if cfg.DebugLevel != defaultLogLevel {
|
|
||||||
setLogLevels(cfg.DebugLevel)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Show version at startup.
|
// Show version at startup.
|
||||||
btcdLog.Infof("Version %s", version())
|
btcdLog.Infof("Version %s", version())
|
||||||
|
|
||||||
|
|
81
config.go
81
config.go
|
@ -14,6 +14,7 @@ import (
|
||||||
"net"
|
"net"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
@ -70,7 +71,7 @@ type config struct {
|
||||||
DbType string `long:"dbtype" description:"Database backend to use for the Block Chain"`
|
DbType string `long:"dbtype" description:"Database backend to use for the Block Chain"`
|
||||||
Profile string `long:"profile" description:"Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536"`
|
Profile string `long:"profile" description:"Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536"`
|
||||||
CpuProfile string `long:"cpuprofile" description:"Write CPU profile to the specified file"`
|
CpuProfile string `long:"cpuprofile" description:"Write CPU profile to the specified file"`
|
||||||
DebugLevel string `short:"d" long:"debuglevel" description:"Logging level {trace, debug, info, warn, error, critical}"`
|
DebugLevel string `short:"d" long:"debuglevel" description:"Logging level for all subsystems {trace, debug, info, warn, error, critical} -- You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set the log level for individual subsystems -- Use show to list available subsystems"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// cleanAndExpandPath expands environement variables and leading ~ in the
|
// cleanAndExpandPath expands environement variables and leading ~ in the
|
||||||
|
@ -106,6 +107,77 @@ func validLogLevel(logLevel string) bool {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// supportedSubsystems returns a sorted slice of the supported subsystems for
|
||||||
|
// logging purposes.
|
||||||
|
func supportedSubsystems() []string {
|
||||||
|
// Convert the subsystemLoggers map keys to a slice.
|
||||||
|
subsystems := make([]string, 0, len(subsystemLoggers))
|
||||||
|
for subsysID := range subsystemLoggers {
|
||||||
|
subsystems = append(subsystems, subsysID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sort the subsytems for stable display.
|
||||||
|
sort.Strings(subsystems)
|
||||||
|
return subsystems
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseDebugLevel attempt to parse the specified debug level and set the levels
|
||||||
|
// accordingly. An appropriate error is returned if anything is invalid.
|
||||||
|
func parseDebugLevel(debugLevel string) error {
|
||||||
|
// Special show command to list supported subsystems.
|
||||||
|
if debugLevel == "show" {
|
||||||
|
fmt.Println("Supported subsystems", supportedSubsystems())
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// When the specified string doesn't have any delimters, treat it as
|
||||||
|
// the log level for all subsystems.
|
||||||
|
if !strings.Contains(debugLevel, ",") && !strings.Contains(debugLevel, "=") {
|
||||||
|
// Validate debug log level.
|
||||||
|
if !validLogLevel(debugLevel) {
|
||||||
|
str := "The specified debug level [%v] is invalid"
|
||||||
|
return fmt.Errorf(str, debugLevel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Change the logging level for all subsystems if needed.
|
||||||
|
if debugLevel != defaultLogLevel {
|
||||||
|
setLogLevels(debugLevel)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split the specified string into subsystem/level pairs while detecting
|
||||||
|
// issues and update the log levels accordingly.
|
||||||
|
for _, logLevelPair := range strings.Split(debugLevel, ",") {
|
||||||
|
if !strings.Contains(logLevelPair, "=") {
|
||||||
|
str := "The specified debug level contains an invalid " +
|
||||||
|
"subsystem/level pair [%v]"
|
||||||
|
return fmt.Errorf(str, logLevelPair)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Extract the specified subsystem and log level.
|
||||||
|
fields := strings.Split(logLevelPair, "=")
|
||||||
|
subsysID, logLevel := fields[0], fields[1]
|
||||||
|
|
||||||
|
// Validate subsystem.
|
||||||
|
if _, exists := subsystemLoggers[subsysID]; !exists {
|
||||||
|
str := "The specified subsystem [%v] is invalid"
|
||||||
|
return fmt.Errorf(str, subsysID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate log level.
|
||||||
|
if !validLogLevel(logLevel) {
|
||||||
|
str := "The specified debug level [%v] is invalid"
|
||||||
|
return fmt.Errorf(str, logLevel)
|
||||||
|
}
|
||||||
|
|
||||||
|
setLogLevel(subsysID, logLevel)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// validDbType returns whether or not dbType is a supported database type.
|
// validDbType returns whether or not dbType is a supported database type.
|
||||||
func validDbType(dbType string) bool {
|
func validDbType(dbType string) bool {
|
||||||
for _, knownType := range knownDbTypes {
|
for _, knownType := range knownDbTypes {
|
||||||
|
@ -254,10 +326,9 @@ func loadConfig() (*config, []string, error) {
|
||||||
activeNetParams = netParams(btcwire.TestNet)
|
activeNetParams = netParams(btcwire.TestNet)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate debug log level.
|
// Parse, validate, and set debug log level(s).
|
||||||
if !validLogLevel(cfg.DebugLevel) {
|
if err := parseDebugLevel(cfg.DebugLevel); err != nil {
|
||||||
str := "%s: The specified debug level [%v] is invalid"
|
err := fmt.Errorf("%s: %v", "loadConfig", err.Error())
|
||||||
err := fmt.Errorf(str, "loadConfig", cfg.DebugLevel)
|
|
||||||
fmt.Fprintln(os.Stderr, err)
|
fmt.Fprintln(os.Stderr, err)
|
||||||
parser.WriteHelp(os.Stderr)
|
parser.WriteHelp(os.Stderr)
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
|
|
Loading…
Add table
Reference in a new issue