logkit

Documentation

Index

• func New(options ...Option) *slog.Logger
• func NewNop() *slog.Logger
• func ParseLevel(lvl string) (slog.Level, error)
• type Error
  • func (e Error) Error() string
• type Option
  • func WithColor() Option
  • func WithJSON() Option
  • func WithLevel(level slog.Level) Option
  • func WithSource() Option
  • func WithTimeFormat(format string) Option
  • func WithWriter(w io.Writer) Option
• type Options

Functions

func New

func New(options ...Option) *slog.Logger

New returns a pointer to a new instance of slog.Logger. Takes the variadic arguments of Option type to configure logger.

func NewNop

func NewNop() *slog.Logger

NewNop returns a new disabled logger that logs nothing.

func ParseLevel

func ParseLevel(lvl string) (slog.Level, error)

ParseLevel takes the string and tries to parse it to the Level.

Types

type Error

type Error string

Error represents package level error related to logging work.

const (
	// ErrParseLevel indicates that string given to function ParseLevel can't be parsed to Level.
	ErrParseLevel Error = "string can't be parsed as Level, use: `error`, `warn`, `info`, `debug`"
)

func (Error) Error

func (e Error) Error() string

type Option

type Option func(*Options)

Option represents a function that modifies the configuration options for the logging library.

func WithColor

func WithColor() Option

WithColor creates an Option that enables color formatting for log messages. Will not take effect ff WithJSON is applied.

func WithJSON

func WithJSON() Option

WithJSON creates an Option that enables JSON formatting for log messages. When this Option is applied, log messages will be formatted as JSON objects.

func WithLevel

func WithLevel(level slog.Level) Option

WithLevel changes the underlying logging level of slog.Logger to the given on.

func WithSource

func WithSource() Option

WithSource creates an Option that enables source code line number formatting for log messages. When this Option is applied, log messages will contain source code line number.

func WithTimeFormat

func WithTimeFormat(format string) Option

WithTimeFormat creates an Option that change the time formatting for log messages.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter changes the writer for each leveled loggers of StdLog to the given on.

type Options

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

Options represents the configuration options for the logging library.