slogzap

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2023 License: MIT Imports: 8 Imported by: 0

README

slog: Zap handler

tag Go Version GoDoc Build Status Go report Coverage Contributors License

A zap Handler for slog Go library.

See also:

🚀 Install

go get github.com/samber/slog-zap

Compatibility: go >= 1.21

No breaking changes will be made to exported APIs before v2.0.0.

💡 Usage

GoDoc: https://pkg.go.dev/github.com/samber/slog-zap

Handler options
type Option struct {
	// log level (default: debug)
	Level slog.Leveler

	// optional: zap logger (default: zap.L())
	Logger *zap.Logger

	// optional: customize json payload builder
	Converter Converter
}
Example
import (
    slogzap "github.com/samber/slog-zap"
	"go.uber.org/zap"
    "log/slog"
)

func main() {
	zapLogger, _ := zap.NewProduction()

	logger := slog.New(slogzap.Option{Level: slog.LevelDebug, Logger: zapLogger}.NewZapHandler())
    logger = logger.
        With("environment", "dev").
        With("release", "v1.0.0")

    // log error
    logger.
        With("category", "sql").
        With("query.statement", "SELECT COUNT(*) FROM users;").
        With("query.duration", 1*time.Second).
        With("error", fmt.Errorf("could not count users")).
        Error("caramba!")

    // log user signup
    logger.
        With(
            slog.Group("user",
                slog.String("id", "user-123"),
                slog.Time("created_at", time.Now()),
            ),
        ).
        Info("user registration")
}

🤝 Contributing

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

GitHub Sponsors

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultConverter

func DefaultConverter(loggerAttr []slog.Attr, record *slog.Record) []zapcore.Field

Types

type Converter

type Converter func(loggerAttr []slog.Attr, record *slog.Record) []zapcore.Field

type Option

type Option struct {
	// log level (default: debug)
	Level slog.Leveler

	// optional: zap logger (default: zap.L())
	Logger *zap.Logger

	// optional: customize json payload builder
	Converter Converter
}

func (Option) NewZapHandler

func (o Option) NewZapHandler() slog.Handler

type ZapHandler

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

func (*ZapHandler) Enabled

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

func (*ZapHandler) Handle

func (h *ZapHandler) Handle(ctx context.Context, record slog.Record) error

func (*ZapHandler) WithAttrs

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

func (*ZapHandler) WithGroup

func (h *ZapHandler) WithGroup(name string) slog.Handler

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL