slogwatermill

README

slog: watermill logger adapter

Watermill logger adapter for slog logger

Watermill LoggerAdapter implementation to log using slog.

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

🚀 Install

go get github.com/denisss025/slog-watermill

Compatibility: go >= 1.21

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

💡 Usage

Minimal

Using custom time formatters

Using custom logger sub-group

Adding custom attributes

JSON output

🤝 Contributing

• 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 Denis Novikov.

This project is MIT licensed.

Documentation

Index

• type Adapter
  • func New(logger *slog.Logger) *Adapter
  • func NewWithConfig(logger *slog.Logger, config Config) *Adapter
  • func (a Adapter) Debug(msg string, fields watermill.LogFields)
  • func (a Adapter) Error(msg string, err error, fields watermill.LogFields)
  • func (a Adapter) Info(msg string, fields watermill.LogFields)
  • func (a Adapter) Trace(msg string, fields watermill.LogFields)
  • func (a Adapter) With(fields watermill.LogFields) watermill.LoggerAdapter
• type Config
• type Level

Types

type Adapter

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

Adapter implements watermill.LoggerAdapter.

func New

func New(logger *slog.Logger) *Adapter

New creates an instance of Adapter with debug log level and a watermill group.

func NewWithConfig

func NewWithConfig(logger *slog.Logger, config Config) *Adapter

NewWithConfig creates an instance with a given log level and a watermill group.

func (Adapter) Debug

func (a Adapter) Debug(msg string, fields watermill.LogFields)

Debug logs some debug information.

func (Adapter) Error

func (a Adapter) Error(msg string, err error, fields watermill.LogFields)

Error logs an error.

func (Adapter) Info

func (a Adapter) Info(msg string, fields watermill.LogFields)

Info logs some useful information.

func (Adapter) Trace

func (a Adapter) Trace(msg string, fields watermill.LogFields)

Trace logs trace information.

func (Adapter) With

func (a Adapter) With(fields watermill.LogFields) watermill.LoggerAdapter

With creates a new instance with some extra fields.

type Config

type Config struct {
	// Log level (default: LevelDebug).
	Level Level
}

Adapter config.

type Level

type Level int

A Level is the importance or severity of a log event. The higher the level, the more important or severe the event.

const (
	LevelTrace Level = -8
	LevelDebug Level = -4
	LevelInfo  Level = 0
	LevelWarn  Level = 4
	LevelError Level = 8
)