logger

Documentation

Index

• Constants
• type EventFn
• type Events
• type Level
• type Logger
  • func New(serviceName string, opts ...Option) *Logger
  • func (log *Logger) Debug(ctx context.Context, msg string, args ...any)
  • func (log *Logger) Error(ctx context.Context, msg string, args ...any)
  • func (log *Logger) Info(ctx context.Context, msg string, args ...any)
  • func (log *Logger) Warn(ctx context.Context, msg string, args ...any)
• type Option
  • func WithConsoleWriter() Option
  • func WithDebugEvent(fn EventFn) Option
  • func WithErrorEvent(fn EventFn) Option
  • func WithInfoEvent(fn EventFn) Option
  • func WithLogLevel(lvl Level) Option
  • func WithTraceIDFn(fn TraceIDFn) Option
  • func WithWarnEvent(fn EventFn) Option
  • func WithWriter(w io.Writer) Option
• type Record
• type TraceIDFn

Constants

const (
	LevelDebug = Level(slog.LevelDebug)
	LevelInfo  = Level(slog.LevelInfo)
	LevelWarn  = Level(slog.LevelWarn)
	LevelError = Level(slog.LevelError)
)

A set of possible logging levels.

Types

type EventFn

type EventFn func(ctx context.Context, r Record)

EventFn is a function to be executed when configured against a log level.

type Events

type Events struct {
	Debug EventFn
	Info  EventFn
	Warn  EventFn
	Error EventFn
}

Events contains an assignment of an event function to a log level.

type Level

type Level slog.Level

Level represents different logging levels.

type Logger

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

Logger represents a logger for logging information.

func New

func New(serviceName string, opts ...Option) *Logger

New constructs a newLogger log for application use.

func (*Logger) Debug

func (log *Logger) Debug(ctx context.Context, msg string, args ...any)

Debug logs at LevelDebug with the given context.

func (*Logger) Error

func (log *Logger) Error(ctx context.Context, msg string, args ...any)

Error logs at LevelError with the given context.

func (*Logger) Info

func (log *Logger) Info(ctx context.Context, msg string, args ...any)

Info logs at LevelInfo with the given context.

func (*Logger) Warn

func (log *Logger) Warn(ctx context.Context, msg string, args ...any)

Warn logs at LevelWarn with the given context.

type Option

type Option func(o *options)

func WithConsoleWriter

func WithConsoleWriter() Option

func WithDebugEvent

func WithDebugEvent(fn EventFn) Option

func WithErrorEvent

func WithErrorEvent(fn EventFn) Option

func WithInfoEvent

func WithInfoEvent(fn EventFn) Option

func WithLogLevel

func WithLogLevel(lvl Level) Option

func WithTraceIDFn

func WithTraceIDFn(fn TraceIDFn) Option

func WithWarnEvent

func WithWarnEvent(fn EventFn) Option

func WithWriter

func WithWriter(w io.Writer) Option

type Record

type Record struct {
	Time       time.Time
	Message    string
	Level      Level
	Attributes map[string]any
}

Record represents the data that is being logged.

type TraceIDFn

type TraceIDFn func(ctx context.Context) string

TraceIDFn represents a function that can return the trace id from the specified context.