log

Documentation

Overview

Package log provides context-aware and structured logging capabilities.

Index

• func WithRequest(ctx context.Context, req *http.Request) context.Context
• type Logger
  • func New() Logger
  • func NewForTest() (Logger, *observer.ObservedLogs)
  • func NewWithZap(l *zap.Logger) Logger

Functions

func WithRequest

func WithRequest(ctx context.Context, req *http.Request) context.Context

WithRequest returns a context which knows the request ID and correlation ID in the given request.

Types

type Logger

type Logger interface {
	// With returns a logger based off the root logger and decorates it with the given context and arguments.
	With(ctx context.Context, args ...interface{}) Logger

	// Debug uses fmt.Sprint to construct and log a message at DEBUG level
	Debug(args ...interface{})
	// Info uses fmt.Sprint to construct and log a message at INFO level
	Info(args ...interface{})
	// Error uses fmt.Sprint to construct and log a message at ERROR level
	Error(args ...interface{})

	// Debugf uses fmt.Sprintf to construct and log a message at DEBUG level
	Debugf(format string, args ...interface{})
	// Infof uses fmt.Sprintf to construct and log a message at INFO level
	Infof(format string, args ...interface{})
	// Errorf uses fmt.Sprintf to construct and log a message at ERROR level
	Errorf(format string, args ...interface{})
}

Logger is a logger that supports log levels, context and structured logging.

func New

func New() Logger

New creates a new logger using the default configuration.

func NewForTest

func NewForTest() (Logger, *observer.ObservedLogs)

NewForTest returns a new logger and the corresponding observed logs which can be used in unit tests to verify log entries.

func NewWithZap

func NewWithZap(l *zap.Logger) Logger

NewWithZap creates a new logger using the preconfigured zap logger.