logging

Documentation

Index

• Variables
• func Debug(args ...any)
• func Debugf(format string, args ...any)
• func Error(args ...any)
• func Errorf(format string, args ...any)
• func Fatal(args ...any)
• func Fatalf(format string, args ...any)
• func Info(args ...any)
• func Infof(format string, args ...any)
• func NewPulsarLogger() pulsarlog.Logger
• func Panic(args ...any)
• func ReplaceStdLogger(l *Logger)
• func Warn(args ...any)
• func Warnf(format string, args ...any)
• type FilteredLevelWriter
  • func (w *FilteredLevelWriter) Write(p []byte) (int, error)
  • func (w *FilteredLevelWriter) WriteLevel(level zerolog.Level, p []byte) (int, error)
• type Logger
  • func FromZerolog(l zerolog.Logger) *Logger
  • func StdLogger() *Logger
  • func WithError(err error) *Logger
  • func WithField(key string, value any) *Logger
  • func WithFields(args map[string]any) *Logger
  • func WithStacktrace(err error) *Logger
  • func (l *Logger) Debug(args ...any)
  • func (l *Logger) Debugf(format string, args ...interface{})
  • func (l *Logger) Error(args ...any)
  • func (l *Logger) Errorf(format string, args ...interface{})
  • func (l *Logger) Fatal(args ...any)
  • func (l *Logger) Fatalf(format string, args ...interface{})
  • func (l *Logger) Info(args ...any)
  • func (l *Logger) Infof(format string, args ...interface{})
  • func (l *Logger) Panic(args ...any)
  • func (l *Logger) Warn(args ...any)
  • func (l *Logger) Warnf(format string, args ...interface{})
  • func (l *Logger) WithCallerSkip(skip int) *Logger
  • func (l *Logger) WithError(err error) *Logger
  • func (l *Logger) WithField(key string, value any) *Logger
  • func (l *Logger) WithFields(args map[string]any) *Logger
  • func (l *Logger) WithStacktrace(err error) *Logger
• type PrometheusHook
  • func NewPrometheusHook() *PrometheusHook
  • func (h *PrometheusHook) Run(_ *zerolog.Event, level zerolog.Level, _ string)

Variables

var NullLogger = &Logger{
	underlying: zerolog.Nop(),
}

NullLogger is Logger that discards all log lines

var (
	StdSkipFrames = 4
)

Functions

func Debug

func Debug(args ...any)

Debug logs a message at level Debug on the default logger.

func Debugf

func Debugf(format string, args ...any)

Debugf logs a message at level Debug on the default logger.

func Error

func Error(args ...any)

Error logs a message at level Error on the default logger.

func Errorf

func Errorf(format string, args ...any)

Errorf logs a message at level Error on the default logger.

func Fatal

func Fatal(args ...any)

Fatal logs a message at level Fatal on the default logger then the process will exit with status set to 1.

func Fatalf

func Fatalf(format string, args ...any)

Fatalf logs a message at level Fatal on the default logger then the process will exit with status set to 1.

func Info

func Info(args ...any)

Info logs a message at level Info on the default logger.

func Infof

func Infof(format string, args ...any)

Infof logs a message at level Info on the default logger.

func NewPulsarLogger

func NewPulsarLogger() pulsarlog.Logger

NewPulsarLogger returns a Logger that can be used by the pulsar client

func Panic

func Panic(args ...any)

Panic logs a message at level Panic on the default logger.

func ReplaceStdLogger

func ReplaceStdLogger(l *Logger)

ReplaceStdLogger Replaces the global logger. This should be called once at app startup!

func Warn

func Warn(args ...any)

Warn logs a message at level Warn on the default logger.

func Warnf

func Warnf(format string, args ...any)

Warnf logs a message at level Warn on the default logger.

Types

type FilteredLevelWriter

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

func (*FilteredLevelWriter) Write

func (w *FilteredLevelWriter) Write(p []byte) (int, error)

Write writes to the underlying Writer.

func (*FilteredLevelWriter) WriteLevel

func (w *FilteredLevelWriter) WriteLevel(level zerolog.Level, p []byte) (int, error)

WriteLevel calls WriteLevel of the underlying Writer only if the level is equal or above the Level.

type Logger

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

Logger wraps a zerolog.Logger so that the rest of the code doesn't depend directly on zerolog

func FromZerolog

func FromZerolog(l zerolog.Logger) *Logger

FromZerolog returns a new Logger backed by the supplied zerolog.Logger

func StdLogger

func StdLogger() *Logger

StdLogger Returns the default logger

func WithError

func WithError(err error) *Logger

WithError returns a new Logger with the error added as a field

func WithField

func WithField(key string, value any) *Logger

WithField returns a new Logger with the key-value pair added as a new field

func WithFields

func WithFields(args map[string]any) *Logger

WithFields returns a new Logger with all key-value pairs in the map added as new fields

func WithStacktrace

func WithStacktrace(err error) *Logger

WithStacktrace returns a new Logger with the error and (if available) the stacktrace added as fields

func (*Logger) Debug

func (l *Logger) Debug(args ...any)

Debug logs a message at level Debug

func (*Logger) Debugf

func (l *Logger) Debugf(format string, args ...interface{})

Debugf logs a formatted message at level Debug

func (*Logger) Error

func (l *Logger) Error(args ...any)

Error logs a message at level Error

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...interface{})

Errorf logs a formatted message at level Error

func (*Logger) Fatal

func (l *Logger) Fatal(args ...any)

Fatal logs a message at level Fatal and exits the application

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, args ...interface{})

Fatalf logs a formatted message at level Fatal and exits the application

func (*Logger) Info

func (l *Logger) Info(args ...any)

Info logs a message at level Info

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...interface{})

Infof logs a formatted message at level Info

func (*Logger) Panic

func (l *Logger) Panic(args ...any)

Panic logs a message at level Panic and panics

func (*Logger) Warn

func (l *Logger) Warn(args ...any)

Warn logs a message at level Warn

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...interface{})

Warnf logs a formatted message at level Warn

func (*Logger) WithCallerSkip

func (l *Logger) WithCallerSkip(skip int) *Logger

WithCallerSkip returns a new Logger with the number of callers skipped increased by the skip amount. This is needed when building wrappers around the Logger so as to prevent us from always reporting the wrapper code as the caller.

func (*Logger) WithError

func (l *Logger) WithError(err error) *Logger

WithError returns a new Logger with the error added as a field

func (*Logger) WithField

func (l *Logger) WithField(key string, value any) *Logger

WithField returns a new Logger with the key-value pair added as a new field

func (*Logger) WithFields

func (l *Logger) WithFields(args map[string]any) *Logger

WithFields returns a new Logger with all key-value pairs in the map added as new fields

func (*Logger) WithStacktrace

func (l *Logger) WithStacktrace(err error) *Logger

WithStacktrace returns a new Logger with the error and (if available) the stacktrace added as fields

type PrometheusHook

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

PrometheusHook implements zerolog.Hook

func NewPrometheusHook

func NewPrometheusHook() *PrometheusHook

NewPrometheusHook creates and registers Prometheus counters for each log level.

func (*PrometheusHook) Run

func (h *PrometheusHook) Run(_ *zerolog.Event, level zerolog.Level, _ string)