qblog

README

[qb]log

import "git.fractalqb.de/fractalqb/qblog"

This is a logging library that brings together

• Slim structured logging with

• Go's structured logging log/slog and

• logging configuration from c4hgol

to make a logging library that can coexists peacefully with other logging libraries.

Documentation

Overview

Example

log := New(DefaultConfig.Clone().SetWriter(os.Stdout))
log.Handler().(*SllmHandler).Clock = testClock
log.Info("bad login `from` at `time`", `from`, "10.0.0.1")
log.WithGroup("tests").
	With("time", testClock()).
	Info("bad login `from` at `time`", `from`, "10.0.0.1")

Output:

06-01 Tu 12:13:14+01 INFO  bad login `from:10.0.0.1` at `time:`
06-01 Tu 12:13:14+01 INFO  [tests] bad login `from:10.0.0.1` at `time:1971-06-01 12:13:14.987654321 +0100 CET`

Index

• Constants
• func Debug(msg string, args ...any)
• func DebugContext(ctx context.Context, msg string, args ...any)
• func Error(msg string, args ...any)
• func ErrorContext(ctx context.Context, msg string, args ...any)
• func Info(msg string, args ...any)
• func InfoContext(ctx context.Context, msg string, args ...any)
• func Log(ctx context.Context, level Level, msg string, args ...any)
• func LogAttrs(ctx context.Context, level Level, msg string, attrs ...slog.Attr)
• func Trace(msg string, args ...any)
• func TraceContext(ctx context.Context, msg string, args ...any)
• func Warn(msg string, args ...any)
• func WarnContext(ctx context.Context, msg string, args ...any)
• type AddSource
• type Config
  • func (cfg *Config) AddSource() AddSource
  • func (cfg *Config) Clone() *Config
  • func (cfg *Config) Level() slog.Level
  • func (cfg *Config) ParseFlag(f string) error
  • func (cfg *Config) SetAddSource(s AddSource) *Config
  • func (cfg *Config) SetLevel(l Level) *Config
  • func (cfg *Config) SetTimeFmt(f sllm.TimeFormat) *Config
  • func (cfg *Config) SetWriter(w io.Writer) *Config
  • func (cfg *Config) TimeFmt() sllm.TimeFormat
  • func (cfg *Config) Writer() (w io.Writer)
• type Level
  • func (l Level) String() string
• type Logger
  • func New(cfg *Config) *Logger
  • func (l *Logger) Enabled(ctx context.Context, level Level) bool
  • func (l *Logger) Log(ctx context.Context, level Level, msg string, args ...any)
  • func (l *Logger) LogAttrs(ctx context.Context, level Level, msg string, attrs ...slog.Attr)
  • func (l *Logger) Trace(msg string, args ...any)
  • func (l *Logger) TraceContext(ctx context.Context, msg string, args ...any)
  • func (l *Logger) With(args ...any) *Logger
  • func (l *Logger) WithGroup(name string) *Logger
• type SllmHandler
  • func NewSllmHandler(cfg *Config) *SllmHandler
  • func (h *SllmHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *SllmHandler) Handle(_ context.Context, r slog.Record) (err error)
  • func (h *SllmHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *SllmHandler) WithGroup(name string) slog.Handler

Examples

• Package

Constants

const (
	LevelTrace = Level(2 * slog.LevelDebug)
	LevelDebug = Level(slog.LevelDebug)
	LevelInfo  = Level(slog.LevelInfo)
	LevelWarn  = Level(slog.LevelWarn)
	LevelError = Level(slog.LevelError)
)

const (
	TDefault = sllm.TDefault
	TMillis  = TDefault | sllm.TMillis
	TMicros  = TDefault | sllm.TMicros
	TYear    = TDefault | sllm.TYear
	TYMillis = TMillis | sllm.TYear
	TYMicros = TMicros | sllm.TYear
)

Functions

func Debug

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

func DebugContext

func DebugContext(ctx context.Context, msg string, args ...any)

func Error

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

func ErrorContext

func ErrorContext(ctx context.Context, msg string, args ...any)

func Info

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

func InfoContext

func InfoContext(ctx context.Context, msg string, args ...any)

func Log

func Log(ctx context.Context, level Level, msg string, args ...any)

func LogAttrs

func LogAttrs(ctx context.Context, level Level, msg string, attrs ...slog.Attr)

func Trace

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

func TraceContext

func TraceContext(ctx context.Context, msg string, args ...any)

func Warn

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

func WarnContext

func WarnContext(ctx context.Context, msg string, args ...any)

Types

type AddSource

type AddSource int32

const (
	SrcFile AddSource = iota + 1
	SrcPath
	SrcStack
)

type Config

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

var DefaultConfig Config

func (*Config) AddSource

func (cfg *Config) AddSource() AddSource

func (*Config) Clone

func (cfg *Config) Clone() *Config

func (*Config) Level

func (cfg *Config) Level() slog.Level

func (*Config) ParseFlag

func (cfg *Config) ParseFlag(f string) error

func (*Config) SetAddSource

func (cfg *Config) SetAddSource(s AddSource) *Config

func (*Config) SetLevel

func (cfg *Config) SetLevel(l Level) *Config

func (*Config) SetTimeFmt

func (cfg *Config) SetTimeFmt(f sllm.TimeFormat) *Config

func (*Config) SetWriter

func (cfg *Config) SetWriter(w io.Writer) *Config

func (*Config) TimeFmt

func (cfg *Config) TimeFmt() sllm.TimeFormat

func (*Config) Writer

func (cfg *Config) Writer() (w io.Writer)

type Level

type Level int

func (Level) String

func (l Level) String() string

type Logger

type Logger struct{ *slog.Logger }

func New

func New(cfg *Config) *Logger

func (*Logger) Enabled

func (l *Logger) Enabled(ctx context.Context, level Level) bool

func (*Logger) Log

func (l *Logger) Log(ctx context.Context, level Level, msg string, args ...any)

func (*Logger) LogAttrs

func (l *Logger) LogAttrs(ctx context.Context, level Level, msg string, attrs ...slog.Attr)

func (*Logger) Trace

func (l *Logger) Trace(msg string, args ...any)

func (*Logger) TraceContext

func (l *Logger) TraceContext(ctx context.Context, msg string, args ...any)

func (*Logger) With

func (l *Logger) With(args ...any) *Logger

func (*Logger) WithGroup

func (l *Logger) WithGroup(name string) *Logger

type SllmHandler

type SllmHandler struct {
	Clock func() time.Time
	// contains filtered or unexported fields
}

func NewSllmHandler

func NewSllmHandler(cfg *Config) *SllmHandler

func (*SllmHandler) Enabled

func (h *SllmHandler) Enabled(_ context.Context, level slog.Level) bool

func (*SllmHandler) Handle

func (h *SllmHandler) Handle(_ context.Context, r slog.Record) (err error)

func (*SllmHandler) WithAttrs

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

func (*SllmHandler) WithGroup

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