log

Documentation

Overview

Package log provides logging routines based on slog package.

Index

• Constants
• Variables
• func Debugf(format string, args ...any)
• func Disable()
• func Errorf(format string, args ...any)
• func Fatalf(format string, args ...any)
• func Infof(format string, args ...any)
• func Init(opts ...Option) error
• func New(enabled bool) logr.Logger
• func NewDefaultLogWriter(level LogLevel) io.Writer
• func Warnf(format string, args ...any)
• type LogLevel
• type Option
  • func WithAlsoLogToStderr() Option
  • func WithDevMode() Option
  • func WithLevel(level LogLevel) Option

Constants

const (
	DebugLevel = slog.LevelDebug
	InfoLevel  = slog.LevelInfo
	WarnLevel  = slog.LevelWarn
	ErrorLevel = slog.LevelError
)

Variables

var DefaultLogger = slog.Default()

DefaultLogger is the default logger.

Functions

func Debugf

func Debugf(format string, args ...any)

Debugf logs a debug message.

func Disable

func Disable()

func Errorf

func Errorf(format string, args ...any)

Errorf logs an error message.

func Fatalf

func Fatalf(format string, args ...any)

Fatalf logs a fatal message.

func Infof

func Infof(format string, args ...any)

Infof logs an info message.

func Init

func Init(opts ...Option) error

Init initializes the logger.

func New

func New(enabled bool) logr.Logger

New returns a new logr.Logger.

func NewDefaultLogWriter

func NewDefaultLogWriter(level LogLevel) io.Writer

NewDefaultLogWriter returns a io.Writer that logs to the given logger at the given level.

func Warnf

func Warnf(format string, args ...any)

Warnf logs a warning message.

Types

type LogLevel

type LogLevel = slog.Level

type Option

type Option func(*options)

Option is a logger option.

func WithAlsoLogToStderr

func WithAlsoLogToStderr() Option

WithAlsoLogToStderr also logs to stderr.

func WithDevMode

func WithDevMode() Option

WithDevMode sets the logger to development mode. In development mode, the logger logs in human-readable format, the level is set to DebugLevel, and logs are also written to stderr.

func WithLevel

func WithLevel(level LogLevel) Option

WithLevel sets the log level. The default log level is InfoLevel.