logger

Documentation

Index

• func SetupDefault()
• type ComboWriter
  • func (w *ComboWriter) Write(p []byte) (n int, err error)
• type Option
  • func CreateOption() *Option
  • func (option *Option) Setup()

Functions

func SetupDefault

func SetupDefault()

Types

type ComboWriter

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

func (*ComboWriter) Write

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

type Option

type Option struct {
	ConsoleEnabled bool
	FileEnabled    bool
	JsonMode       bool
	LogLevel       slog.Level

	// 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

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

	// 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

	// 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

	// LocalTime determines if the time used for formatting the timestamps in
	// backup files is the computer's local time.  The default is to use UTC
	// time.
	LocalTime bool

	// Compress determines if the rotated log files should be compressed
	// using gzip. The default is not to perform compression.
	Compress bool
}

func CreateOption

func CreateOption() *Option

func (*Option) Setup

func (option *Option) Setup()