add command line option to log full error

Author: dennis-tra

cmd/nebula/cmd.go

@@ -33,6 +33,7 @@ var rootConfig = &config.Root{
 	LogLevel:        4,
 	LogFormat:       "text",
 	LogDisableColor: false,
+	LogErrors:       false,
 	DialTimeout:     10 * time.Second,
 	MetricsHost:     "0.0.0.0",
 	MetricsPort:     6666,
@@ -99,6 +100,14 @@ func main() {
 				Destination: &rootConfig.LogDisableColor,
 				Category:    flagCategoryDebugging,
 			},
+			&cli.BoolFlag{
+				Name:        "log-errors",
+				Usage:       "Whether to log the full errors",
+				EnvVars:     []string{"NEBULA_LOG_ERRORS"},
+				Value:       rootConfig.LogErrors,
+				Destination: &rootConfig.LogErrors,
+				Category:    flagCategoryDebugging,
+			},
 			&cli.DurationFlag{
 				Name:        "dial-timeout",
 				Usage:       "Global timeout when trying to connect to or dial another peer in the network.",

cmd/nebula/cmd_crawl.go

@@ -246,6 +246,7 @@ func CrawlAction(c *cli.Context) error {
 			KeepENR:           crawlConfig.KeepENR,
 			TracerProvider:    cfg.Root.TracerProvider,
 			MeterProvider:     cfg.Root.MeterProvider,
+			LogErrors:         cfg.Root.LogErrors,
 		}
 
 		// init the crawl driver
@@ -287,6 +288,7 @@ func CrawlAction(c *cli.Context) error {
 			AddrTrackType:     cfg.AddrTrackType(),
 			TracerProvider:    cfg.Root.TracerProvider,
 			MeterProvider:     cfg.Root.MeterProvider,
+			LogErrors:         cfg.Root.LogErrors,
 		}
 
 		// init the crawl driver

config/config.go

@@ -71,6 +71,9 @@ type Root struct {
 	// Specify the log format (text or json)
 	LogFormat string
 
+	// Whether to log the full error string
+	LogErrors bool
+
 	// Whether to have colorized log output
 	LogDisableColor bool
 

core/handler_crawl.go

@@ -59,6 +59,9 @@ type CrawlResult[I PeerInfo[I]] struct {
 
 	// Additional properties of that specific peer we have crawled
 	Properties json.RawMessage
+
+	// Debug flag that indicates whether to log the full error string
+	LogErrors bool
 }
 
 func (r CrawlResult[I]) PeerInfo() I {
@@ -74,17 +77,16 @@ func (r CrawlResult[I]) LogEntry() *log.Entry {
 	})
 
 	if r.ConnectError != nil {
-		if r.ConnectErrorStr == models.NetErrorUnknown {
-			logEntry = logEntry.WithError(r.ConnectError)
+		if r.LogErrors || r.ConnectErrorStr == models.NetErrorUnknown {
+			logEntry = logEntry.WithField("connErr", r.ConnectError)
 		} else {
 			logEntry = logEntry.WithField("connErr", r.ConnectErrorStr)
 		}
 	}
 
 	if r.CrawlError != nil {
-		// Log and count crawl errors
-		if r.CrawlErrorStr == models.NetErrorUnknown {
-			logEntry = logEntry.WithError(r.CrawlError)
+		if r.LogErrors || r.CrawlErrorStr == models.NetErrorUnknown {
+			logEntry = logEntry.WithField("crawlErr", r.CrawlError)
 		} else {
 			logEntry = logEntry.WithField("crawlErr", r.CrawlErrorStr)
 		}

discv5/crawler.go

@@ -28,6 +28,7 @@ type CrawlerConfig struct {
 	DialTimeout  time.Duration
 	AddrDialType config.AddrType
 	KeepENR      bool
+	LogErrors    bool
 }
 
 type Crawler struct {
@@ -75,6 +76,7 @@ func (c *Crawler) Work(ctx context.Context, task PeerInfo) (core.CrawlResult[Pee
 		ConnectStartTime:    libp2pResult.ConnectStartTime,
 		ConnectEndTime:      libp2pResult.ConnectEndTime,
 		Properties:          c.PeerProperties(task.Node),
+		LogErrors:           c.cfg.LogErrors,
 	}
 
 	// We've now crawled this peer, so increment

discv5/driver_crawler.go

@@ -120,13 +120,15 @@ type CrawlDriverConfig struct {
 	KeepENR           bool
 	MeterProvider     metric.MeterProvider
 	TracerProvider    trace.TracerProvider
+	LogErrors         bool
 }
 
 func (cfg *CrawlDriverConfig) CrawlerConfig() *CrawlerConfig {
 	return &CrawlerConfig{
 		DialTimeout:  cfg.DialTimeout,
 		AddrDialType: cfg.AddrDialType,
 		KeepENR:      cfg.KeepENR,
+		LogErrors:    cfg.LogErrors,
 	}
 }
 

libp2p/crawler.go

@@ -22,6 +22,7 @@ type CrawlerConfig struct {
 	DialTimeout    time.Duration
 	CheckExposed   bool
 	AddrDialType   config.AddrType
+	LogErrors      bool
 }
 
 type Crawler struct {
@@ -48,6 +49,7 @@ func (c *Crawler) Work(ctx context.Context, task PeerInfo) (core.CrawlResult[Pee
 		CrawlerID:      c.id,
 		Info:           task,
 		CrawlStartTime: time.Now(),
+		LogErrors:      c.cfg.LogErrors,
 	}
 
 	// adhere to the addr-dial-type command line flag and only work with

libp2p/driver_crawler.go

@@ -60,6 +60,7 @@ type CrawlDriverConfig struct {
 	AddrDialType      config.AddrType
 	MeterProvider     metric.MeterProvider
 	TracerProvider    trace.TracerProvider
+	LogErrors         bool
 }
 
 func (cfg *CrawlDriverConfig) CrawlerConfig() *CrawlerConfig {
@@ -68,6 +69,7 @@ func (cfg *CrawlDriverConfig) CrawlerConfig() *CrawlerConfig {
 		DialTimeout:    cfg.DialTimeout,
 		CheckExposed:   cfg.CheckExposed,
 		AddrDialType:   cfg.AddrDialType,
+		LogErrors:      cfg.LogErrors,
 	}
 }