logger

Documentation

Index

• type Config
  • func (c *Config) Validate() error
• type ExtendedLogger
  • func DefaultExtended() ExtendedLogger
  • func NewExtended(opts ...Option) ExtendedLogger
  • func WithExtended(l ExtendedLogger, args ...any) ExtendedLogger
• type LogFormat
  • func (f LogFormat) Valid() bool
• type LogLevel
  • func (l LogLevel) String() string
  • func (l LogLevel) Valid() bool
• type Logger
  • func Default() Logger
  • func ForTests(t testingT) Logger
  • func New(opts ...Option) Logger
  • func With(l Logger, args ...any) Logger
• type Option
  • func WithAppName(v string) Option
  • func WithAppVersion(v string) Option
  • func WithCaller(v bool) Option
  • func WithConfig(v Config) Option
  • func WithConsoleColored(v bool) Option
  • func WithLogFormat(v LogFormat) Option
  • func WithLogLevel(v LogLevel) Option
  • func WithStackTrace(v bool) Option
  • func WithTimeKey(v string) Option
  • func WithZapOption(v zap.Option) Option
• type Sink
• type WriteSyncer

Types

type Config

type Config struct {
	Format         LogFormat `yaml:"format" env:"FORMAT" default:"json" usage:"allows to set custom formatting" example:"json"`
	Level          LogLevel  `yaml:"level" env:"LEVEL" default:"info" usage:"allows to set custom logger level" example:"info"`
	ConsoleColored bool      `yaml:"console_colored" env:"CONSOLE_COLORED" default:"false" usage:"allows to set colored console output" example:"false"`
	Trace          LogLevel  `yaml:"trace" env:"TRACE" default:"fatal" usage:"allows to set custom trace level" example:"fatal"`
	WithCaller     bool      `yaml:"with_caller" env:"WITH_CALLER" default:"false" usage:"allows to show caller" example:"false"`
	WithStackTrace bool      `yaml:"with_stack_trace" env:"WITH_STACK_TRACE" default:"false" usage:"allows to show stack trace" example:"false"`
}

func (*Config) Validate

func (c *Config) Validate() error

type ExtendedLogger

type ExtendedLogger interface {
	Logger
	Sync() error
	Std() *log.Logger
	Sugar() *sugaredLogger
}

func DefaultExtended

func DefaultExtended() ExtendedLogger

Default returns default extended logger instance

func NewExtended

func NewExtended(opts ...Option) ExtendedLogger

NewExtended - init new extended logger with options

func WithExtended

func WithExtended(l ExtendedLogger, args ...any) ExtendedLogger

WithExtended allows to provide zap.SugaredLogger as common interface.

type LogFormat

type LogFormat string

A LogFormat is a string that represents the log format.

const (
	LoggerFormatConsole LogFormat = "console"
	LoggerFormatJSON    LogFormat = "json"
)

func (LogFormat) Valid

func (f LogFormat) Valid() bool

Valid checks if log format is valid.

type LogLevel

type LogLevel string

const (
	LogLevelDebug LogLevel = "debug"
	LogLevelInfo  LogLevel = "info"
	LogLevelWarn  LogLevel = "warn"
	LogLevelError LogLevel = "error"
	LogLevelFatal LogLevel = "fatal"
	LogLevelPanic LogLevel = "panic"
)

func (LogLevel) String

func (l LogLevel) String() string

String returns log level as string.

func (LogLevel) Valid

func (l LogLevel) Valid() bool

Valid checks if log level is valid.

type Logger

type Logger interface {
	Debug(...any)
	Debugln(...any)
	Debugf(template string, args ...any)
	Debugw(msg string, keysAndValues ...any)

	Info(...any)
	Infoln(...any)
	Infof(template string, args ...any)
	Infow(msg string, keysAndValues ...any)

	Warn(...any)
	Warnln(...any)
	Warnf(template string, args ...any)
	Warnw(msg string, keysAndValues ...any)

	Error(...any)
	Errorln(...any)
	Errorf(template string, args ...any)
	Errorw(msg string, keysAndValues ...any)

	Fatal(...any)
	Fatalln(...any)
	Fatalf(template string, args ...any)
	Fatalw(msg string, keysAndValues ...any)

	Panic(...any)
	Panicln(...any)
	Panicf(template string, args ...any)
	Panicw(msg string, keysAndValues ...any)
}

Logger common interface

func Default

func Default() Logger

Default returns default logger instance

func ForTests

func ForTests(t testingT) Logger

ForTests wrapped logger for tests.

func New

func New(opts ...Option) Logger

New - init new logger with options

func With

func With(l Logger, args ...any) Logger

With allows to provide zap.SugaredLogger as common interface.

type Option

type Option func(*logger)

func WithAppName

func WithAppName(v string) Option

WithAppName allows to set application name to logger fields.

func WithAppVersion

func WithAppVersion(v string) Option

WithAppVersion allows to set application version to logger fields.

func WithCaller

func WithCaller(v bool) Option

func WithConfig

func WithConfig(v Config) Option

func WithConsoleColored

func WithConsoleColored(v bool) Option

WithConsoleColored allows to set colored console output.

func WithLogFormat

func WithLogFormat(v LogFormat) Option

func WithLogLevel

func WithLogLevel(v LogLevel) Option

func WithStackTrace

func WithStackTrace(v bool) Option

func WithTimeKey

func WithTimeKey(v string) Option

func WithZapOption

func WithZapOption(v zap.Option) Option

WithZapOption allows to set zap.Option.

type Sink

type Sink = zap.Sink

Sink defines the interface to write to and close logger destinations. Type alias.

type WriteSyncer

type WriteSyncer = zapcore.WriteSyncer

WriteSyncer is an io.Writer that can also flush any buffered data. Note that *os.File (and thus, os.Stderr and os.Stdout) implement WriteSyncer. Type alias.