log

Documentation

Index

• Constants
• func AnyPointerSlice[T any](name string, ptrs []*T) slog.Attr
• type Logger
  • func New(server bool, level string, dir string) *Logger
  • func (l *Logger) CatchAndReportCrash() any
  • func (l *Logger) Debug(msg string, args ...any)
  • func (l *Logger) Debugf(msg string, args ...any)
  • func (l *Logger) Error(msg string, args ...any)
  • func (l *Logger) Errorf(msg string, args ...any)
  • func (l *Logger) Info(msg string, args ...any)
  • func (l *Logger) Infof(msg string, args ...any)
  • func (l *Logger) Warn(msg string, args ...any)
  • func (l *Logger) Warnf(msg string, args ...any)
  • func (l *Logger) With(args ...any) *Logger
• type StackFrame
  • func (f StackFrame) String() string
• type StackFrames
  • func Callstack(fr []StackFrame) StackFrames
  • func (f StackFrames) String() string
  • func (f StackFrames) Strings() []string

Constants

const CrashReportPath = "/crash"

const CrashReportPort = "6504"

const CrashReportServer = "localhost"

const CrashReportURL = "http://" + CrashReportServer + ":" + CrashReportPort + CrashReportPath

Functions

func AnyPointerSlice

func AnyPointerSlice[T any](name string, ptrs []*T) slog.Attr

AnyPointerSlice is similar to slog.Any but takes a slice of pointers; unlike passing a slice of pointers to slog.Any, it logs the values pointed-to by the pointers rather than the pointer values themselves.

Types

type Logger

type Logger struct {
	*slog.Logger
	LogFile string
	LogDir  string
	Start   time.Time
}

func New

func New(server bool, level string, dir string) *Logger

func (*Logger) CatchAndReportCrash

func (l *Logger) CatchAndReportCrash() any

func (*Logger) Debug

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

Debug wraps slog.Debug to add call stack information (and similarly for the following Logger methods...) Note that we do not wrap the entire slog logging interface, so, for example, WarnContext and Log do not have callstacks included.

We also wrap the logging methods to allow a nil *Logger, in which case debug and info messages are discarded (though warnings and errors still go through to slog.)

func (*Logger) Debugf

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

Debugf is a convenience wrapper that logs just a message and allows printf-style formatting of the provided args.

func (*Logger) Error

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

func (*Logger) Errorf

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

func (*Logger) Info

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

func (*Logger) Infof

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

func (*Logger) Warn

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

func (*Logger) Warnf

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

func (*Logger) With

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

type StackFrame

type StackFrame struct {
	File     string `json:"file"`
	Line     int    `json:"line"`
	Function string `json:"function"`
}

func (StackFrame) String

func (f StackFrame) String() string

type StackFrames

type StackFrames []StackFrame

func Callstack

func Callstack(fr []StackFrame) StackFrames

func (StackFrames) String

func (f StackFrames) String() string

func (StackFrames) Strings

func (f StackFrames) Strings() []string