logging

Documentation

Index

• type Logger
  • func NewLogrLogger(l logr.Logger) Logger
  • func NewNopLogger() Logger

Types

type Logger

type Logger interface {
	// Info logs a message with optional structured data. Structured data must
	// be supplied as an array that alternates between string keys and values of
	// an arbitrary type.
	Info(msg string, keysAndValues ...interface{})

	// Debug logs a message with optional structured data. Structured data must
	// be supplied as an array that alternates between string keys and values of
	// an arbitrary type.
	Debug(msg string, keysAndValues ...interface{})

	// WithValues returns a Logger that will include the supplied structured
	// data with any subsequent messages it logs. Structured data must
	// be supplied as an array that alternates between string keys and values of
	// an arbitrary type.
	WithValues(keysAndValues ...interface{}) Logger
}

A Logger logs messages. Messages may be supplemented by structured data.

func NewLogrLogger

func NewLogrLogger(l logr.Logger) Logger

NewLogrLogger returns a Logger that is satisfied by the supplied logr.Logger, which may be satisfied in turn by various logging implementations (Zap, klog, etc).

func NewNopLogger

func NewNopLogger() Logger

NewNopLogger returns a Logger that does nothing.