logger

Documentation

Index

• func Close()
• func Debug(format string, a ...any)
• func Error(format string, a ...any)
• func Fatal(err error)
• func Global(l Logger)
• func Info(format string, a ...any)
• func Trace(format string, a ...any)
• func Warn(format string, a ...any)
• func WriteEscapedJSON(content string, output *bytes.Buffer)
• type Config
  • func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config
• type FieldsContext
  • func (f FieldsContext) Debug(format string, a ...any)
  • func (f FieldsContext) Error(format string, a ...any)
  • func (f FieldsContext) Fatal(err error)
  • func (f FieldsContext) Info(format string, a ...any)
  • func (f FieldsContext) Trace(format string, a ...any)
  • func (f FieldsContext) Warn(format string, a ...any)
  • func (f FieldsContext) WithField(name string, value any) Provider
• type Logger
  • func GetGlobal() Logger
  • func New(config Config) Logger
  • func (l Logger) Close()
  • func (l Logger) Debug(format string, a ...any)
  • func (l Logger) Debugf(format string, a ...any)
  • func (l Logger) Error(format string, a ...any)
  • func (l Logger) Errorf(format string, a ...any)
  • func (l Logger) Fatal(err error)
  • func (l Logger) Info(format string, a ...any)
  • func (l Logger) Infof(format string, a ...any)
  • func (l Logger) Start()
  • func (l Logger) Trace(format string, a ...any)
  • func (l Logger) Warn(format string, a ...any)
  • func (l Logger) Warningf(format string, a ...any)
  • func (l Logger) WithField(name string, value any) Provider
• type Provider
  • func WithField(name string, value any) Provider

Functions

func Close

func Close()

Close ends logger gracefully.

func Debug

func Debug(format string, a ...any)

Debug logs debug message.

func Error

func Error(format string, a ...any)

Error logs error message.

func Fatal

func Fatal(err error)

Fatal logs error message and exit with status code 1.

func Global

func Global(l Logger)

Global sets global logger.

func Info

func Info(format string, a ...any)

Info logs info message.

func Trace

func Trace(format string, a ...any)

Trace logs tracing message.

func Warn

func Warn(format string, a ...any)

Warn logs warning message.

func WriteEscapedJSON

func WriteEscapedJSON(content string, output *bytes.Buffer)

WriteEscapedJSON escapes value from raw string to be JSON compatible.

Types

type Config

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

func Flags

func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config

type FieldsContext

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

FieldsContext contains field context.

func (FieldsContext) Debug

func (f FieldsContext) Debug(format string, a ...any)

Debug logs debug message.

func (FieldsContext) Error

func (f FieldsContext) Error(format string, a ...any)

Error logs error message.

func (FieldsContext) Fatal

func (f FieldsContext) Fatal(err error)

Fatal logs error message and exit with status code 1.

func (FieldsContext) Info

func (f FieldsContext) Info(format string, a ...any)

Info logs info message.

func (FieldsContext) Trace

func (f FieldsContext) Trace(format string, a ...any)

Trace logs tracing message.

func (FieldsContext) Warn

func (f FieldsContext) Warn(format string, a ...any)

Warn logs warning message.

func (FieldsContext) WithField

func (f FieldsContext) WithField(name string, value any) Provider

WithField add a field to current context.

type Logger

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

Logger defines a logger instance.

func GetGlobal

func GetGlobal() Logger

GetGlobal returns global logger.

func New

func New(config Config) Logger

New creates a Logger.

func (Logger) Close

func (l Logger) Close()

Close ends logger gracefully.

func (Logger) Debug

func (l Logger) Debug(format string, a ...any)

Debug logs debug message.

func (Logger) Debugf

func (l Logger) Debugf(format string, a ...any)

Debugf logs debug message.

func (Logger) Error

func (l Logger) Error(format string, a ...any)

Error logs error message.

func (Logger) Errorf

func (l Logger) Errorf(format string, a ...any)

Errorf logs error message.

func (Logger) Fatal

func (l Logger) Fatal(err error)

Fatal logs error message and exit with status code 1.

func (Logger) Info

func (l Logger) Info(format string, a ...any)

Info logs info message.

func (Logger) Infof

func (l Logger) Infof(format string, a ...any)

Infof logs info message.

func (Logger) Start

func (l Logger) Start()

Start starts logger's writer.

func (Logger) Trace

func (l Logger) Trace(format string, a ...any)

Trace logs tracing message.

func (Logger) Warn

func (l Logger) Warn(format string, a ...any)

Warn logs warning message.

func (Logger) Warningf

func (l Logger) Warningf(format string, a ...any)

Warningf logs warning message.

func (Logger) WithField

func (l Logger) WithField(name string, value any) Provider

WithField add given name and value to a context.

type Provider

type Provider interface {
	WithField(name string, value any) Provider
	Trace(format string, a ...any)
	Debug(format string, a ...any)
	Info(format string, a ...any)
	Warn(format string, a ...any)
	Error(format string, a ...any)
	Fatal(err error)
}

Provider of logging definition.

func WithField

func WithField(name string, value any) Provider

WithField create context for logging.