nlogger

Documentation

Index

• Constants
• Variables
• func SetInContext(ctx context.Context, logger Logger) context.Context
• type Logger
  • func FromContext(ctx context.Context) Logger
  • func MustFromContext(ctx context.Context) Logger
  • func New(target io.Writer, prefix string) Logger
• type Provider
  • func NewProvider(l Logger) Provider

Constants

const LoggerKey loggerKey = "logger"

LoggerKey is the key to access the logger in context

Variables

var ErrLoggerNotFoundInContext = errors.New("Logger not found in context")

ErrLoggerNotFoundInContext is the error when calling MustFromContext and the logger is not found

Functions

func SetInContext

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

SetInContext sets the logger in a context and returns the new context

Types

type Logger

type Logger interface {
	Debug(string)
	Info(string)
	Warn(string)
	Error(string)
	Fatal(string)
}

Logger is a generic Logger interface

func FromContext

func FromContext(ctx context.Context) Logger

FromContext gets the logger from context. If context does not exist, it returns nil.

func MustFromContext

func MustFromContext(ctx context.Context) Logger

MustFromContext gets the logger from context. If context does not exist, it panics with a ErrLoggerNotFoundInContext.

func New

func New(target io.Writer, prefix string) Logger

New will return a default logger instance

type Provider

type Provider interface {
	// Get returns the Provider's attached logger in a thread safe manner
	Get() Logger
	// Replace replaces the provider's internal logger in a thread safe manner
	Replace(Logger)
}

Provider is an interface to get a thread safe logger provider with the ability to replace the internal logger provided

func NewProvider

func NewProvider(l Logger) Provider

NewProvider returns a new Logger Provider from the given Logger l