slogor

README

Slogor - A colorful slog handler

Slogor is a Go package designed to enhance logging capabilities. It provides functionalities for configuring the console mode and defining ANSI color codes, allowing developers to create more visually appealing and informative logs within their applications. With Slogor, users can improve the readability and presentation of their logs, making the debugging and monitoring process more efficient and intuitive.

✨ Features

• 🚀 Fast and memory efficient
• 🧑‍💻 Standard logging with slog and close to official TextHandler
• 🎉 Concurrent/Thread-safe
• 🌈 ANSI colored with automatic Windows support
• ✅ Dependency free (except under Windows)
• ♻️ Customizable writer, logging level and time format
• 🔧 Debug with the caller path

❓ How to use

slog.SetDefault(slog.New(slogor.NewHandler(os.Stderr, slogor.SetLevel(slog.LevelDebug), slogor.SetTimeFormat(time.Stamp), slogor.ShowSource())))
slog.Info("I'm an information message, everything's fine")

• Minimal example: https://gitlab.com/greyxor/slogor/-/snippets/3612780
• Complete example: https://gitlab.com/greyxor/slogor/-/snippets/3611844

❓ How to hide time ?

Give an empty time format(TimeFormat) to not display the time

👷 Thanks to contributors

Documentation

Overview

Package slogor provides a colorful slog handler.

Index

• func Err(err any) slog.Attr
• type GroupOrAttrs
• type Handler
  • func NewHandler(writer io.Writer, fns ...OptionFn) *Handler
  • func (h *Handler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *Handler) Handle(_ context.Context, record slog.Record) error
  • func (h *Handler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *Handler) WithGroup(group string) slog.Handler
• type MapOfLevel
• type OptionFn
  • func DisableColor() OptionFn
  • func SetLevel(lvl slog.Leveler) OptionFn
  • func SetLevelStr(strLvl MapOfLevel) OptionFn
  • func SetTimeFormat(fmt string) OptionFn
  • func ShowSource() OptionFn

Functions

func Err

func Err(err any) slog.Attr

Err creates a slog.Attr error from anything.

Types

type GroupOrAttrs

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

type Handler

type Handler struct {
	Writer  io.Writer   // Writer is the destination for the log records.
	Mutex   *sync.Mutex // Mutex for handling concurrent access to the handler.
	Options options     // Options is the configuration for the log handler.
	// contains filtered or unexported fields
}

Handler is a slog.Handler that writes Records to an io.Writer as a sequence of colorful time, message, and pairs separated by spaces and followed by a newline.

func NewHandler

func NewHandler(writer io.Writer, fns ...OptionFn) *Handler

NewHandler creates a Handler that writes to w with the provided Options.

func (*Handler) Enabled

func (h *Handler) Enabled(_ context.Context, level slog.Level) bool

Enabled reports whether the handler handles records at the given level. The handler ignores records whose level is lower.

func (*Handler) Handle

func (h *Handler) Handle(_ context.Context, record slog.Record) error

Handle processes the log record and writes it to the writer with appropriate formatting.

func (*Handler) WithAttrs

func (h *Handler) WithAttrs(attrs []slog.Attr) slog.Handler

WithAttrs returns a new handler with the attrs attached to it.

func (*Handler) WithGroup

func (h *Handler) WithGroup(group string) slog.Handler

WithGroup returns a new handler with the new group attached to it.

type MapOfLevel

type MapOfLevel = map[slog.Leveler]string

type OptionFn

type OptionFn func(*options)

func DisableColor

func DisableColor() OptionFn

DisableColor.

func SetLevel

func SetLevel(lvl slog.Leveler) OptionFn

SetLevel set the minimum log level to handle. By default, level INFO is set.

func SetLevelStr

func SetLevelStr(strLvl MapOfLevel) OptionFn

SetLevelStr set the handler "level to string" map. The default one is used if none specified.

func SetTimeFormat

func SetTimeFormat(fmt string) OptionFn

SetTimeFormat specifies the time format for the log records. By default, nothing is reported.

func ShowSource

func ShowSource() OptionFn

ShowSource indicates whether to display the source of the log records. By default, nothing is reported.