logging

Documentation

Index

• Constants
• func FromContext(ctx context.Context) *zap.SugaredLogger
• func InitLogger(level LogLevel, opts ...zap.Option)
• func SetLogger(t *testing.T, testLogger *zap.SugaredLogger)
• func WithLogger(ctx context.Context, fields ...interface{}) context.Context
• type LogLevel
  • func ParseLevel(level string) (LogLevel, error)

Constants

const (
	Debug          LogLevel   = "debug"
	Info           LogLevel   = "info"
	Warn           LogLevel   = "warn"
	Error          LogLevel   = "error"
	DPanic         LogLevel   = "dpanic"
	Panic          LogLevel   = "panic"
	Fatal          LogLevel   = "fatal"
	ChildLoggerKey contextKey = "childLogger"
	DocumentHash              = "documentHash"
)

Functions

func FromContext

func FromContext(ctx context.Context) *zap.SugaredLogger

func InitLogger

func InitLogger(level LogLevel, opts ...zap.Option)

Initializes the logger with the input level, defaulting to Info if the input is invalid

func SetLogger

func SetLogger(t *testing.T, testLogger *zap.SugaredLogger)

SetLoggerForTest allows temporarily replacing the global logger for testing purposes. It registers a cleanup function with the testing.T instance to revert the logger.

func WithLogger

func WithLogger(ctx context.Context, fields ...interface{}) context.Context

Attaches the logger to the input context, optionally adding a number of fields to the logging context. The fields should be key-value pairs.

Types

type LogLevel

type LogLevel string

func ParseLevel

func ParseLevel(level string) (LogLevel, error)

convert a string to the LogLevel type