log

Documentation

Index

• Constants
• func Background() logr.Logger
• func BindCLIFlags(fs *pflag.FlagSet)
• func Flush()
• func FromContextOrBackground(ctx context.Context) logr.Logger
• func NewContext(ctx context.Context, logger logr.Logger) context.Context
• func Noop() logr.Logger
• func Setup(opts *Options)
• func SetupError(msg string, args ...any)
• func ValueAsMap(value any) map[string]any
• type Format
• type Options
  • func OptionsFromCLIFlags(fs *pflag.FlagSet) *Options
• type SLogJSONHandler
  • func NewJSONHandler(w io.Writer, opts *slog.HandlerOptions) *SLogJSONHandler
  • func (h *SLogJSONHandler) Enabled(ctx context.Context, level slog.Level) bool
  • func (h *SLogJSONHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *SLogJSONHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *SLogJSONHandler) WithGroup(name string) slog.Handler

Constants

const (
	DefaultFormat         = Text
	DefaultFlushFrequency = 5 * time.Second
)

const (
	TimeKey      = slog.TimeKey
	LevelKey     = slog.LevelKey
	VerbosityKey = "v"
)

Functions

func Background

func Background() logr.Logger

Background returns the background logger. Current implementation uses klog as the background logger.

func BindCLIFlags

func BindCLIFlags(fs *pflag.FlagSet)

func Flush

func Flush()

Flush flushes logs immediately.

func FromContextOrBackground

func FromContextOrBackground(ctx context.Context) logr.Logger

FromContextOrBackground returns a logger from the context if it exists, otherwise it returns a background logger. Current implementation uses klog as the background logger.

func NewContext

func NewContext(ctx context.Context, logger logr.Logger) context.Context

NewContext returns a new context with the provided logger.

func Noop

func Noop() logr.Logger

Noop returns a logger that discards all log messages.

func Setup

func Setup(opts *Options)

Setup initializes the logging system.

func SetupError

func SetupError(msg string, args ...any)

func ValueAsMap

func ValueAsMap(value any) map[string]any

ValueAsMap converts a value to a map[string]any. It returns a map with an "error" key if the conversion fails. NOTE:

It should ONLY be used when the default klog formatter failed to serialize the value in JSON format.
Protobuf messages had implemented `String()` method, which the value is hard to read. Use this method to bypass instead.

Types

type Format

type Format string

const (
	JSON Format = "json"
	Text Format = "text"
)

type Options

type Options struct {
	Format         Format
	FlushFrequency time.Duration
}

func OptionsFromCLIFlags

func OptionsFromCLIFlags(fs *pflag.FlagSet) *Options

type SLogJSONHandler

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

func NewJSONHandler

func NewJSONHandler(w io.Writer, opts *slog.HandlerOptions) *SLogJSONHandler

func (*SLogJSONHandler) Enabled

func (h *SLogJSONHandler) Enabled(ctx context.Context, level slog.Level) bool

func (*SLogJSONHandler) Handle

func (h *SLogJSONHandler) Handle(ctx context.Context, record slog.Record) error

func (*SLogJSONHandler) WithAttrs

func (h *SLogJSONHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (*SLogJSONHandler) WithGroup

func (h *SLogJSONHandler) WithGroup(name string) slog.Handler