log

Documentation

Index

• Constants
• Variables
• func Configure(config Config) *zerolog.Logger
• type Config

Constants

const (
	DebugLevel = zerolog.DebugLevel
	InfoLevel  = zerolog.InfoLevel
	WarnLevel  = zerolog.WarnLevel
	ErrorLevel = zerolog.ErrorLevel
	FatalLevel = zerolog.FatalLevel
	PanicLevel = zerolog.PanicLevel
	NoLevel    = zerolog.NoLevel
	Disabled   = zerolog.Disabled
	TraceLevel = zerolog.TraceLevel
)

Variables

var Ctx = log.Ctx

var Debug = log.Debug

var Err = log.Err

var Error = log.Error

var Fatal = log.Fatal

var Hook = log.Hook

var Info = log.Info

var Level = log.Level

var Log = log.Log

var Output = log.Output

var Panic = log.Panic

var Print = log.Print

var Printf = log.Printf

var Sample = log.Sample

var SetGolvalLevel = zerolog.SetGlobalLevel

var Trace = log.Trace

var Warn = log.Warn

var With = log.With

var WithLevel = log.WithLevel

Functions

func Configure

func Configure(config Config) *zerolog.Logger

Configure sets up the logging framework

In production, the container logs will be collected and file logging should be disabled. However, during development it's nicer to see logs as text and optionally write to a file when debugging problems in the containerized pipeline

The output log file will be located at /var/log/service-xyz/service-xyz.log and will be rolled according to configuration set.

Types

type Config

type Config struct {
	// Enable console logging
	ConsoleLoggingEnabled bool

	// EncodeLogsAsJson makes the log framework log JSON
	EncodeLogsAsJson bool

	// FileLoggingEnabled makes the framework log to a file
	// the fields below can be skipped if this value is false!
	FileLoggingEnabled bool
	// Directory to log to to when filelogging is enabled
	Directory string
	// Filename is the name of the logfile which will be placed inside the directory
	Filename string
	// MaxSize the max size in MB of the logfile before it's rolled
	MaxSize int
	// MaxBackups the max number of rolled files to keep
	MaxBackups int
	// MaxAge the max age in days to keep a logfile
	MaxAge int
	// Level is the minimum level to log
	Level string
}

Config Configuration for logging