Options to control logging.

ratelimit/ratelimit.go

@@ -34,6 +34,12 @@ type Options struct {
 
  // GroupcacheSizeBytes limits the cache size. If unspecified, defaults to 10MB.
  GroupcacheSizeBytes int64
+
+ // Logf provides logging function, if undefined defaults to log.Printf
+ Logf func(format string, v ...any)
+
+ // Debug enables debug logging.
+ Debug bool
 }
 
 // Limiter implements rate limiting.
@@ -57,6 +63,10 @@ func New(options Options) *Limiter {
  panic("groupcache workspace is nil")
  }
 
+ if options.Logf == nil {
+ options.Logf = log.Printf
+ }
+
  lim := Limiter{
  options: options,
  }
@@ -86,7 +96,8 @@ func New(options Options) *Limiter {
  return dest.SetBytes(data, count.Expire)
  })
 
- lim.group = groupcache.NewGroupWithWorkspace(options.GroupcacheWorkspace, cacheName, cacheSizeBytes, getter)
+ lim.group = groupcache.NewGroupWithWorkspace(options.GroupcacheWorkspace,
+ cacheName, cacheSizeBytes, getter)
 
  return &lim
 }
@@ -122,7 +133,7 @@ func (l *Limiter) Consume(ctx context.Context, key string) (bool, error) {
 
  // 1/2: remove key
  if errRemove := l.group.Remove(ctx, key); errRemove != nil {
- log.Printf("ratelimit.Consume: remove key='%s' error: %v",
+ l.options.Logf("ERROR: ratelimit.Consume: remove key='%s' error: %v",
  key, errRemove)
  }
 
@@ -146,8 +157,10 @@ func (l *Limiter) Consume(ctx context.Context, key string) (bool, error) {
 
  accept := !expired && count.Value <= l.options.Slots
 
- log.Printf("ratelimit.Consume: key='%s' count=%d/%d interval=%v/%v expired=%t accept=%t",
- key, count.Value, l.options.Slots, remain, l.options.Interval, expired, accept)
+ if l.options.Debug {
+ l.options.Logf("DEBUG: ratelimit.Consume: key='%s' count=%d/%d interval=%v/%v expired=%t accept=%t",
+ key, count.Value, l.options.Slots, remain, l.options.Interval, expired, accept)
+ }
 
  return accept, nil
 }