slogslack

README

slog: Slack handler

A Slack 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

🚀 Install

go get github.com/samber/slog-slack

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-slack

Handler options

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

	// slack webhook url
	WebhookURL string
	// slack bot token
	BotToken string
	// slack channel (default: webhook channel)
	Channel string
	// bot username (default: webhook username)
	Username string
	// bot emoji (default: webhook emoji)
	IconEmoji string
	// bot emoji (default: webhook emoji)
	IconURL string

	// optional: customize Slack message builder
	Converter Converter
}

Attributes will be injected in message attachments.

Example

Using webhook

Generate a webhook here.

import (
	slogslack "github.com/samber/slog-slack"
	"log/slog"
)

func main() {
    webhook := "https://hooks.slack.com/services/xxx/yyy/zzz"
    channel := "alerts"

    logger := slog.New(slogslack.Option{Level: slog.LevelError, WebhookURL: webhook, Channel: channel}.NewSlackHandler())
    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")
}

Using bot token

Use Bot token.

import (
	slogslack "github.com/samber/slog-slack"
	"log/slog"
)

func main() {
    token := "xoxb-"
    channel := "alerts"

    logger := slog.New(slogslack.Option{Level: slog.LevelError, BotToken: token, Channel: channel}.NewSlackHandler())
    logger = logger.
        With("environment", "dev").
        With("release", "v1.0.0")
}

🤝 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) *slack.WebhookMessage
• type Converter
• type Option
  • func (o Option) NewSlackHandler() slog.Handler
• type SlackHandler
  • func (h *SlackHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *SlackHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *SlackHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *SlackHandler) WithGroup(name string) slog.Handler

Functions

func DefaultConverter

func DefaultConverter(loggerAttr []slog.Attr, record *slog.Record) *slack.WebhookMessage

Types

type Converter

type Converter func(loggerAttr []slog.Attr, record *slog.Record) *slack.WebhookMessage

type Option

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

	// slack webhook url
	WebhookURL string
	// slack bot token
	BotToken string
	// slack channel (default: webhook channel)
	Channel string
	// bot username (default: webhook username)
	Username string
	// bot emoji (default: webhook emoji)
	IconEmoji string
	// bot emoji (default: webhook emoji)
	IconURL string

	// optional: customize Slack message builder
	Converter Converter
}

func (Option) NewSlackHandler

func (o Option) NewSlackHandler() slog.Handler

type SlackHandler

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

func (*SlackHandler) Enabled

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

func (*SlackHandler) Handle

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

func (*SlackHandler) WithAttrs

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

func (*SlackHandler) WithGroup

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