「框架」uber/zap 效率为什么碾压其他日志文件?

Zap

uber 公司开源的一套日志系统， 很多成熟的框架（K8s、Caddy、Etcd等）的日志库都是使用它，为什么这么多框架使用它？

从官方给出的性能指标看， 记录一条10个字段的日志，benchmarks 最好的是 Zap，当然，自己给的测评指标，肯定是要突出自己的优势。

指标上看，Zap内存管理的比较好， 5 allocs/op 这个应该是使用了内存池，减少内存分配的消耗和GC的压力。

func getCheckedEntry() *CheckedEntry {
  ce := _cePool.Get().(*CheckedEntry)
  ce.reset()
  return ce
}

每条日志是一个的Entry，可以不断给Entry添加字段，按照buffer的形式，而且buffer也是从内存池拿的。

func (c *ioCore) Write(ent Entry, fields []Field) error {
  buf, err := c.enc.EncodeEntry(ent, fields)
  if err != nil {
    return err
  }
  _, err = c.out.Write(buf.Bytes())
  buf.Free()
  if err != nil {
    return err
  }
  if ent.Level > ErrorLevel {
    // Since we may be crashing the program, sync the output. Ignore Sync
    // errors, pending a clean solution to issue #370.
    c.Sync()
  }
  return nil
}

// Get retrieves a Buffer from the pool, creating one if necessary.
func (p Pool) Get() *Buffer {
  buf := p.p.Get().(*Buffer)
  buf.Reset()
  buf.pool = p
  return buf
}

与zap（suggared）比较

zap用法

logger, _ := zap.NewProduction()
defer logger.Sync() // flushes buffer, if any
sugar := logger.Sugar()
sugar.Infow("failed to fetch URL",
  // Structured context as loosely typed key-value pairs.
  "url", url,
  "attempt", 3,
  "backoff", time.Second,
)
sugar.Infof("Failed to fetch URL: %s", url)

zap（suggared）用法

logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("failed to fetch URL",
  // Structured context as strongly typed Field values.
  zap.String("url", url),
  zap.Int("attempt", 3),
  zap.Duration("backoff", time.Second),
)

zap（suggared）用法确实很方便，只管传值就行，不用声明类型；

zap 比zap（suggared）快20%， 看了源码发现主要是多了一个sweetenFields（）的方法

func (s *SugaredLogger) log(lvl zapcore.Level, template string, fmtArgs []interface{}, context []interface{}) {
  // If logging at this level is completely disabled, skip the overhead of
  // string formatting.
  if lvl < DPanicLevel && !s.base.Core().Enabled(lvl) {
    return
  }


  msg := getMessage(template, fmtArgs)
  if ce := s.base.Check(lvl, msg); ce != nil {
    ce.Write(s.sweetenFields(context)...)
  }
}

这个方法是将interface{} 类型转为 Field， 多分配了一些对象。

总结：

1. 使用了很多内存池，减少内存的分配和降低GC的压力
2. 不使用反射，显示声明类型；也可以不显示声明（suggared），但是牺牲一些性能
3. 减少使用interface，减少对interface的拆箱，和内存分配。