A Sentry Handler for slog Go library.
See also:
- slog-multi:
slog.Handlerchaining, fanout, routing, failover, load balancing... - slog-formatter:
slogattribute formatting - slog-sampling:
slogsampling policy - slog-gin: Gin middleware for
sloglogger - slog-echo: Echo middleware for
sloglogger - slog-fiber: Fiber middleware for
sloglogger - slog-datadog: A
sloghandler forDatadog - slog-rollbar: A
sloghandler forRollbar - slog-sentry: A
sloghandler forSentry - slog-syslog: A
sloghandler forSyslog - slog-logstash: A
sloghandler forLogstash - slog-fluentd: A
sloghandler forFluentd - slog-graylog: A
sloghandler forGraylog - slog-loki: A
sloghandler forLoki - slog-slack: A
sloghandler forSlack - slog-telegram: A
sloghandler forTelegram - slog-mattermost: A
sloghandler forMattermost - slog-microsoft-teams: A
sloghandler forMicrosoft Teams - slog-webhook: A
sloghandler forWebhook - slog-kafka: A
sloghandler forKafka - slog-parquet: A
sloghandler forParquet+Object Storage - slog-zap: A
sloghandler forZap - slog-zerolog: A
sloghandler forZerolog - slog-logrus: A
sloghandler forLogrus
go get github.com/samber/slog-sentryCompatibility: go >= 1.21
No breaking changes will be made to exported APIs before v2.0.0.
GoDoc: https://pkg.go.dev/github.com/samber/slog-sentry
type Option struct {
// log level (default: debug)
Level slog.Leveler
// sentry hub (default: current hub)
Hub *sentry.Hub
// optional: customize Sentry event builder
Converter Converter
}Other global parameters:
// default: "extra"
slogsentry.ContextKey = "other"
// default: "error"
slogsentry.ErrorKey = "error"The following attributes are interpreted by slogsentry.DefaultConverter:
| Atribute name | slog.Kind |
Underlying type |
|---|---|---|
| "dist" | string | |
| "environment" | string | |
| "event_id" | string | |
| "platform" | string | |
| "release" | string | |
| "server_name" | string | |
| "tags" | group (see below) | |
| "transaction" | string | |
| "user" | group (see below) | |
| "error" | any | error |
| "request" | any | *http.Request |
| other attributes | * |
Other attributes will be injected in context Sentry field.
Users and tags must be of type slog.Group. Eg:
slog.Group("user",
slog.String("id", "user-123"),
slog.String("username", "samber"),
slog.Time("created_at", time.Now()),
)The Sentry agent is responsible for collecting modules.
import (
"github.com/getsentry/sentry-go"
slogsentry "github.com/samber/slog-sentry"
"log/slog"
)
func main() {
err := sentry.Init(sentry.ClientOptions{
Dsn: myDSN,
EnableTracing: false,
})
if err != nil {
log.Fatal(err)
}
defer sentry.Flush(2 * time.Second)
logger := slog.New(slogsentry.Option{Level: slog.LevelDebug}.NewSentryHandler())
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 request
logger.
With(
slog.Group("user",
slog.String("id", "user-123"),
slog.Time("created_at", time.Now()),
),
).
With("request", httpRequest)
With("status", 200).
Info("received http request")
}- 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-testGive a βοΈ if this project helped you!
Copyright Β© 2023 Samuel Berthe.
This project is MIT licensed.