log

Documentation

Index

• Variables
• func CheckFatal(location string, err error, logger log.Logger)
• func Flush() error
• func InitLogger(cfg *server.Config, reg prometheus.Registerer, sync bool) log.Logger
• func LevelHandler(currentLogLevel *dslog.Level) http.HandlerFunc
• func WarnExperimentalUse(feature string, logger log.Logger)
• func WithContext(ctx context.Context, l log.Logger) log.Logger
• func WithUserID(userID string, l log.Logger) log.Logger
• type Flusher

Variables

var (
	// Logger is a shared go-kit logger.
	// TODO: Change all components to take a non-global logger via their constructors.
	// Prefer accepting a non-global logger as an argument.
	Logger = log.NewNopLogger()
)

Functions

func CheckFatal

func CheckFatal(location string, err error, logger log.Logger)

CheckFatal prints an error and exits with error code 1 if err is non-nil.

func Flush

func Flush() error

func InitLogger

func InitLogger(cfg *server.Config, reg prometheus.Registerer, sync bool) log.Logger

InitLogger initialises the global gokit logger (util_log.Logger) and returns that logger.

func LevelHandler

func LevelHandler(currentLogLevel *dslog.Level) http.HandlerFunc

LevelHandler returns an http handler function that returns the current log level. The optional query parameter 'log_level' can be passed to change the log level at runtime.

func WarnExperimentalUse

func WarnExperimentalUse(feature string, logger log.Logger)

WarnExperimentalUse logs a warning and increments the experimental features metric.

func WithContext

func WithContext(ctx context.Context, l log.Logger) log.Logger

WithContext returns a log.Logger that has information about the current user in its details.

e.g.

log := util.WithContext(ctx)
log.Errorf("Could not chunk chunks: %v", err)

func WithUserID

func WithUserID(userID string, l log.Logger) log.Logger

WithUserID returns a Logger that has information about the current user in its details.

Types

type Flusher

type Flusher interface {
	Flush() error
}