logging

Documentation

Index

• func NewRootLogger(options LoggerOutputOptions) (zerolog.Logger, func())
• func RegisterContextProvider(p ContextProvider)
• func With(ctx context.Context, log zerolog.Logger) zerolog.Context
• type ContextProvider
• type LoggerOutputOptions
• type Service
  • func NewService(defaultLevel string, options LoggerOutputOptions) (Service, error)

Functions

func NewRootLogger

func NewRootLogger(options LoggerOutputOptions) (zerolog.Logger, func())

NewRootLogger creates a new zerolog logger with default settings.

func RegisterContextProvider

func RegisterContextProvider(p ContextProvider)

RegisterContextProvider records a given context provider. This method is supposed to be called in an `init` method.

func With

func With(ctx context.Context, log zerolog.Logger) zerolog.Context

With creates a zerolog Context that contains all information available in the given context.

Types

type ContextProvider

type ContextProvider func(ctx context.Context, c zerolog.Context) zerolog.Context

type LoggerOutputOptions

type LoggerOutputOptions struct {
	Color   bool   // Produce colored logs
	JSON    bool   // Project JSON messages
	Stderr  bool   // Write logs to stderr
	LogFile string // Path of file to write to
}

type Service

type Service interface {
	// MustGetLogger creates a logger with given name.
	MustGetLogger(name string) zerolog.Logger
	// MustSetLevel sets the log level for the component with given name to given level.
	MustSetLevel(name, level string)
	// RotateLogFiles re-opens log file writer.
	RotateLogFiles()
}

Service exposes the interfaces for a logger service that supports different loggers with different levels.

func NewService

func NewService(defaultLevel string, options LoggerOutputOptions) (Service, error)

NewService creates a new Service.