logger

Documentation

Overview

Package logger provides logging configuration and helpers to pass a logger instance through the context.

Index

• Constants
• func FromContext(ctx context.Context) (logger *slog.Logger)
• func FromContextMaybe(ctx context.Context) (logger *slog.Logger)
• func FromRootCommand(cmd *cobra.Command) (logger *slog.Logger)
• func NewContext(ctx context.Context, logger *slog.Logger) context.Context
• type Config
  • func NewConfig() *Config
  • func (c *Config) FlagSet() *flag.FlagSet
  • func (c *Config) Format() string
  • func (c *Config) GetLogLevel() slog.Level
  • func (c *Config) Level() string
  • func (c *Config) NewLogger(w io.Writer) *slog.Logger
  • func (c *Config) ReplaceAttr(groups []string, a slog.Attr) slog.Attr
  • func (c *Config) Vet() error

Constants

const ErrKey = "err"

Functions

func FromContext

func FromContext(ctx context.Context) (logger *slog.Logger)

FromContext returns the *slog.Logs previously stored in ctx by NewContext. slog.Default() is returned otherwise.

func FromContextMaybe

func FromContextMaybe(ctx context.Context) (logger *slog.Logger)

FromContextMaybe returns the *slog.Logs previously stored in ctx by NewContext or nil.

func FromRootCommand

func FromRootCommand(cmd *cobra.Command) (logger *slog.Logger)

FromRootCommand returns a logger from the root cobra.Command context or nil.

func NewContext

func NewContext(ctx context.Context, logger *slog.Logger) context.Context

NewContext returns a new Context that carries value logger. Use FromContext to retrieve the value.

Types

type Config

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

Config specifies user configurable flag values to create a NewLogger

func NewConfig

func NewConfig() *Config

NewConfig returns a new logging Config struct

func (*Config) FlagSet

func (c *Config) FlagSet() *flag.FlagSet

FlagSet returns the go flag set to configure logging

func (*Config) Format

func (c *Config) Format() string

func (*Config) GetLogLevel

func (c *Config) GetLogLevel() slog.Level

GetLogLevel returns a slog.Level configured by the user

A non-zero length DEBUG env var takes precedence over config fields.

func (*Config) Level

func (c *Config) Level() string

func (*Config) NewLogger

func (c *Config) NewLogger(w io.Writer) *slog.Logger

NewLogger returns a *slog.Logs configured by c *Config which writes to w

func (*Config) ReplaceAttr

func (c *Config) ReplaceAttr(groups []string, a slog.Attr) slog.Attr

func (*Config) Vet

func (c *Config) Vet() error

Vet validates the config values