logging

Documentation

Index

• Constants
• Variables
• func AddHooks(hooks ...logrus.Hook)
• func CanLogAt(logger *logrus.Logger, level logrus.Level) bool
• func GetFormatter(format LogFormat) logrus.Formatter
• func GetLevel(logger *logrus.Logger) logrus.Level
• func MultiLine(logFn func(args ...interface{}), output string)
• func SetDefaultLogFormat()
• func SetDefaultLogLevel()
• func SetLogFormat(logFormat LogFormat)
• func SetLogLevel(logLevel logrus.Level)
• func SetLogLevelToDebug()
• func SetupLogging(loggers []string, logOpts LogOptions, tag string, debug bool) error
• type Limiter
  • func NewLimiter(interval time.Duration, burst int) Limiter
  • func (ll Limiter) Allow() bool
• type LogFormat
• type LogOptions
  • func (o LogOptions) GetLogFormat() LogFormat
  • func (o LogOptions) GetLogLevel() (level logrus.Level)

Constants

const (
	Syslog    = "syslog"
	LevelOpt  = "level"
	FormatOpt = "format"

	LogFormatText          LogFormat = "text"
	LogFormatTextTimestamp LogFormat = "text-ts"
	LogFormatJSON          LogFormat = "json"
	LogFormatJSONTimestamp LogFormat = "json-ts"

	// DefaultLogFormat is the string representation of the default logrus.Formatter
	// we want to use (possible values: text or json)
	DefaultLogFormat LogFormat = LogFormatText

	// DefaultLogFormatTimestamp is the string representation of the default logrus.Formatter
	// including timestamps.
	// We don't use this for general runtime logs since kubernetes log capture handles those.
	// This is only used for applications such as CNI which is written to disk so we have no
	// way to correlate with other logs.
	DefaultLogFormatTimestamp LogFormat = LogFormatTextTimestamp

	// DefaultLogLevel is the default log level we want to use for our logrus.Formatter
	DefaultLogLevel logrus.Level = logrus.InfoLevel
)

const (
	SLevel    = "syslog.level"
	SNetwork  = "syslog.network"
	SAddress  = "syslog.address"
	SSeverity = "syslog.severity"
	SFacility = "syslog.facility"
	STag      = "syslog.tag"
)

Variables

var DefaultLogger = initializeDefaultLogger()

DefaultLogger is the base logrus logger. It is different from the logrus default to avoid external dependencies from writing out unexpectedly

var DefaultSlogLogger *slog.Logger = slog.New(slog.NewTextHandler(
	os.Stderr,
	slogHandlerOpts,
))

Default slog logger. Will be overwritten once initializeSlog is called.

var SlogNopHandler slog.Handler = nopHandler{}

SlogNopHandler discards all logs.

Functions

func AddHooks

func AddHooks(hooks ...logrus.Hook)

AddHooks adds additional logrus hook to default logger

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 GetFormatter

func GetFormatter(format LogFormat) logrus.Formatter

GetFormatter returns a configured logrus.Formatter with some specific values we want to have

func GetLevel

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

GetLevel returns the log level of the given logger.

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 SetDefaultLogFormat

func SetDefaultLogFormat()

SetDefaultLogFormat updates the DefaultLogger with the DefaultLogFormat

func SetDefaultLogLevel

func SetDefaultLogLevel()

SetDefaultLogLevel updates the DefaultLogger with the DefaultLogLevel

func SetLogFormat

func SetLogFormat(logFormat LogFormat)

SetLogFormat updates the DefaultLogger with a new LogFormat

func SetLogLevel

func SetLogLevel(logLevel logrus.Level)

SetLogLevel updates the DefaultLogger with a new logrus.Level

func SetLogLevelToDebug

func SetLogLevelToDebug()

SetLogLevelToDebug updates the DefaultLogger with the logrus.DebugLevel

func SetupLogging

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

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

Types

type Limiter

type Limiter struct {
	// contains filtered or unexported fields
}

Limiter is a wrapper around rate.Limiter that does not panic when the limiter is uninitialized. The wrapping also allows more logging specific functionality to be added later without changing all the call sites.

func NewLimiter

func NewLimiter(interval time.Duration, burst int) Limiter

NewLimiter returns a new Limiter allowing log messages to be emitted on average once every 'interval' and upto 'burst' messages during any 'interval'.

func (Limiter) Allow

func (ll Limiter) Allow() bool

Allow returns true if the log message is allowed under the configured rate limit.

type LogFormat

type LogFormat string

type LogOptions

type LogOptions map[string]string

LogOptions maps configuration key-value pairs related to logging.

func (LogOptions) GetLogFormat

func (o LogOptions) GetLogFormat() LogFormat

GetLogFormat returns the log format specified in the provided LogOptions. If it is not set in the options or is invalid, it will return the default format.

func (LogOptions) GetLogLevel

func (o LogOptions) GetLogLevel() (level logrus.Level)

GetLogLevel returns the log level specified in the provided LogOptions. If it is not set in the options, it will return the default level.