log

Documentation

Index

• func AddLeveler(l logr.Logger, control levelSetter) (logr.Logger, error)
• func AddSentry(l logr.Logger, opts sentry.ClientOptions, tags map[string]string) (logr.Logger, func() error, error)
• func AddSink(l logr.Logger, sink logConfig) (logr.Logger, func() error, error)
• func New(service string, configs ...logConfig) (logr.Logger, func() error)
• func NewLevelCore(core zapcore.Core, level zapcore.LevelEnabler) zapcore.Core
• func SetLevel(level int8)
• func SetLevelFor(name string, level int8)
• func SetLevelForControl(control levelSetter, level int8)
• func WithConsoleSink(sink io.Writer, opts ...func(*sinkConfig)) logConfig
• func WithCore(core zapcore.Core) logConfig
• func WithJSONSink(sink io.Writer, opts ...func(*sinkConfig)) logConfig
• func WithLevel(level int8) func(*sinkConfig)
• func WithLeveler(leveler levelSetter) func(*sinkConfig)
• func WithNamedLevel(logger logr.Logger, name string) logr.Logger
• func WithSentry(opts sentry.ClientOptions, tags map[string]string) logConfig

Functions

func AddLeveler

func AddLeveler(l logr.Logger, control levelSetter) (logr.Logger, error)

AddLeveler adds a log level control to a logr.Logger.

func AddSentry

func AddSentry(l logr.Logger, opts sentry.ClientOptions, tags map[string]string) (logr.Logger, func() error, error)

AddSentry initializes a sentry client and extends an existing logr.Logger with the hook.

func AddSink

func AddSink(l logr.Logger, sink logConfig) (logr.Logger, func() error, error)

AddSink extends an existing logr.Logger with a new sink. It returns the new logr.Logger, a cleanup function, and an error.

func New

func New(service string, configs ...logConfig) (logr.Logger, func() error)

New creates a new log object with the provided configurations. If no sinks are provided, a no-op sink will be used. Returns the logger and a cleanup function that should be executed before the program exits.

func NewLevelCore

func NewLevelCore(core zapcore.Core, level zapcore.LevelEnabler) zapcore.Core

NewLevelCore creates a core that can be used to independently control the level of an existing Core. This is essentially a filter that will only log if both the parent and the wrapper cores are enabled.

func SetLevel

func SetLevel(level int8)

SetLevel sets the log level for loggers created with the default level controller.

func SetLevelFor

func SetLevelFor(name string, level int8)

SetLevelFor sets the log level for a given named control.

func SetLevelForControl

func SetLevelForControl(control levelSetter, level int8)

SetLevelForControl sets the log level for a given control.

func WithConsoleSink

func WithConsoleSink(sink io.Writer, opts ...func(*sinkConfig)) logConfig

WithConsoleSink adds a console-style output to the logger.

func WithCore

func WithCore(core zapcore.Core) logConfig

WithCore adds any user supplied zap core to the logger.

func WithJSONSink

func WithJSONSink(sink io.Writer, opts ...func(*sinkConfig)) logConfig

WithJSONSink adds a JSON encoded output to the logger.

func WithLevel

func WithLevel(level int8) func(*sinkConfig)

WithLevel sets the sink's level to a static level. This option prevents changing the log level for this sink later on.

func WithLeveler

func WithLeveler(leveler levelSetter) func(*sinkConfig)

WithLeveler sets the sink's level enabler to leveler.

func WithNamedLevel

func WithNamedLevel(logger logr.Logger, name string) logr.Logger

WithNamedLevel creates a child logger with a new name and independent log level control (see SetLevelFor). NOTE: if name already exists, the existing controller will be used, otherwise a new controller is created with level matching the parent's log level.

func WithSentry

func WithSentry(opts sentry.ClientOptions, tags map[string]string) logConfig

WithSentry adds sentry integration to the logger. This configuration may fail, in which case, sentry will not be added and execution will continue normally.