asynczap

Documentation

Overview

Package asynczap implements asynchronous core for zap.

By default, zap writes every log line synchronously and without buffering. This behaviour is completely inadequate for high-rate logging.

This implementation of zap.Core moves file write to background goroutine, while carefully monitoring memory consumption.

When background goroutine can't keep up with logging rate, log records are dropped.

Index

• type Core
  • func NewCore(enc zapcore.Encoder, ws zapcore.WriteSyncer, enab zapcore.LevelEnabler, ...) *Core
  • func (c *Core) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (c *Core) Stat() Stats
  • func (c *Core) Stop()
  • func (c *Core) Sync() error
  • func (c *Core) With(fields []zap.Field) zapcore.Core
  • func (c *Core) Write(ent zapcore.Entry, fields []zap.Field) error
• type Options
• type Stats

Types

type Core

type Core struct {
	zapcore.LevelEnabler
	// contains filtered or unexported fields
}

func NewCore

func NewCore(enc zapcore.Encoder, ws zapcore.WriteSyncer, enab zapcore.LevelEnabler, options Options) *Core

NewCore creates a Core that writes logs to a WriteSyncer.

func (*Core) Check

func (c *Core) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

func (*Core) Stat

func (c *Core) Stat() Stats

func (*Core) Stop

func (c *Core) Stop()

func (*Core) Sync

func (c *Core) Sync() error

func (*Core) With

func (c *Core) With(fields []zap.Field) zapcore.Core

func (*Core) Write

func (c *Core) Write(ent zapcore.Entry, fields []zap.Field) error

type Options

type Options struct {
	// MaxMemoryUsage is maximum amount of memory that will be used by in-flight log records.
	MaxMemoryUsage int

	// WriteBufferSize specifies size of the buffer used for writes to underlying file.
	WriteBufferSize int

	// FlushInterval specifies how often background goroutine would wake up.
	FlushInterval time.Duration
}

type Stats

type Stats struct {
	// Number of records dropped during memory overflow.
	DroppedRecords int

	// Number of errors returned from underlying writer.
	WriteErrors int
}