slogzap

README

slog: Zap handler

A zap Handler for slog Go library.

See also:

• slog-multi: slog.Handler chaining, fanout, routing, failover, load balancing...
• slog-formatter: slog attribute formatting
• slog-sampling: slog sampling policy
• slog-gin: Gin middleware for slog logger
• slog-echo: Echo middleware for slog logger
• slog-fiber: Fiber middleware for slog logger
• slog-datadog: A slog handler for Datadog
• slog-rollbar: A slog handler for Rollbar
• slog-sentry: A slog handler for Sentry
• slog-syslog: A slog handler for Syslog
• slog-logstash: A slog handler for Logstash
• slog-fluentd: A slog handler for Fluentd
• slog-graylog: A slog handler for Graylog
• slog-loki: A slog handler for Loki
• slog-slack: A slog handler for Slack
• slog-telegram: A slog handler for Telegram
• slog-mattermost: A slog handler for Mattermost
• slog-microsoft-teams: A slog handler for Microsoft Teams
• slog-webhook: A slog handler for Webhook
• slog-kafka: A slog handler for Kafka
• slog-parquet: A slog handler for Parquet + Object Storage
• slog-zap: A slog handler for Zap
• slog-zerolog: A slog handler for Zerolog
• slog-logrus: A slog handler for Logrus

🚀 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

• Ping me on twitter @samuelberthe (DMs, mentions, whatever :))
• Fork the project
• Fix open issues or request new features

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

• func DefaultConverter(loggerAttr []slog.Attr, record *slog.Record) []zapcore.Field
• type Converter
• type Option
  • func (o Option) NewZapHandler() slog.Handler
• type ZapHandler
  • func (h *ZapHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *ZapHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *ZapHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *ZapHandler) WithGroup(name string) slog.Handler

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