Home

Awesome

slog: Sentry handler

tag Go Version GoDoc Build Status Go report Coverage Contributors License

A Sentry Handler for slog Go library.

<div align="center"> <hr> <sup><b>Sponsored by:</b></sup> <br> <a href="https://quickwit.io?utm_campaign=github_sponsorship&utm_medium=referral&utm_content=samber-slog-sentry&utm_source=github"> <div> <img src="https://github.com/samber/oops/assets/2951285/49aaaa2b-b8c6-4f21-909f-c12577bb6a2e" width="240" alt="Quickwit"> </div> <div> Cloud-native search engine for observability - An OSS alternative to Splunk, Elasticsearch, Loki, and Tempo. </div> </a> <hr> </div>

See also:

HTTP middlewares:

Loggers:

Log sinks:

🚀 Install

go get github.com/samber/slog-sentry/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-sentry/v2

Handler options

type Option struct {
    // Level sets the minimum log level to capture and send to Sentry.
    // Logs at this level and above will be processed. The default level is debug.
    Level slog.Leveler
    // Hub specifies the Sentry Hub to use for capturing events.
    // If not provided, the current Hub is used by default.
    Hub *sentry.Hub

    // Converter is an optional function that customizes how log records
    // are converted into Sentry events. By default, the DefaultConverter is used.
    Converter Converter
    // AttrFromContext is an optional slice of functions that extract attributes
    // from the context. These functions can add additional metadata to the log entry.
    AttrFromContext []func(ctx context.Context) []slog.Attr

    // AddSource is an optional flag that, when set to true, includes the source
    // information (such as file and line number) in the Sentry event.
    // This can be useful for debugging purposes.
    AddSource bool
    // ReplaceAttr is an optional function that allows for the modification or
    // replacement of attributes in the log record. This can be used to filter
    // or transform attributes before they are sent to Sentry.
ReplaceAttr func(groups []string, a slog.Attr) slog.Attr
}

Other global parameters:

slogsentry.SourceKey = "source"
slogsentry.ContextKey = "extra"
slogsentry.ErrorKeys = []string{"error", "err"}
slogsentry.LogLevels = map[slog.Level]sentry.Level{...}

Supported attributes

The following attributes are interpreted by slogsentry.DefaultConverter:

Atribute nameslog.KindUnderlying 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"anyerror
"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.

Example

import (
    "github.com/getsentry/sentry-go"
    slogsentry "github.com/samber/slog-sentry/v2"
    "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")
}

Tracing

Import the samber/slog-otel library.

import (
	slogsentry "github.com/samber/slog-sentry"
	slogotel "github.com/samber/slog-otel"
	"go.opentelemetry.io/otel/sdk/trace"
)

func main() {
	tp := trace.NewTracerProvider(
		trace.WithSampler(trace.AlwaysSample()),
	)
	tracer := tp.Tracer("hello/world")

	ctx, span := tracer.Start(context.Background(), "foo")
	defer span.End()

	span.AddEvent("bar")

	logger := slog.New(
		slogsentry.Option{
			// ...
			AttrFromContext: []func(ctx context.Context) []slog.Attr{
				slogotel.ExtractOtelAttrFromContext([]string{"tracing"}, "trace_id", "span_id"),
			},
		}.NewSentryHandler(),
	)

	logger.ErrorContext(ctx, "a message")
}

🤝 Contributing

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

GitHub Sponsors

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.