logging

Documentation

Overview

Copyright 2023 Christopher Briscoe. All rights reserved.

Index

• Variables
• type Config
• type Logger
  • func NewLogger(cfg *Config) (*Logger, error)
  • func (l *Logger) Rotate() error

Variables

var (
	Nop = &Logger{
		Logger: &nop,
		roller: nil,
	}
)

Nop is a no-operation logger instance with no roller attached

Types

type Config

type Config struct {
	BaseDir    string        `json:"basedir"`
	FileName   string        `json:"filename"`
	MaxAge     time.Duration `json:"maxage"`
	MaxSize    int64         `json:"maxsize"`
	MaxBackups int           `json:"maxbackups"`
	Console    bool          `json:"console"`
	Compress   bool          `json:"compress"`
}

Config stores the information required to start a new logger

type Logger

type Logger struct {
	*zerolog.Logger
	// contains filtered or unexported fields
}

Logger contains a zerolog.Logger for logging functions and a lumberjack.Roller reference so that we can call Rotate() on our own schedule if desired

func NewLogger

func NewLogger(cfg *Config) (*Logger, error)

NewLogger returns a new rolling logger based on the config parameters used

func (*Logger) Rotate

func (l *Logger) Rotate() error

Rotate will immediately close and rotate the current log file