logging

Documentation

Index

• func NewLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter
• func NewSlogLogger(opts SlogOptions) *slog.Logger
• func ParseLogLevelFromEnv(key string) slog.Level
• func ParseLogLevelFromString(s string) slog.Level
• type HttpLogger
  • func NewHttpLogger(opts HttpLoggerOptions) *HttpLogger
  • func (h *HttpLogger) Use(next http.Handler) http.Handler
• type HttpLoggerOptions
• type Logger
  • func New(options *Options) (Logger, error)
  • func NewOrDie(options *Options) Logger
• type Options
• type SlogOptions

Functions

func NewLoggingResponseWriter

func NewLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter

func NewSlogLogger

func NewSlogLogger(opts SlogOptions) *slog.Logger

func ParseLogLevelFromEnv

func ParseLogLevelFromEnv(key string) slog.Level

func ParseLogLevelFromString

func ParseLogLevelFromString(s string) slog.Level

Types

type HttpLogger

type HttpLogger struct {
	HttpLoggerOptions
}

func NewHttpLogger

func NewHttpLogger(opts HttpLoggerOptions) *HttpLogger

func (*HttpLogger) Use

func (h *HttpLogger) Use(next http.Handler) http.Handler

type HttpLoggerOptions

type HttpLoggerOptions struct {
	// Logger, can be set if you want to use a different logger than the one provided by the HttpLogger
	Logger *slog.Logger

	// LogLevel, can be set if you want to use a different log level than the one provided by the HttpLogger
	// defaults to log.DebugLevel
	LogLevel    log.Level
	ShowHeaders bool
	SilentPaths []string
}

type Logger

type Logger interface {
	Debugf(msg string, args ...any)
	Infof(msg string, args ...any)
	Errorf(err error, msg string, args ...any)
	Error(err error)
	Warnf(msg string, args ...any)
	WithKV(key string, value any) Logger
	WithName(name string) Logger
	WithOptions(options ...zap.Option) Logger
}

func New

func New(options *Options) (Logger, error)

func NewOrDie

func NewOrDie(options *Options) Logger

type Options

type Options struct {
	Name        string
	Dev         bool
	CallerTrace bool
}

type SlogOptions

type SlogOptions struct {
	Writer io.Writer
	Prefix string

	ShowTimestamp bool
	ShowCaller    bool
	ShowDebugLogs bool
}