logging

Documentation

Index

• func NewFileLogger(opts *FileLoggerOptions) (*lumberjack.Logger, error)
• func NewZapLogger(opts *LoggerOptions) (*zap.Logger, error)
• func ParseLogLevel(level string) zap.AtomicLevel
• type FileLoggerOptions
• type Logger
  • func NewLogger(opts *LoggerOptions) (*Logger, error)
  • func (l *Logger) Debug(msg string, fields ...zapcore.Field)
  • func (l *Logger) Error(msg string, fields ...zapcore.Field)
  • func (l *Logger) Fatal(msg string, fields ...zapcore.Field)
  • func (l *Logger) Info(msg string, fields ...zapcore.Field)
  • func (l *Logger) Warn(msg string, fields ...zapcore.Field)
• type LoggerContract
• type LoggerOptions

Functions

func NewFileLogger

func NewFileLogger(opts *FileLoggerOptions) (*lumberjack.Logger, error)

func NewZapLogger

func NewZapLogger(opts *LoggerOptions) (*zap.Logger, error)

Create a new zap logger

func ParseLogLevel

func ParseLogLevel(level string) zap.AtomicLevel

Types

type FileLoggerOptions

type FileLoggerOptions struct {
	LogDirectory  string
	LogFilePrefix string
	MaxSize       int
	MaxAge        int
}

type Logger

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

func NewLogger

func NewLogger(opts *LoggerOptions) (*Logger, error)

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...zapcore.Field)

func (*Logger) Error

func (l *Logger) Error(msg string, fields ...zapcore.Field)

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, fields ...zapcore.Field)

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...zapcore.Field)

func (*Logger) Warn

func (l *Logger) Warn(msg string, fields ...zapcore.Field)

type LoggerContract

type LoggerContract interface {
	Debug(msg string, fields ...zapcore.Field)
	Info(msg string, fields ...zapcore.Field)
	Warn(msg string, fields ...zapcore.Field)
	Error(msg string, fields ...zapcore.Field)
	Fatal(msg string, fields ...zapcore.Field)
}

type LoggerOptions

type LoggerOptions struct {
	// Log level: debug, info, warn, error, fatal
	LogLevel string
	// Where to output logs; console, file
	LogOutput string
	// Log output format: text, json
	LogFormat string
	// Log file prefix (only used when LogOutput is file)
	LogFilePrefix string
	// Log directory (only used when LogOutput is file)
	LogDirectory string
	// Max file size in MB (only used when LogOutput is file)
	MaxFileSize int
}