logger

Documentation

Index

• func Debug(ctx context.Context, msg string, tags ...any)
• func Debugf(ctx context.Context, format string, v ...any)
• func Error(ctx context.Context, msg string, tags ...any)
• func Errorf(ctx context.Context, format string, v ...any)
• func Fatal(ctx context.Context, msg string, tags ...any)
• func Fatalf(ctx context.Context, format string, v ...any)
• func Info(ctx context.Context, msg string, tags ...any)
• func Infof(ctx context.Context, format string, v ...any)
• func Warn(ctx context.Context, msg string, tags ...any)
• func Warnf(ctx context.Context, format string, v ...any)
• func WithFixedLogger(ctx context.Context, logger Logger) context.Context
• func WithLogger(ctx context.Context, logger Logger) context.Context
• func Write(ctx context.Context, msg string)
• type Config
• type Logger
  • func FromContext(ctx context.Context) Logger
  • func NewLogger(opts ...Option) Logger
• type Option
  • func WithDebug() Option
  • func WithFormat(format string) Option
  • func WithQuiet() Option
  • func WithWriter(w io.Writer) Option

Functions

func Debug

func Debug(ctx context.Context, msg string, tags ...any)

Debug logs a message with debug level.

func Debugf

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

Debugf logs a formatted message with debug level.

func Error

func Error(ctx context.Context, msg string, tags ...any)

Error logs a message with error level.

func Errorf

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

Errorf logs a formatted message with error level.

func Fatal

func Fatal(ctx context.Context, msg string, tags ...any)

Fatal logs a message with fatal level and exits the program.

func Fatalf

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

Fatalf logs a formatted message with fatal level and exits the program.

func Info

func Info(ctx context.Context, msg string, tags ...any)

Info logs a message with info level.

func Infof

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

Infof logs a formatted message with info level.

func Warn

func Warn(ctx context.Context, msg string, tags ...any)

Warn logs a message with warn level.

func Warnf

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

Warnf logs a formatted message with warn level.

func WithFixedLogger

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

WithFixedLogger returns a new context with the given fixed logger. This is only used for testing.

func WithLogger

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

WithLogger returns a new context with the given logger.

func Write

func Write(ctx context.Context, msg string)

Write writes a message with free form.

Types

type Config

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

type Logger

type Logger interface {
	Debug(msg string, tags ...any)
	Info(msg string, tags ...any)
	Warn(msg string, tags ...any)
	Error(msg string, tags ...any)
	Fatal(msg string, tags ...any)

	Debugf(format string, v ...any)
	Infof(format string, v ...any)
	Warnf(format string, v ...any)
	Errorf(format string, v ...any)
	Fatalf(format string, v ...any)

	With(attrs ...any) Logger
	WithGroup(name string) Logger

	// Write writes a message to the logger in free form.
	Write(string)
}

func FromContext

func FromContext(ctx context.Context) Logger

FromContext returns a logger from the given context.

func NewLogger

func NewLogger(opts ...Option) Logger

type Option

type Option func(*Config)

func WithDebug

func WithDebug() Option

WithDebug sets the level of the logger to debug.

func WithFormat

func WithFormat(format string) Option

WithFormat sets the format of the logger (text or json).

func WithQuiet

func WithQuiet() Option

WithQuiet suppresses output to stderr.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter sets the file to write logs to.