logging

Documentation

Index

• Constants
• func BySerialDesc(i, j Message) int
• func ValidLevels() []string
• type ArgsUpdater
• type Attr
• type Getter
• type Interface
• type Logger
  • func NewLogger(opts Options) *Logger
  • func (e Logger) AddArgsUpdater(updater ArgsUpdater)
  • func (l *Logger) Debug(msg string, args ...any)
  • func (l *Logger) Error(msg string, args ...any)
  • func (l *Logger) Get(id resource.ID) (Message, error)
  • func (l *Logger) Info(msg string, args ...any)
  • func (l *Logger) List() []Message
  • func (l *Logger) Warn(msg string, args ...any)
• type Message
• type Options
• type ReferenceUpdater
  • func (e *ReferenceUpdater[T]) UpdateArgs(args ...any) []any

Constants

const DefaultLevel = "info"

Functions

func BySerialDesc

func BySerialDesc(i, j Message) int

BySerialDesc sorts log messages by their serial.

func ValidLevels

func ValidLevels() []string

ValidLevels returns valid strings for choosing a log level. Returns the default log level first.

Types

type ArgsUpdater

type ArgsUpdater interface {
	UpdateArgs(args ...any) []any
}

ArgsUpdater updates a log message's arguments.

type Attr

type Attr struct {
	Key   string
	Value string

	// An attribute is a pug resource, but only insofar as it makes it easier to
	// handle consistently alongside all other resources (modules, workspaces,
	// etc) in the TUI.
	resource.ID
}

type Getter

type Getter[T any] interface {
	Get(resource.ID) (T, error)
}

type Interface

type Interface interface {
	Debug(msg string, args ...any)
	Info(msg string, args ...any)
	Warn(msg string, args ...any)
	Error(msg string, args ...any)
	AddArgsUpdater(enricher ArgsUpdater)
}

var Discard Interface = &noop{}

type Logger

type Logger struct {
	*pubsub.Broker[Message]
	// contains filtered or unexported fields
}

Logger wraps slog, providing further functionality such as emitting log records as pug events, and enriching records with further attributes.

func NewLogger

func NewLogger(opts Options) *Logger

NewLogger constructs Logger, a slog wrapper with additional functionality.

func (Logger) AddArgsUpdater

func (e Logger) AddArgsUpdater(updater ArgsUpdater)

func (*Logger) Debug

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

func (*Logger) Error

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

func (*Logger) Get

func (l *Logger) Get(id resource.ID) (Message, error)

Get retrieves a log message by ID.

func (*Logger) Info

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

func (*Logger) List

func (l *Logger) List() []Message

List lists the log messages received thus far.

func (*Logger) Warn

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

type Message

type Message struct {
	// A message is a pug resource, but only insofar as it makes it easier to
	// handle consistently alongside all other resources (modules, workspaces,
	// etc) in the TUI.
	resource.ID

	Time       time.Time
	Level      string
	Message    string `json:"msg"`
	Attributes []Attr
}

Message is the event payload for a log message

type Options

type Options struct {
	// The log level of the logger
	Level string
	// Any additional writers the log handler should write to.
	AdditionalWriters []io.Writer
}

type ReferenceUpdater

type ReferenceUpdater[T any] struct {
	Getter[T]

	Name  string
	Field string
}

ReferenceUpdater checks log arguments for references to T via its ID, either directly or via a struct field, and updates or adds T to the log arguments accordingly.

func (*ReferenceUpdater[T]) UpdateArgs

func (e *ReferenceUpdater[T]) UpdateArgs(args ...any) []any