logging

Documentation

Index

• Constants
• Variables
• func Configure(config Config) error
• func SetDefaultConsoleWriter(w zerolog.ConsoleWriter)
• type Config
• type StdLogger
  • func StandardLogger(log zerolog.Logger) StdLogger

Constants

const (
	TimeFormat = "15:04:05.000"
)

Logger is the opensvc specific zerolog logger

Variables

var (
	// WithCaller adds the file:line information of the logger caller
	WithCaller bool
)

Functions

func Configure

func Configure(config Config) error

Configure sets up the logging framework

func SetDefaultConsoleWriter

func SetDefaultConsoleWriter(w zerolog.ConsoleWriter)

SetDefaultConsoleWriter set the default console writer

Types

type Config

type Config struct {
	// WithCaller includes the caller file:line to the records
	WithCaller bool

	// Enable console logging
	WithConsoleLog bool

	// Enable console logging coloring
	WithColor bool

	// LogFile makes the framework log to a file
	LogFile string

	// SessionLogFile logs to a per-sessionid file
	SessionLogFile string

	// Level is the minimum log record level to accept.
	// debug, info, warn[ing], error, fatal, panic
	Level 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
}

Config is the configuration of the zerolog logger and writers

type StdLogger

type StdLogger interface {
	Panic(v ...any)
	Panicln(v ...any)
	Panicf(format string, v ...any)
	Fatal(v ...any)
	Fatalln(v ...any)
	Fatalf(format string, v ...any)
	Print(v ...any)
	Println(v ...any)
	Printf(format string, v ...any)
}

func StandardLogger

func StandardLogger(log zerolog.Logger) StdLogger