MaxBreadcrumbs setting & fix README (#33)

* Support logger name. Update dependencies * Rename NameKey to LoggerNameKey. Add docs * Reorder config fields * Add indirect dependencies required since Go 1.17 * Fix breadcrumbs usage instruction * Fix breadcrumbs usage instruction * Fix breadcrumbs usage instruction * Fix breadcrumbs usage instruction * Fix breadcrumbs usage instruction * Add MaxBreadcrumbs setting Co-authored-by: Maxim Shipko <[email protected]>
TheZeroSlave · Oct 26, 2022 · 6cab783 · 6cab783
1 parent 1159232
commit 6cab783
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -15,14 +15,16 @@ func modifyToSentryLogger(log *zap.Logger, client *sentry.Client) *zap.Logger {
 	}
 	core, err := zapsentry.NewCore(cfg, zapsentry.NewSentryClientFromClient(client))
 
-	// to use breadcrumbs feature - create new scope explicitly
-	log = log.With(zapsentry.NewScope())
-
 	//in case of err it will return noop core. so we can safely attach it
 	if err != nil {
 		log.Warn("failed to init zap", zap.Error(err))
 	}
-	return zapsentry.AttachCoreToLogger(core, log)
+
+	log = zapsentry.AttachCoreToLogger(core, log)
+
+	// to use breadcrumbs feature - create new scope explicitly
+	// and attach after attaching the core
+	return log.With(zapsentry.NewScope())
 }
 ```
 

diff --git a/config.go b/config.go
@@ -34,6 +34,11 @@ type Configuration struct {
 	// The field is ignored, if EnableBreadcrumbs is not set.
 	BreadcrumbLevel zapcore.Level
 
+	// MaxBreadcrumbs is the maximum number of breadcrumb events to keep.
+	// Leave it zero or set to negative for a reasonable default value.
+	// The field is ignored, if EnableBreadcrumbs is not set.
+	MaxBreadcrumbs int
+
 	// FlushTimeout is the timeout for flushing events to Sentry.
 	FlushTimeout time.Duration
 

diff --git a/core.go b/core.go
@@ -12,8 +12,8 @@ import (
 )
 
 const (
-	maxBreadcrumbs = 1000
-	maxErrorDepth  = 10
+	defaultMaxBreadcrumbs = 100
+	maxErrorDepth         = 10
 
 	zapSentryScopeKey = "_zapsentry_scope_"
 )
@@ -40,6 +40,10 @@ func NewCore(cfg Configuration, factory SentryClientFactory) (zapcore.Core, erro
 		return zapcore.NewNopCore(), errors.New("breadcrumb level must be lower than or equal to error level")
 	}
 
+	if cfg.MaxBreadcrumbs <= 0 {
+		cfg.MaxBreadcrumbs = defaultMaxBreadcrumbs
+	}
+
 	core := core{
 		client: client,
 		cfg:    &cfg,
@@ -85,7 +89,7 @@ func (c *core) Write(ent zapcore.Entry, fs []zapcore.Field) error {
 			Timestamp: ent.Time,
 		}
 
-		c.sentryScope.AddBreadcrumb(&breadcrumb, maxBreadcrumbs)
+		c.sentryScope.AddBreadcrumb(&breadcrumb, c.cfg.MaxBreadcrumbs)
 	}
 
 	if c.cfg.Level.Enabled(ent.Level) {