log

Documentation

Index

• func Debug() *zerolog.Event
• func Error() *zerolog.Event
• func Info() *zerolog.Event
• func Start(config Config) error
• func Stop() error
• func Warn() *zerolog.Event
• func With() zerolog.Context
• type Config

Functions

func Debug

func Debug() *zerolog.Event

Debug starts a new message with debug level.

You must call Msg on the returned event in order to send the event.

func Error

func Error() *zerolog.Event

Error starts a new message with error level.

You must call Msg on the returned event in order to send the event.

func Info

func Info() *zerolog.Event

Info starts a new message with info level.

You must call Msg on the returned event in order to send the event.

func Start

func Start(config Config) error

func Stop

func Stop() error

Stop closes the underlying file logger. Should be called at the end of the service Stop method.

func Warn

func Warn() *zerolog.Event

Warn starts a new message with warn level.

You must call Msg on the returned event in order to send the event.

func With

func With() zerolog.Context

With creates a new logger context.

You must call Logger on the returned Context in order to get a logger.

Types

type Config

type Config struct {

	// Level of the logger. Valid options: debug, info, warn, error, disable.
	Level string `yaml:"level"`

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

	// 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 `yaml:"maxage"`

	// MaxBackups 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.)
	MaxBackups int `yaml:"maxbackups"`

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