mrlog

Documentation

Index

• func HasCtx(ctx context.Context) bool
• func ParseDateTimeFormat(str string) (string, error)
• func WithContext(ctx context.Context, logger Logger) context.Context
• type BaseLogger
  • func New(level Level) *BaseLogger
  • func (l *BaseLogger) Debug() LoggerEvent
  • func (l *BaseLogger) Error() LoggerEvent
  • func (l *BaseLogger) Fatal() LoggerEvent
  • func (l *BaseLogger) Info() LoggerEvent
  • func (l *BaseLogger) Level() Level
  • func (l *BaseLogger) Panic() LoggerEvent
  • func (l *BaseLogger) Printf(format string, args ...any)
  • func (l *BaseLogger) Trace() LoggerEvent
  • func (l *BaseLogger) Warn() LoggerEvent
  • func (l *BaseLogger) With() LoggerContext
  • func (l *BaseLogger) WithContext(ctx context.Context) context.Context
• type Level
  • func ParseLevel(str string) (Level, error)
  • func (e Level) String() string
• type Logger
  • func Ctx(ctx context.Context) Logger
  • func Default() Logger
• type LoggerContext
• type LoggerEvent

Functions

func HasCtx

func HasCtx(ctx context.Context) bool

HasCtx - проверяется, что логгер явно содержится в контексте.

func ParseDateTimeFormat

func ParseDateTimeFormat(str string) (string, error)

ParseDateTimeFormat - comment func.

func WithContext

func WithContext(ctx context.Context, logger Logger) context.Context

WithContext - возвращает контекст с указанным логгером.

Types

type BaseLogger

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

BaseLogger - логгер на крайний случай, например, когда не был установлен логгер в контексте.

func New

func New(level Level) *BaseLogger

New - создаёт объект BaseLogger.

func (*BaseLogger) Debug

func (l *BaseLogger) Debug() LoggerEvent

Debug - comment method.

func (*BaseLogger) Error

func (l *BaseLogger) Error() LoggerEvent

Error - comment method.

func (*BaseLogger) Fatal

func (l *BaseLogger) Fatal() LoggerEvent

Fatal - comment method.

func (*BaseLogger) Info

func (l *BaseLogger) Info() LoggerEvent

Info - comment method.

func (*BaseLogger) Level

func (l *BaseLogger) Level() Level

Level - comment method.

func (*BaseLogger) Panic

func (l *BaseLogger) Panic() LoggerEvent

Panic - comment method.

func (*BaseLogger) Printf

func (l *BaseLogger) Printf(format string, args ...any)

Printf - comment method.

func (*BaseLogger) Trace

func (l *BaseLogger) Trace() LoggerEvent

Trace - comment method.

func (*BaseLogger) Warn

func (l *BaseLogger) Warn() LoggerEvent

Warn - comment method.

func (*BaseLogger) With

func (l *BaseLogger) With() LoggerContext

With - comment method.

func (*BaseLogger) WithContext

func (l *BaseLogger) WithContext(ctx context.Context) context.Context

WithContext - comment method.

type Level

type Level int8

Level - уровень логирования.

const (
	DebugLevel Level = iota // DebugLevel - FatalLevel + WarnLevel + WarnLevel + InfoLevel + отладочные сообщения
	InfoLevel               // InfoLevel - FatalLevel + WarnLevel + WarnLevel + информационные сообщения
	WarnLevel               // WarnLevel - FatalLevel + WarnLevel + предупреждения
	ErrorLevel              // ErrorLevel - FatalLevel + ошибки
	FatalLevel              // FatalLevel - отображение только критических ошибок
	TraceLevel Level = -1   // TraceLevel - FatalLevel + WarnLevel + WarnLevel + InfoLevel + DebugLevel + трассировочные сообщения
)

func ParseLevel

func ParseLevel(str string) (Level, error)

ParseLevel - comment func.

func (Level) String

func (e Level) String() string

String - возвращает значение в виде строки.

type Logger

type Logger interface {
	Level() Level
	WithContext(ctx context.Context) context.Context

	With() LoggerContext

	Debug() LoggerEvent
	Info() LoggerEvent
	Warn() LoggerEvent
	Error() LoggerEvent
	Fatal() LoggerEvent
	Panic() LoggerEvent
	Trace() LoggerEvent

	Printf(format string, args ...any) // поддержка стандартного интерфейса логирования сообщений
}

Logger - интерфейс логирования ошибок и сообщений через формирования события.

func Ctx

func Ctx(ctx context.Context) Logger

Ctx - возвращает логгер из указанного контекста, если он не был установлен ранее, то возвращается логгер по умолчанию.

func Default

func Default() Logger

Default - возвращает логгер по умолчанию (использовать только на крайней случай).

type LoggerContext

type LoggerContext interface {
	Logger() Logger

	Str(key, value string) LoggerContext
	Bytes(key string, value []byte) LoggerContext
	Int(key string, value int) LoggerContext
	Int64(key string, value int64) LoggerContext
	Any(key string, value any) LoggerContext
}

LoggerContext - контекст логгера для обогащения его дополнительными атрибутами.

type LoggerEvent

type LoggerEvent interface {
	Err(err error) LoggerEvent
	Str(key, value string) LoggerEvent
	Bytes(key string, value []byte) LoggerEvent
	Int(key string, value int) LoggerEvent
	Int64(key string, value int64) LoggerEvent
	Any(key string, value any) LoggerEvent

	Msg(message string)
	Msgf(format string, args ...any)
	MsgFunc(createMsg func() string)
	Send()
}

LoggerEvent - инерфейс события, с возможностью его обогащения и отправки.