logger

Documentation

Index

• Constants
• Variables
• func AddWriter(logger *logrus.Logger, writer io.Writer) *logrus.Logger
• func NewFieldLogger(logger logrus.FieldLogger, fieldKey, fieldValue string) *logrus.Entry
• func NewIDLogger(logger logrus.FieldLogger) logrus.FieldLogger
• func NewLogger(logLevel string, format string) *logrus.Logger
• func NewNopLogger() *logrus.Logger
• func NewShootLogger(logger logrus.FieldLogger, shoot, project string) *logrus.Entry
• func NewZapLogger(logLevel string, format string) (*zap.Logger, error)
• func NewZapLogr(logger *zap.Logger) logr.Logger

Constants

const (
	// DebugLevel is the debug log level, i.e. the most verbose.
	DebugLevel = "debug"
	// InfoLevel is the default log level.
	InfoLevel = "info"
	// ErrorLevel is a log level where only errors are logged.
	ErrorLevel = "error"

	// FormatJSON is the output type that produces a JSON object per log line.
	FormatJSON = "json"
	// FormatText outputs the log as human-readable text.
	FormatText = "text"
)

const IDFieldName = "process_id"

IDFieldName is the name of the id field for a logger.

Variables

var (
	// AllLogLevels is a slice of all available log levels.
	AllLogLevels = []string{DebugLevel, InfoLevel, ErrorLevel}

	// AllLogFormats is a slice of all available log formats.
	AllLogFormats = []string{FormatJSON, FormatText}
)

var Logger *logrus.Logger

Logger is the standard logger for the Gardener which is used for all messages which are not Shoot cluster specific.

Functions

func AddWriter

func AddWriter(logger *logrus.Logger, writer io.Writer) *logrus.Logger

AddWriter returns a logger that uses the tests writer (e.g., GingkoWriter) as output channel

func NewFieldLogger

func NewFieldLogger(logger logrus.FieldLogger, fieldKey, fieldValue string) *logrus.Entry

NewFieldLogger extends an existing logrus logger and adds the provided additional field. Example output: time="2017-06-08T13:00:49+02:00" level=info msg="something" <fieldKey>=<fieldValue>.

func NewIDLogger

func NewIDLogger(logger logrus.FieldLogger) logrus.FieldLogger

NewIDLogger extends an existing logrus logger with a randomly generated id field. Example output: time="2017-06-08T13:00:49+02:00" level=info msg="something" id=123abcde.

func NewLogger

func NewLogger(logLevel string, format string) *logrus.Logger

NewLogger creates a new logrus logger. It uses STDERR as output channel and evaluates the value of the --log-level command line argument in order to set the log level. Example output: time="2017-06-08T13:00:28+02:00" level=info msg="gardener started successfully".

func NewNopLogger

func NewNopLogger() *logrus.Logger

NewNopLogger instantiates a new logger that logs to ioutil.Discard.

func NewShootLogger

func NewShootLogger(logger logrus.FieldLogger, shoot, project string) *logrus.Entry

NewShootLogger extends an existing logrus logger and adds an additional field containing the Shoot cluster name and the project in the Garden cluster to the output. If an <operationID> is provided it will be printed for every log message. Example output: time="2017-06-08T13:00:49+02:00" level=info msg="Creating namespace in seed cluster" shoot=core/crazy-botany.

func NewZapLogger

func NewZapLogger(logLevel string, format string) (*zap.Logger, error)

NewZapLogger creates a new logger backed by Zap.

func NewZapLogr

func NewZapLogr(logger *zap.Logger) logr.Logger

NewZapLogr wraps a Zap logger into a standard logr-compatible logger.