logger

Documentation

Overview

Defines global context-aware logger. The default implementation uses logrus. This package registers "logger" config section on init(). The structure of the config section is expected to be un-marshal-able to Config struct.

Index

• func Debug(ctx context.Context, args ...interface{})
• func Debugf(ctx context.Context, format string, args ...interface{})
• func Debugln(ctx context.Context, args ...interface{})
• func Error(ctx context.Context, args ...interface{})
• func Errorf(ctx context.Context, format string, args ...interface{})
• func Errorln(ctx context.Context, args ...interface{})
• func Fatal(ctx context.Context, args ...interface{})
• func Fatalf(ctx context.Context, format string, args ...interface{})
• func Fatalln(ctx context.Context, args ...interface{})
• func Info(ctx context.Context, args ...interface{})
• func Infof(ctx context.Context, format string, args ...interface{})
• func InfofNoCtx(format string, args ...interface{})
• func Infoln(ctx context.Context, args ...interface{})
• func IsLoggable(ctx context.Context, level Level) bool
• func Panic(ctx context.Context, args ...interface{})
• func Panicf(ctx context.Context, format string, args ...interface{})
• func Panicln(ctx context.Context, args ...interface{})
• func Print(ctx context.Context, args ...interface{})
• func Printf(ctx context.Context, format string, args ...interface{})
• func Println(ctx context.Context, args ...interface{})
• func SetConfig(cfg Config)
• func Warn(ctx context.Context, args ...interface{})
• func Warnf(ctx context.Context, format string, args ...interface{})
• func Warning(ctx context.Context, args ...interface{})
• func Warningf(ctx context.Context, format string, args ...interface{})
• func Warningln(ctx context.Context, args ...interface{})
• func Warnln(ctx context.Context, args ...interface{})
• func WithIndent(ctx context.Context, additionalIndent string) context.Context
• type Config
  • func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet
• type FormatterConfig
• type FormatterType
• type Level

Functions

func Debug

func Debug(ctx context.Context, args ...interface{})

Debug logs a message at level Debug on the standard logger.

func Debugf

func Debugf(ctx context.Context, format string, args ...interface{})

Debugf logs a message at level Debug on the standard logger.

func Debugln

func Debugln(ctx context.Context, args ...interface{})

Debugln logs a message at level Debug on the standard logger.

func Error

func Error(ctx context.Context, args ...interface{})

Error logs a message at level Error on the standard logger.

func Errorf

func Errorf(ctx context.Context, format string, args ...interface{})

Errorf logs a message at level Error on the standard logger.

func Errorln

func Errorln(ctx context.Context, args ...interface{})

Errorln logs a message at level Error on the standard logger.

func Fatal

func Fatal(ctx context.Context, args ...interface{})

Fatal logs a message at level Fatal on the standard logger.

func Fatalf

func Fatalf(ctx context.Context, format string, args ...interface{})

Fatalf logs a message at level Fatal on the standard logger.

func Fatalln

func Fatalln(ctx context.Context, args ...interface{})

Fatalln logs a message at level Fatal on the standard logger.

func Info

func Info(ctx context.Context, args ...interface{})

Info logs a message at level Info on the standard logger.

func Infof

func Infof(ctx context.Context, format string, args ...interface{})

Infof logs a message at level Info on the standard logger.

func InfofNoCtx

func InfofNoCtx(format string, args ...interface{})

InfofNoCtx logs a formatted message without context.

func Infoln

func Infoln(ctx context.Context, args ...interface{})

Infoln logs a message at level Info on the standard logger.

func IsLoggable

func IsLoggable(ctx context.Context, level Level) bool

Gets a value indicating whether logs at this level will be written to the logger. This is particularly useful to avoid computing log messages unnecessarily.

func Panic

func Panic(ctx context.Context, args ...interface{})

Panic logs a message at level Panic on the standard logger.

func Panicf

func Panicf(ctx context.Context, format string, args ...interface{})

Panicf logs a message at level Panic on the standard logger.

func Panicln

func Panicln(ctx context.Context, args ...interface{})

Panicln logs a message at level Panic on the standard logger.

func Print

func Print(ctx context.Context, args ...interface{})

Print logs a message at level Info on the standard logger.

func Printf

func Printf(ctx context.Context, format string, args ...interface{})

Printf logs a message at level Info on the standard logger.

func Println

func Println(ctx context.Context, args ...interface{})

Println logs a message at level Info on the standard logger.

func SetConfig

func SetConfig(cfg Config)

Sets global logger config

func Warn

func Warn(ctx context.Context, args ...interface{})

Warn logs a message at level Warn on the standard logger.

func Warnf

func Warnf(ctx context.Context, format string, args ...interface{})

Warnf logs a message at level Warn on the standard logger.

func Warning

func Warning(ctx context.Context, args ...interface{})

Warning logs a message at level Warn on the standard logger.

func Warningf

func Warningf(ctx context.Context, format string, args ...interface{})

Warningf logs a message at level Warn on the standard logger.

func Warningln

func Warningln(ctx context.Context, args ...interface{})

Warningln logs a message at level Warn on the standard logger.

func Warnln

func Warnln(ctx context.Context, args ...interface{})

Warnln logs a message at level Warn on the standard logger.

func WithIndent

func WithIndent(ctx context.Context, additionalIndent string) context.Context

Types

type Config

type Config struct {
	// Determines whether to include source code location in logs. This might incurs a performance hit and is only
	// recommended on debug/development builds.
	IncludeSourceCode bool `json:"show-source" pflag:",Includes source code location in logs."`

	// Determines whether the logger should mute all logs (including panics)
	Mute bool `json:"mute" pflag:",Mutes all logs regardless of severity. Intended for benchmarks/tests only."`

	// Determines the minimum log level to log.
	Level Level `json:"level" pflag:",Sets the minimum logging level."`

	Formatter FormatterConfig `json:"formatter" pflag:",Sets logging format."`
}

Global logger config.

func (Config) GetPFlagSet

func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet

GetPFlagSet will return strongly types pflags for all fields in Config and its nested types. The format of the flags is json-name.json-sub-name... etc.

type FormatterConfig

type FormatterConfig struct {
	Type FormatterType `json:"type" pflag:",Sets logging format type."`
}

type FormatterType

type FormatterType = string

const (
	FormatterJSON FormatterType = "json"
	FormatterText FormatterType = "text"
)

type Level

type Level = int

Level type.

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel Level = iota
	// FatalLevel level. Logs and then calls `os.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
)

These are the different logging levels.