logging

Documentation

Index

• Variables
• func DefaultFormatter(i Instance, l, m string) string
• func DefaultKlogFormatter(i Instance, l, m string) string
• func InitManager(options ...Option)
• func StdErrLog(a ...any)
• func ValidateLogLevel(l string) (string, error)
• type FakeInstance
  • func (i *FakeInstance) Critical(f string)
  • func (i *FakeInstance) Criticalf(f string, a ...interface{})
  • func (i *FakeInstance) Debug(f string)
  • func (i *FakeInstance) Debugf(f string, a ...interface{})
  • func (i *FakeInstance) Fatal(f string)
  • func (i *FakeInstance) Fatalf(f string, a ...interface{})
  • func (i *FakeInstance) GetLevel() string
  • func (i *FakeInstance) GetName() string
  • func (i *FakeInstance) Info(f string)
  • func (i *FakeInstance) Infof(f string, a ...interface{})
  • func (i *FakeInstance) Warn(f string)
  • func (i *FakeInstance) Warnf(f string, a ...interface{})
  • func (i *FakeInstance) Write(p []byte) (n int, err error)
• type Formatter
• type Instance
• type Manager
  • func GetManager() Manager
• type Option
  • func WithLogger(logger func(...interface{})) Option

Variables

var ErrLoggingInstance = errors.New("errLoggingInstance")

ErrLoggingInstance is the error returned when encountering issues registering, removing, fetching, or updating logging instances from the logging Manager.

Functions

func DefaultFormatter

func DefaultFormatter(i Instance, l, m string) string

DefaultFormatter is the default logging instance formatter -- this formatter simply adds colors to the log message based on log level.

func DefaultKlogFormatter

func DefaultKlogFormatter(i Instance, l, m string) string

DefaultKlogFormatter is the default logging instance formatter for *klog* logs. Ortica redirects klog logs through its own logging manager to give us more control, this formatter is applied by default to those messages only.

func InitManager

func InitManager(options ...Option)

InitManager initializes the logging manager with the provided options. It does nothing if the manager has already been initialized. This may be a bit awkward but since this is not expected to be used by anything but clabernetes and it works for us, it works!

func StdErrLog

func StdErrLog(a ...any)

StdErrLog writes `a` to stderr, it ignores failures.

func ValidateLogLevel

func ValidateLogLevel(l string) (string, error)

ValidateLogLevel accepts a string l and returns a case-normalized log level corresponding to l, if l is a valid log level, or an error.

Types

type FakeInstance

type FakeInstance struct{}

FakeInstance is a fake logging instance that does nothing.

func (*FakeInstance) Critical

func (i *FakeInstance) Critical(f string)

func (*FakeInstance) Criticalf

func (i *FakeInstance) Criticalf(f string, a ...interface{})

func (*FakeInstance) Debug

func (i *FakeInstance) Debug(f string)

func (*FakeInstance) Debugf

func (i *FakeInstance) Debugf(f string, a ...interface{})

func (*FakeInstance) Fatal

func (i *FakeInstance) Fatal(f string)

func (*FakeInstance) Fatalf

func (i *FakeInstance) Fatalf(f string, a ...interface{})

func (*FakeInstance) GetLevel

func (i *FakeInstance) GetLevel() string

func (*FakeInstance) GetName

func (i *FakeInstance) GetName() string

func (*FakeInstance) Info

func (i *FakeInstance) Info(f string)

func (*FakeInstance) Infof

func (i *FakeInstance) Infof(f string, a ...interface{})

func (*FakeInstance) Warn

func (i *FakeInstance) Warn(f string)

func (*FakeInstance) Warnf

func (i *FakeInstance) Warnf(f string, a ...interface{})

func (*FakeInstance) Write

func (i *FakeInstance) Write(p []byte) (n int, err error)

type Formatter

type Formatter func(i Instance, l, m string) string

Formatter is a type representing a valid logging formatter function. It should accept a logging instance, a level string, and a message string, returning a formatted message string.

type Instance

type Instance interface {
	Debug(f string)
	Debugf(f string, a ...interface{})
	Info(f string)
	Infof(f string, a ...interface{})
	Warn(f string)
	Warnf(f string, a ...interface{})
	Critical(f string)
	Criticalf(f string, a ...interface{})
	Fatal(f string)
	Fatalf(f string, a ...interface{})
	// Write implements io.Writer so that an instance can be used most places. Messages received
	// via Write will always have the current formatter applied, and all messages will be queued
	// for egress unless this logging instance's level is Disabled.
	Write(p []byte) (n int, err error)
	GetName() string
	GetLevel() string
}

Instance is a logging instance managed by the Manager.

type Manager

type Manager interface {
	SetLoggerFormatter(name string, formatter Formatter) error
	SetLoggerFormatterAllInstances(formatter Formatter)
	SetLoggerLevelAllInstances(level string)
	SetLoggerLevel(name, level string) error
	RegisterLogger(name, level string) error
	RegisterAndGetLogger(name, level string) (Instance, error)
	MustRegisterAndGetLogger(name, level string) Instance
	GetLogger(name string) (Instance, error)
	DeleteLogger(name string)
	Flush()
}

Manager is the interface representing the global logging manager singleton, this interface defines the ways to interact with this object.

func GetManager

func GetManager() Manager

GetManager returns the global logging Manager. Panics if the logging manager has *not* been initialized (via InitManager).

type Option

type Option func(m *manager)

Option is a functional option type for applying options to the logging Manager.

func WithLogger

func WithLogger(logger func(...interface{})) Option

WithLogger appends a logger (a function that accepts an interface) to the logging Manager's set of loggers.