lumberjack

Documentation

Index

• Variables
• func NewLumberjack(cfg Config) *xlog.Logger
• type BufferWriter
  • func (w *BufferWriter) Write(p []byte) (n int, err error)
• type Config

Variables

var (
	MinBufSize = 10 * 1024 * 1024 // 10MB
)

Functions

func NewLumberjack

func NewLumberjack(cfg Config) *xlog.Logger

Types

type BufferWriter

type BufferWriter struct {
	// contains filtered or unexported fields
}

func (*BufferWriter) Write

func (w *BufferWriter) Write(p []byte) (n int, err error)

type Config

type Config struct {
	// log level, debug, info, warn, error
	Level string `json:"level" toml:"level" yaml:"level" validate:"required"`

	// Filename is the file to write logs to.  Backup log files will be retained in the same directory.
	// It uses <processname>-lumberjack.log in os.TempDir() if empty.
	Filename string `json:"filename" toml:"filename" yaml:"filename" validate:"required"`

	// MaxSize is the maximum size in megabytes of the log file before it gets rotated. It defaults to 100 megabytes.
	MaxSize int `json:"maxsize" toml:"maxsize" yaml:"maxsize" default:"100"`

	// Async will cache log and flush on need(30s timeout or buffer is full)
	Async bool `json:"async" toml:"async" yaml:"async"`

	// MaxAge is the maximum number of days to retain old log files based on the timestamp encoded in their filename.
	//  Note that a day is defined as 24 hours and may not exactly correspond to calendar days due to daylight savings,
	// leap seconds, etc. The default is not to remove old log files based on age.
	MaxAge int `json:"maxage" toml:"maxage" yaml:"maxage" default:"7"`

	// MaxCount is the maximum number of old log files to retain.  The default is to retain all old log files (though
	// MaxAge may still cause them to get deleted.)
	MaxCount int `json:"maxcount" toml:"maxcount" yaml:"maxcount" default:"5"`

	// AddSource determain whether add file:line to log file.
	AddSource bool `json:"addsource" toml:"addsource" yaml:"addsource"`

	// Compress determines if the rotated log files should be compressed using gzip.
	Compress bool `json:"compress" toml:"compress" yaml:"compress"`
}