log

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, keysAndValues ...any) (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.

The new sink will not inherit any of the existing logger's key-value pairs. Key-value pairs can be added to the new sink specifically by passing them to this function.

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 NewRedactionCore ¶ added in v3.83.0

func NewRedactionCore(core zapcore.Core, redactor *dynamicRedactor) zapcore.Core

NewRedactionCore creates a zapcore.Core that performs redaction of logs in the message and field values.

func NewWithCaller ¶ added in v3.93.1

func NewWithCaller(service string, addCaller bool, configs ...logConfig) (logr.Logger, func() error)

NewWithCaller creates a new logger named after the specified service with the provided sink configurations. If addCaller is true, call site information will be attached to each emitted log message. (This behavior can be disabled on a per-sink basis using WithSuppressCaller.)

func RedactGlobally ¶ added in v3.83.0

func RedactGlobally(sensitiveValue string)

RedactGlobally configures the global log redactor to redact the provided value during log emission. The value will be redacted in log messages and values that are strings, but not in log keys or values of other types.

func SetLevel ¶

func SetLevel(level int8)

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

func SetLevelForControl ¶ added in v3.10.0

func SetLevelForControl(control levelSetter, level int8)

SetLevelForControl sets the log level for a given control.

func ToLogger ¶ added in v3.84.0

func ToLogger(l logr.Logger) *log.Logger

ToLogger converts the logr.Logger into a legacy *log.Logger.

func ToSlogger ¶ added in v3.84.0

func ToSlogger(l logr.Logger) *slog.Logger

ToSlogger converts the logr.Logger into a *slog.Logger.

func WithConsoleSink ¶

func WithConsoleSink(sink io.Writer, opts ...SinkOption) 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 ...SinkOption) logConfig

WithJSONSink adds a JSON encoded output to the logger.

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.