logger

Documentation

Index

• Constants
• func Debugf(ctx context.Context, format string, v ...any)
• func Errorf(ctx context.Context, format string, v ...any)
• func Infof(ctx context.Context, format string, v ...any)
• func NewContext(ctx context.Context, logger Logger) context.Context
• func Tracef(ctx context.Context, format string, v ...any)
• func Warnf(ctx context.Context, format string, v ...any)
• type Level
• type Logger
  • func FromContext(ctx context.Context) (Logger, bool)
  • func Get(ctx context.Context) Logger
• type SimpleLogger
  • func (l *SimpleLogger) Debugf(ctx context.Context, format string, v ...any)
  • func (l *SimpleLogger) Enabled(_ context.Context, level Level) bool
  • func (l *SimpleLogger) Errorf(ctx context.Context, format string, v ...any)
  • func (l *SimpleLogger) Infof(ctx context.Context, format string, v ...any)
  • func (l *SimpleLogger) Tracef(ctx context.Context, format string, v ...any)
  • func (l *SimpleLogger) Warnf(ctx context.Context, format string, v ...any)

Constants

const (
	LevelTrace = -8
	LevelDebug = -4
	LevelInfo  = 0
	LevelWarn  = 4
	LevelError = 8
)

Functions

func Debugf

func Debugf(ctx context.Context, format string, v ...any)

func Errorf

func Errorf(ctx context.Context, format string, v ...any)

func Infof

func Infof(ctx context.Context, format string, v ...any)

func NewContext

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

NewContext returns a new Context that carries the specified logger.

func Tracef

func Tracef(ctx context.Context, format string, v ...any)

func Warnf

func Warnf(ctx context.Context, format string, v ...any)

Types

type Level

type Level int

Level maps to the logging levels in Logger.

type Logger

type Logger interface {
	// Enabled returns if logging at the specified level is enabled.
	// This can be used to avoid computating an expensive value if it
	// won't be logged anyway.
	Enabled(ctx context.Context, level Level) bool

	// Tracef logs a formatted string at [LevelTrace].
	Tracef(ctx context.Context, format string, v ...any)

	// Debugf logs a formatted string at [LevelDebug].
	Debugf(ctx context.Context, format string, v ...any)

	// Infof logs a formatted string at [LevelInfo].
	Infof(ctx context.Context, format string, v ...any)

	// Warnf logs a formatted string at [LevelWarn].
	Warnf(ctx context.Context, format string, v ...any)

	// Errorf logs a formatted string at [LevelError].
	Errorf(ctx context.Context, format string, v ...any)
}

var DefaultLogger Logger = &SimpleLogger{}

func FromContext

func FromContext(ctx context.Context) (Logger, bool)

FromContext returns the Logger value stored in ctx, if any.

func Get

func Get(ctx context.Context) Logger

Get returns either the logger configured on the context, or the global logger if one isn't defined.

type SimpleLogger

type SimpleLogger struct {
	Level Level
}

func (*SimpleLogger) Debugf

func (l *SimpleLogger) Debugf(ctx context.Context, format string, v ...any)

func (*SimpleLogger) Enabled

func (l *SimpleLogger) Enabled(_ context.Context, level Level) bool

func (*SimpleLogger) Errorf

func (l *SimpleLogger) Errorf(ctx context.Context, format string, v ...any)

func (*SimpleLogger) Infof

func (l *SimpleLogger) Infof(ctx context.Context, format string, v ...any)

func (*SimpleLogger) Tracef

func (l *SimpleLogger) Tracef(ctx context.Context, format string, v ...any)

func (*SimpleLogger) Warnf

func (l *SimpleLogger) Warnf(ctx context.Context, format string, v ...any)