logging

Documentation

Index

• Constants
• Variables
• func CanLogAt(logger *logrus.Logger, level logrus.Level) bool
• func ConfigureLogLevel(debug bool)
• func GetLevel(logger *logrus.Logger) logrus.Level
• func GetLogLevelFromConfig() (logrus.Level, bool)
• func InitializeDefaultLogger() *logrus.Logger
• func MultiLine(logFn func(args ...interface{}), output string)
• func SetLogLevel(level logrus.Level)
• func SetupLogging(loggers []string, logOpts map[string]string, tag string, debug bool) error
• type LogOptions
  • func (o LogOptions) GetLogLevel() (logrus.Level, bool)

Constants

const (
	SLevel   = "syslog.level"
	Syslog   = "syslog"
	LevelOpt = "level"
)

Variables

var (
	// DefaultLogger is the base logrus logger. It is different from the logrus
	// default to avoid external dependencies from writing out unexpectedly
	DefaultLogger = InitializeDefaultLogger()

	// DefaultLogLevelStr is the string representation of DefaultLogLevel. It
	// is used to allow for injection of the logging level via go's ldflags in
	// unit tests, as only injection with strings via ldflags is allowed.
	DefaultLogLevelStr = "info"

	// LevelStringToLogrusLevel maps string representations of logrus.Level into
	// their corresponding logrus.Level.
	LevelStringToLogrusLevel = map[string]logrus.Level{
		"panic":   logrus.PanicLevel,
		"error":   logrus.ErrorLevel,
		"warning": logrus.WarnLevel,
		"info":    logrus.InfoLevel,
		"debug":   logrus.DebugLevel,
	}
)

Functions

func CanLogAt

func CanLogAt(logger *logrus.Logger, level logrus.Level) bool

CanLogAt returns whether a log message at the given level would be logged by the given logger.

func ConfigureLogLevel

func ConfigureLogLevel(debug bool)

ConfigureLogLevel configures the logging level of the global logger. If debugging is not enabled, it will set the logging level based off of the logging options configured at bootstrap. Debug being enabled takes precedence over the configuration in the logging options. It is thread-safe.

func GetLevel

func GetLevel(logger *logrus.Logger) logrus.Level

GetLevel returns the log level of the given logger.

func GetLogLevelFromConfig

func GetLogLevelFromConfig() (logrus.Level, bool)

GetLogLevelFromConfig returns the log level provided via global configuration. If the logging level is invalid, ok will be false.

func InitializeDefaultLogger

func InitializeDefaultLogger() *logrus.Logger

InitializeDefaultLogger returns a logrus Logger with a custom text formatter.

func MultiLine

func MultiLine(logFn func(args ...interface{}), output string)

MultiLine breaks a multi line text into individual log entries and calls the logging function to log each entry

func SetLogLevel

func SetLogLevel(level logrus.Level)

SetLogLevel sets the log level on DefaultLogger. This logger is, by convention, the base logger for package specific ones thus setting the level here impacts the default logging behaviour. This function is thread-safe when logging, reading DefaultLogger.LevelOpt is not protected this way, however.

func SetupLogging

func SetupLogging(loggers []string, logOpts map[string]string, tag string, debug bool) error

SetupLogging sets up each logging service provided in loggers and configures each logger with the provided logOpts.

Types

type LogOptions

type LogOptions map[string]string

LogOptions maps configuration key-value pairs related to logging.

func (LogOptions) GetLogLevel

func (o LogOptions) GetLogLevel() (logrus.Level, bool)

GetLogLevel returns the log level specified in the provided LogOptions. If it is not set in the options, ok will be false.