logging

Documentation

Index

• Constants
• func Enable() error
• func Init(cmd *cobra.Command) error
• func ParseLogLevelsFromArgs(in []string) (map[string]Level, error)
• func Runner(cmd *cobra.Command, args []string) error
• func WithLevel(l *zerolog.Logger, level Level) *zerolog.Event
• func WithSamplingPeriod(p time.Duration) func(o *LoggerOptions)
• type Config
• type Factory
  • func Global() Factory
  • func NewDefaultFactory() Factory
  • func NewFactory(root zerolog.Logger) Factory
• type Level
  • func ParseLogLevel(in string) (Level, error)
  • func (l Level) New() *Level
  • func (l Level) String() string
• type Logger
• type LoggerIO
• type LoggerOptions
• type Sampler
  • func NewLogEventSampler(period time.Duration) Sampler
• type Wrap
  • func Bool(key string, i bool) Wrap
  • func Dur(key string, dur time.Duration) Wrap
  • func Err(err error) Wrap
  • func HTTPRequestWrap(request *http.Request) Wrap
  • func Int(key string, i int) Wrap
  • func Int32(key string, i int32) Wrap
  • func Int64(key string, i int64) Wrap
  • func Interface(key string, i interface{}) Wrap
  • func JSON(key string, item any) Wrap
  • func SinceStart(key string, start time.Time) Wrap
  • func Str(key, value string) Wrap
  • func Strs(key string, values ...string) Wrap
  • func Time(key string, time time.Time) Wrap
• type WrapObj

Constants

const (
	Trace = Level(zerolog.TraceLevel)
	Debug = Level(zerolog.DebugLevel)
	Info  = Level(zerolog.InfoLevel)
	Warn  = Level(zerolog.WarnLevel)
	Error = Level(zerolog.ErrorLevel)
	Fatal = Level(zerolog.FatalLevel)
)

const TopicAll = "all"

Functions

func Enable

func Enable() error

func Init

func Init(cmd *cobra.Command) error

func ParseLogLevelsFromArgs

func ParseLogLevelsFromArgs(in []string) (map[string]Level, error)

func Runner

func Runner(cmd *cobra.Command, args []string) error

func WithLevel

func WithLevel(l *zerolog.Logger, level Level) *zerolog.Event

func WithSamplingPeriod

func WithSamplingPeriod(p time.Duration) func(o *LoggerOptions)

Types

type Config

type Config struct {
	Levels   map[string]Level
	Sampling bool
}

type Factory

type Factory interface {
	Get(name string, opts ...func(*LoggerOptions)) Logger

	LogLevels() map[string]Level
	Configure(cfg Config)
	ApplyLogLevels(in map[string]Level)
	SetRoot(log zerolog.Logger)

	RegisterLogger(name string, level Level) bool
	RegisterAndGetLogger(name string, level Level, opts ...func(*LoggerOptions)) Logger

	RegisterWrappers(w ...Wrap)

	Names() []string
}

func Global

func Global() Factory

func NewDefaultFactory

func NewDefaultFactory() Factory

func NewFactory

func NewFactory(root zerolog.Logger) Factory

type Level

type Level zerolog.Level

func ParseLogLevel

func ParseLogLevel(in string) (Level, error)

func (Level) New

func (l Level) New() *Level

func (Level) String

func (l Level) String() string

type Logger

type Logger interface {
	Wrap(w Wrap) Logger
	WrapObj(w WrapObj) Logger

	Bool(key string, i bool) Logger
	Str(key, value string) Logger
	JSON(key string, value any) Logger
	Strs(key string, values ...string) Logger
	SinceStart(key string, start time.Time) Logger
	Err(err error) Logger
	Int(key string, i int) Logger
	Int32(key string, i int32) Logger
	Int64(key string, i int64) Logger
	Interface(key string, i interface{}) Logger
	Dur(key string, dur time.Duration) Logger
	Time(key string, time time.Time) Logger
	Stack() Logger

	Trace(msg string, args ...interface{})
	Debug(msg string, args ...interface{})
	Info(msg string, args ...interface{})
	Warn(msg string, args ...interface{})
	Error(msg string, args ...interface{})
	Fatal(msg string, args ...interface{})

	TraceIO() LoggerIO
	DebugIO() LoggerIO
	InfoIO() LoggerIO
	WarnIO() LoggerIO
	ErrorIO() LoggerIO
	FatalIO() LoggerIO
}

type LoggerIO

type LoggerIO interface {
	io.Writer
}

type LoggerOptions

type LoggerOptions struct {
	SamplingPeriod time.Duration
}

type Sampler

type Sampler interface {
	// Sample returns true if the event should be part of the sample, false if
	// the event should be dropped.
	Sample(level Level, msg string, args ...any) bool
}

Sampler defines an interface to a log sampler.

func NewLogEventSampler

func NewLogEventSampler(period time.Duration) Sampler

type Wrap

type Wrap func(in *zerolog.Event) *zerolog.Event

func Bool

func Bool(key string, i bool) Wrap

func Dur

func Dur(key string, dur time.Duration) Wrap

func Err

func Err(err error) Wrap

func HTTPRequestWrap

func HTTPRequestWrap(request *http.Request) Wrap

func Int

func Int(key string, i int) Wrap

func Int32

func Int32(key string, i int32) Wrap

func Int64

func Int64(key string, i int64) Wrap

func Interface

func Interface(key string, i interface{}) Wrap

func JSON

func JSON(key string, item any) Wrap

func SinceStart

func SinceStart(key string, start time.Time) Wrap

func Str

func Str(key, value string) Wrap

func Strs

func Strs(key string, values ...string) Wrap

func Time

func Time(key string, time time.Time) Wrap

type WrapObj

type WrapObj interface {
	WrapLogger(in *zerolog.Event) *zerolog.Event
}