logging

Documentation

Index

• Constants
• func ContextWithLogger(ctx context.Context, logger *Logger) context.Context
• type Level
• type Logger
  • func LoggerFromContext(ctx context.Context) *Logger
  • func NewLogger(level Level) *Logger
  • func Wrap(logrLogger logr.Logger) *Logger
  • func (l *Logger) Debug(msg string, keysAndValues ...any)
  • func (l *Logger) Error(err error, msg string, keysAndValues ...any)
  • func (l *Logger) GetLogger() logr.Logger
  • func (l *Logger) Info(msg string, keysAndValues ...any)
  • func (l *Logger) Trace(msg string, keysAndValues ...any)
  • func (l *Logger) WithValues(keysAndValues ...any) *Logger

Constants

const (
	ErrorLevel = Level(logrus.ErrorLevel)
	InfoLevel  = Level(logrus.InfoLevel)
	DebugLevel = Level(logrus.DebugLevel)
	TraceLevel = Level(logrus.TraceLevel)
)

Functions

func ContextWithLogger

func ContextWithLogger(ctx context.Context, logger *Logger) context.Context

ContextWithLogger returns a context.Context that has been augmented with the provided *Logger.

Types

type Level

type Level int

type Logger

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

Logger is a wrapper around logr.Logger that provides a more ergonomic API. This is heavily inspired by a similar wrapper from https://github.com/kubernetes-sigs/cluster-api-provider-aws

func LoggerFromContext

func LoggerFromContext(ctx context.Context) *Logger

LoggerFromContext extracts a *Logger from the provided context.Context and returns it. If no *Logger is found, a global *Logger is returned.

func NewLogger

func NewLogger(level Level) *Logger

NewLogger returns a new *Logger with the provided log level.

func Wrap

func Wrap(logrLogger logr.Logger) *Logger

Wrap returns a new *Logger that wraps the provided logr.Logger.

func (*Logger) Debug

func (l *Logger) Debug(msg string, keysAndValues ...any)

Debug logs a message at the debug level.

func (*Logger) Error

func (l *Logger) Error(err error, msg string, keysAndValues ...any)

Error logs a message at the error level.

func (*Logger) GetLogger

func (l *Logger) GetLogger() logr.Logger

GetLogger returns the underlying logr.Logger for cases where one needs to interact with the logr API directly.

func (*Logger) Info

func (l *Logger) Info(msg string, keysAndValues ...any)

Info logs a message at the info level.

func (*Logger) Trace

func (l *Logger) Trace(msg string, keysAndValues ...any)

Trace logs a message at the trace level.

func (*Logger) WithValues

func (l *Logger) WithValues(keysAndValues ...any) *Logger

WithValues adds key-value pairs to a logger's context.