log

Documentation

Overview

Package log defines the interfaces used for logging in virtual-kubelet. It uses a context.Context to store logger details. Additionally you can set the default logger to use by setting log.L. This is used when no logger is stored in the passed in context.

Index

• func WithLogger(ctx context.Context, logger Logger) context.Context
• type Fields
• type Logger
  • func GetLogger(ctx context.Context) Logger

Functions

func WithLogger

func WithLogger(ctx context.Context, logger Logger) context.Context

WithLogger returns a new context with the provided logger. Use in combination with logger.WithField(s) for great effect.

Types

type Fields

type Fields map[string]interface{}

Fields allows setting multiple fields on a logger at one time.

type Logger

type Logger interface {
	Debug(...interface{})
	Debugf(string, ...interface{})
	Info(...interface{})
	Infof(string, ...interface{})
	Warn(...interface{})
	Warnf(string, ...interface{})
	Error(...interface{})
	Errorf(string, ...interface{})
	Fatal(...interface{})
	Fatalf(string, ...interface{})

	WithField(string, interface{}) Logger
	WithFields(Fields) Logger
	WithError(error) Logger
}

Logger is the interface used for logging in virtual-kubelet

virtual-kubelet will access the logger via context using `GetLogger` (or its alias, `G`) You can set the default logger to use by setting the `L` variable.

var (
	// G is an alias for GetLogger.
	G = GetLogger

	// L is the default logger. It should be initialized before using `G` or `GetLogger`
	// If L is uninitialized and no logger is available in a provided context, a
	// panic will occur.
	L Logger = nopLogger{}
)

func GetLogger

func GetLogger(ctx context.Context) Logger

GetLogger retrieves the current logger from the context. If no logger is available, the default logger is returned.