slog-error

Go library to embed Attr into error for slog

Usage

This library provides only two APIs.

// WithError gets attrs from err and returns a new logger with err and attrs.
func WithError(logger *slog.Logger, err error) *slog.Logger
// WithAttrs returns an error with attrs.
func WithAttrs(err error, attrs ...slog.Attr) error

package main

import (
	"errors"
	"fmt"
	"log/slog"
	"os"

	"github.com/suzuki-shunsuke/slog-error/slogerr"
)

func main() {
	logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{}))
	if err := core(); err != nil {
		// time=2023-12-29T22:30:06.992+09:00 level=ERROR msg="command failed" name=mike error="user is not found"
		slogerr.WithError(logger, err).Error("command failed")
	}
}

func core() error {
	if err := getUser(); err != nil {
		return fmt.Errorf("get a user: %w", err)
	}
	return nil
}

func getUser() error {
	return slogerr.WithAttrs(
		errors.New("user is not found"),
		slog.String("name", "mike"))
}

LICENSE

MIT