logger

Documentation

Index

• Variables
• func Error(err error) slog.Attr
• func IsEnabled(cfg *Config) bool
• func Meta(ctx context.Context) []slog.Attr
• type Config
  • func (c *Config) IsJSON() bool
  • func (c *Config) IsOTLP() bool
  • func (c *Config) IsText() bool
  • func (c *Config) IsTint() bool
• type Logger
  • func NewLogger(params Params) (*Logger, error)
  • func (l *Logger) GetLogger() *slog.Logger
  • func (l *Logger) Log(ctx context.Context, msg Message, attrs ...slog.Attr)
  • func (l *Logger) LogAttrs(ctx context.Context, level slog.Level, msg Message, attrs ...slog.Attr)
• type Message
  • func NewMessage(text string, err error) Message
  • func NewText(text string) Message
  • func (m Message) Level() slog.Level
• type Params

Variables

var ErrNotFound = errors.New("logger: not found")

ErrNotFound for logger.

var Module = fx.Options(
	fx.Provide(NewLogger),
	fx.Provide(provide),
)

Module for fx.

Functions

func Error

func Error(err error) slog.Attr

Error just wraps a slog.Any with key of error.

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for logger.

func Meta

func Meta(ctx context.Context) []slog.Attr

Meta for logger.

Types

type Config

type Config struct {
	Headers header.Map `yaml:"headers,omitempty" json:"headers,omitempty" toml:"headers,omitempty"`
	Kind    string     `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	URL     string     `yaml:"url,omitempty" json:"url,omitempty" toml:"url,omitempty" validate:"omitempty,http_url"`
	Level   string     `yaml:"level,omitempty" json:"level,omitempty" toml:"level,omitempty"`
}

Config for logger.

func (*Config) IsJSON

func (c *Config) IsJSON() bool

IsJSON logger.

func (*Config) IsOTLP

func (c *Config) IsOTLP() bool

IsOTLP logger.

func (*Config) IsText

func (c *Config) IsText() bool

IsText logger.

func (*Config) IsTint

func (c *Config) IsTint() bool

IsTint logger.

type Logger

type Logger struct {
	*slog.Logger
}

Logger allows to pass a function to log.

func NewLogger

func NewLogger(params Params) (*Logger, error)

NewLogger using slog.

func (*Logger) GetLogger

func (l *Logger) GetLogger() *slog.Logger

GetLogger if defined.

func (*Logger) Log

func (l *Logger) Log(ctx context.Context, msg Message, attrs ...slog.Attr)

Log attrs for logger.

func (*Logger) LogAttrs

func (l *Logger) LogAttrs(ctx context.Context, level slog.Level, msg Message, attrs ...slog.Attr)

LogAttrs for logger.

type Message

type Message struct {
	Error error
	Text  string
}

Message represents a log message with text and error information.

func NewMessage

func NewMessage(text string, err error) Message

NewMessage creates a new log message with text and error information.

func NewText

func NewText(text string) Message

NewText creates a new log message with text information.

func (Message) Level

func (m Message) Level() slog.Level

Level returns the log level for the message.

type Params

type Params struct {
	fx.In

	Lifecycle   fx.Lifecycle
	FileSystem  os.FileSystem
	Config      *Config
	ID          env.ID
	Name        env.Name
	Version     env.Version
	Environment env.Environment
}

Params for logger.