logger

Documentation

Overview

Package logger contains logging implementations.

Index

• type Logger
• type OptionLogger
  • func WithFormat(format string) OptionLogger
  • func WithLevel(level string) OptionLogger
  • func WithTimestampFormat(timestampFormat string) OptionLogger
• type OptionsLogger
• type ZapLogger
  • func MustNewLogger(logFormat, logLevel, logTimestampFormat string) *ZapLogger
  • func NewLogger(options ...OptionLogger) (*ZapLogger, error)
  • func NewNoopLogger() *ZapLogger
  • func (l *ZapLogger) Debug(msg string, fields ...zap.Field)
  • func (l *ZapLogger) DebugWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) Error(msg string, fields ...zap.Field)
  • func (l *ZapLogger) ErrorWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) Fatal(msg string, fields ...zap.Field)
  • func (l *ZapLogger) FatalWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) Info(msg string, fields ...zap.Field)
  • func (l *ZapLogger) InfoWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) Panic(msg string, fields ...zap.Field)
  • func (l *ZapLogger) PanicWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) Warn(msg string, fields ...zap.Field)
  • func (l *ZapLogger) WarnWithContext(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *ZapLogger) With(fields ...zap.Field)

Types

type Logger

type Logger interface {
	// These are ops that call directly to the actual zap implementation
	Debug(string, ...zap.Field)
	Info(string, ...zap.Field)
	Warn(string, ...zap.Field)
	Error(string, ...zap.Field)
	Panic(string, ...zap.Field)
	Fatal(string, ...zap.Field)

	// These are the equivalent logger function but with context provided
	DebugWithContext(context.Context, string, ...zap.Field)
	InfoWithContext(context.Context, string, ...zap.Field)
	WarnWithContext(context.Context, string, ...zap.Field)
	ErrorWithContext(context.Context, string, ...zap.Field)
	PanicWithContext(context.Context, string, ...zap.Field)
	FatalWithContext(context.Context, string, ...zap.Field)
}

type OptionLogger

type OptionLogger func(ol *OptionsLogger)

func WithFormat

func WithFormat(format string) OptionLogger

func WithLevel

func WithLevel(level string) OptionLogger

func WithTimestampFormat

func WithTimestampFormat(timestampFormat string) OptionLogger

type OptionsLogger

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

OptionsLogger Implements options for logger.

type ZapLogger

type ZapLogger struct {
	*zap.Logger
}

ZapLogger is an implementation of Logger that uses the uber/zap logger underneath. It provides additional methods such as ones that logs based on context.

func MustNewLogger

func MustNewLogger(logFormat, logLevel, logTimestampFormat string) *ZapLogger

func NewLogger

func NewLogger(options ...OptionLogger) (*ZapLogger, error)

func NewNoopLogger

func NewNoopLogger() *ZapLogger

NewNoopLogger provides a noop logger.

func (*ZapLogger) Debug

func (l *ZapLogger) Debug(msg string, fields ...zap.Field)

func (*ZapLogger) DebugWithContext

func (l *ZapLogger) DebugWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) Error

func (l *ZapLogger) Error(msg string, fields ...zap.Field)

func (*ZapLogger) ErrorWithContext

func (l *ZapLogger) ErrorWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) Fatal

func (l *ZapLogger) Fatal(msg string, fields ...zap.Field)

func (*ZapLogger) FatalWithContext

func (l *ZapLogger) FatalWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) Info

func (l *ZapLogger) Info(msg string, fields ...zap.Field)

func (*ZapLogger) InfoWithContext

func (l *ZapLogger) InfoWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) Panic

func (l *ZapLogger) Panic(msg string, fields ...zap.Field)

func (*ZapLogger) PanicWithContext

func (l *ZapLogger) PanicWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) Warn

func (l *ZapLogger) Warn(msg string, fields ...zap.Field)

func (*ZapLogger) WarnWithContext

func (l *ZapLogger) WarnWithContext(ctx context.Context, msg string, fields ...zap.Field)

func (*ZapLogger) With

func (l *ZapLogger) With(fields ...zap.Field)