logger

Documentation

Index

• func Debugw(msg string, keysAndValues ...interface{})
• func Errorw(msg string, err error, keysAndValues ...interface{})
• func Infow(msg string, keysAndValues ...interface{})
• func InitFromConfig(conf *Config, name string)
• func NewSlogDiscard() slog.Handler
• func ParseZapLevel(level string) zapcore.Level
• func Proto(val proto.Message) zapcore.ObjectMarshaler
• func SetLogger(l Logger, name string)
• func ToSlogHandler(log Logger) slog.Handler
• func Warnw(msg string, err error, keysAndValues ...interface{})
• type Config
  • func (c *Config) AddUpdateObserver(cb ConfigObserver)
  • func (c *Config) Update(o *Config) error
• type ConfigObserver
• type DeferredFieldResolver
• type LogRLogger
  • func (l LogRLogger) Debugw(msg string, keysAndValues ...interface{})
  • func (l LogRLogger) Errorw(msg string, err error, keysAndValues ...interface{})
  • func (l LogRLogger) Infow(msg string, keysAndValues ...interface{})
  • func (l LogRLogger) Warnw(msg string, err error, keysAndValues ...interface{})
  • func (l LogRLogger) WithCallDepth(depth int) Logger
  • func (l LogRLogger) WithComponent(component string) Logger
  • func (l LogRLogger) WithDeferredValues() (Logger, DeferredFieldResolver)
  • func (l LogRLogger) WithItemSampler() Logger
  • func (l LogRLogger) WithName(name string) Logger
  • func (l LogRLogger) WithValues(keysAndValues ...interface{}) Logger
  • func (l LogRLogger) WithoutSampler() Logger
• type Logger
  • func GetLogger() Logger
• type ZapComponentLeveler
• type ZapLogger
  • func FromZapLogger(log *zap.Logger, conf *Config, opts ...ZapLoggerOption) (ZapLogger, error)
  • func NewZapLogger(conf *Config, opts ...ZapLoggerOption) (ZapLogger, error)
• type ZapLoggerOption
  • func WithTap(tap *zaputil.WriteEnabler) ZapLoggerOption

Functions

func Debugw

func Debugw(msg string, keysAndValues ...interface{})

func Errorw

func Errorw(msg string, err error, keysAndValues ...interface{})

func Infow

func Infow(msg string, keysAndValues ...interface{})

func InitFromConfig

func InitFromConfig(conf *Config, name string)

InitFromConfig initializes a Zap-based logger

func NewSlogDiscard

func NewSlogDiscard() slog.Handler

NewSlogDiscard creates a slog.Handler that discards all logs.

func ParseZapLevel

func ParseZapLevel(level string) zapcore.Level

func Proto

func Proto(val proto.Message) zapcore.ObjectMarshaler

func SetLogger

func SetLogger(l Logger, name string)

SetLogger lets you use a custom logger. Pass in a logr.Logger with default depth

func ToSlogHandler

func ToSlogHandler(log Logger) slog.Handler

ToSlogHandler converts Logger to slog.Handler.

func Warnw

func Warnw(msg string, err error, keysAndValues ...interface{})

Types

type Config

type Config struct {
	JSON  bool   `yaml:"json,omitempty"`
	Level string `yaml:"level,omitempty"`
	// true to enable log sampling, where the same log message and level will be throttled.
	// we have two layers of sampling
	// 1. global sampling - within a second, it will log the first SampleInitial, then every SampleInterval messages.
	// 2. per participant/track sampling - to be used with Logger.WithItemSampler(). This would be used to throttle
	//    the logs for a particular participant/track.
	Sample bool `yaml:"sample,omitempty"`

	ComponentLevels map[string]string `yaml:"component_levels,omitempty"`

	// global sampling per server
	// when sampling, the first N logs will be logged
	SampleInitial int `yaml:"sample_initial,omitempty"`
	// when sampling, every Mth log will be logged
	SampleInterval int `yaml:"sample_interval,omitempty"`

	// participant/track level sampling
	ItemSampleSeconds  int `yaml:"item_sample_seconds,omitempty"`
	ItemSampleInitial  int `yaml:"item_sample_initial,omitempty"`
	ItemSampleInterval int `yaml:"item_sample_interval,omitempty"`
	// contains filtered or unexported fields
}

func (*Config) AddUpdateObserver

func (c *Config) AddUpdateObserver(cb ConfigObserver)

func (*Config) Update

func (c *Config) Update(o *Config) error

type ConfigObserver

type ConfigObserver func(*Config) error

type DeferredFieldResolver

type DeferredFieldResolver = zaputil.DeferredFieldResolver

type LogRLogger

type LogRLogger logr.Logger

func (LogRLogger) Debugw

func (l LogRLogger) Debugw(msg string, keysAndValues ...interface{})

func (LogRLogger) Errorw

func (l LogRLogger) Errorw(msg string, err error, keysAndValues ...interface{})

func (LogRLogger) Infow

func (l LogRLogger) Infow(msg string, keysAndValues ...interface{})

func (LogRLogger) Warnw

func (l LogRLogger) Warnw(msg string, err error, keysAndValues ...interface{})

func (LogRLogger) WithCallDepth

func (l LogRLogger) WithCallDepth(depth int) Logger

func (LogRLogger) WithComponent

func (l LogRLogger) WithComponent(component string) Logger

func (LogRLogger) WithDeferredValues

func (l LogRLogger) WithDeferredValues() (Logger, DeferredFieldResolver)

func (LogRLogger) WithItemSampler

func (l LogRLogger) WithItemSampler() Logger

func (LogRLogger) WithName

func (l LogRLogger) WithName(name string) Logger

func (LogRLogger) WithValues

func (l LogRLogger) WithValues(keysAndValues ...interface{}) Logger

func (LogRLogger) WithoutSampler

func (l LogRLogger) WithoutSampler() Logger

type Logger

type Logger interface {
	Debugw(msg string, keysAndValues ...interface{})
	Infow(msg string, keysAndValues ...interface{})
	Warnw(msg string, err error, keysAndValues ...interface{})
	Errorw(msg string, err error, keysAndValues ...interface{})
	WithValues(keysAndValues ...interface{}) Logger
	WithName(name string) Logger
	// WithComponent creates a new logger with name as "<name>.<component>", and uses a log level as specified
	WithComponent(component string) Logger
	WithCallDepth(depth int) Logger
	WithItemSampler() Logger
	// WithoutSampler returns the original logger without sampling
	WithoutSampler() Logger
	WithDeferredValues() (Logger, DeferredFieldResolver)
}

func GetLogger

func GetLogger() Logger

GetLogger returns the logger that was set with SetLogger with an extra depth of 1

type ZapComponentLeveler

type ZapComponentLeveler interface {
	ComponentLevel(component string) zapcore.LevelEnabler
}

type ZapLogger

type ZapLogger interface {
	Logger
	ToZap() *zap.SugaredLogger
	ComponentLeveler() ZapComponentLeveler
}

func FromZapLogger

func FromZapLogger(log *zap.Logger, conf *Config, opts ...ZapLoggerOption) (ZapLogger, error)

func NewZapLogger

func NewZapLogger(conf *Config, opts ...ZapLoggerOption) (ZapLogger, error)

type ZapLoggerOption

type ZapLoggerOption func(*zapConfig)

func WithTap

func WithTap(tap *zaputil.WriteEnabler) ZapLoggerOption