logging

Documentation

Index

• type LogLevel
• type Logger
  • func InitLogger(level LogLevel) Logger
  • func (l Logger) WithName(name string) Logger
  • func (l Logger) WithValues(keysAndValues ...interface{}) Logger

Types

type LogLevel

type LogLevel string

LogLevel defines a log level for system logs.

const (
	// LogLevelDebug defines the "debug" logging level.
	LogLevelDebug LogLevel = "debug"

	// LogLevelInfo defines the "Info" logging level.
	LogLevelInfo LogLevel = "info"

	// LogLevelWarn defines the "Warn" logging level.
	LogLevelWarn LogLevel = "warn"

	// LogLevelError defines the "Error" logging level.
	LogLevelError LogLevel = "error"
)

type Logger

type Logger struct {
	logr.Logger

	Sugar *zap.SugaredLogger
	// contains filtered or unexported fields
}

Logger 's Sugar A Sugar wraps the base Logger functionality in a slower, but less verbose, API. Any Logger can be converted to a SugaredLogger with its Sugar method.

Unlike the Logger, the SugaredLogger doesn't insist on structured logging. For each log level, it exposes four methods:

• methods named after the log level for log.Print-style logging
• methods ending in "w" for loosely-typed structured logging
• methods ending in "f" for log.Printf-style logging
• methods ending in "ln" for log.Println-style logging

For example, the methods for InfoLevel are:

Info(...any)           Print-style logging
Infow(...any)          Structured logging (read as "info with")
Infof(string, ...any)  Printf-style logging
Infoln(...any)         Println-style logging

func InitLogger

func InitLogger(level LogLevel) Logger

func (Logger) WithName

func (l Logger) WithName(name string) Logger

WithName returns a new Logger instance with the specified name element added to the Logger's name. Successive calls with WithName append additional suffixes to the Logger's name. It's strongly recommended that name segments contain only letters, digits, and hyphens (see the package documentation for more information).

func (Logger) WithValues

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

WithValues returns a new Logger instance with additional key/value pairs. See Info for documentation on how key/value pairs work.