GitHub - samber/slog-slack: 🚨 slog: Slack handler (original) (raw)

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-mock: slog.Handler for test purposes

HTTP middlewares:

• slog-gin: Gin middleware for slog logger
• slog-echo: Echo middleware for slog logger
• slog-fiber: Fiber middleware for slog logger
• slog-chi: Chi middleware for slog logger
• slog-http: net/http middleware for slog logger

Loggers:

• slog-zap: A slog handler for Zap
• slog-zerolog: A slog handler for Zerolog
• slog-logrus: A slog handler for Logrus

Log sinks:

• slog-datadog: A slog handler for Datadog
• slog-betterstack: A slog handler for Betterstack
• slog-rollbar: A slog handler for Rollbar
• slog-loki: A slog handler for Loki
• 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-quickwit: A slog handler for Quickwit
• 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-nats: A slog handler for NATS
• slog-parquet: A slog handler for Parquet + Object Storage
• slog-channel: A slog handler for Go channels

🚀 Install

go get github.com/samber/slog-slack/v2

Compatibility: go >= 1.21

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

💡 Usage

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

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
// Not implemented yet, but we would like your feedback here: #7
// ThreadTimestamp string

// API request timeout (default: 10s)
Timeout time.Duration

// optional: customize Slack message builder
Converter Converter

// optional: see slog.HandlerOptions
AddSource   bool
ReplaceAttr func(groups []string, a slog.Attr) slog.Attr

}

Attributes will be injected in message attachments.

Other global parameters:

slogslack.SourceKey = "source" slogslack.ColorMapping = map[slog.Level]string{...}

Example

Using webhook

Generate a webhook here.

import ( slogslack "github.com/samber/slog-slack/v2" "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")

// push record to a thread
logger.ErrorContext(
    slogslack.WithThreadTimestamp(context.Background(), "1714929099.4238"),
    "An error",
)

}

Using bot token

Use Bot token.

import ( slogslack "github.com/samber/slog-slack/v2" "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.