slog-slack
slog-slack copied to clipboard
🚨 slog: Slack handler
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
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 forslog
logger
Loggers:
-
slog-zap: A
slog
handler forZap
-
slog-zerolog: A
slog
handler forZerolog
-
slog-logrus: A
slog
handler forLogrus
Log sinks:
-
slog-datadog: A
slog
handler forDatadog
-
slog-betterstack: A
slog
handler forBetterstack
-
slog-rollbar: A
slog
handler forRollbar
-
slog-loki: A
slog
handler forLoki
-
slog-sentry: A
slog
handler forSentry
-
slog-syslog: A
slog
handler forSyslog
-
slog-logstash: A
slog
handler forLogstash
-
slog-fluentd: A
slog
handler forFluentd
-
slog-graylog: A
slog
handler forGraylog
-
slog-quickwit: A
slog
handler forQuickwit
-
slog-slack: A
slog
handler forSlack
-
slog-telegram: A
slog
handler forTelegram
-
slog-mattermost: A
slog
handler forMattermost
-
slog-microsoft-teams: A
slog
handler forMicrosoft Teams
-
slog-webhook: A
slog
handler forWebhook
-
slog-kafka: A
slog
handler forKafka
-
slog-nats: A
slog
handler forNATS
-
slog-parquet: A
slog
handler forParquet
+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
Timeout time.Duration // default: 10s
// 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.