README
¶
Official Sentry Integration for slog
Go.dev Documentation: https://pkg.go.dev/github.com/getsentry/sentry-go/slog Example Usage: https://github.com/getsentry/sentry-go/tree/master/_examples/slog
Installation
go get github.com/getsentry/sentry-go/slog
Usage
package main
import (
"context"
"log/slog"
"github.com/getsentry/sentry-go"
sentryslog "github.com/getsentry/sentry-go/slog"
)
func main() {
// Initialize Sentry
err := sentry.Init(sentry.ClientOptions{
Dsn: "your-public-dsn",
Debug: true,
})
if err != nil {
panic(err)
}
defer sentry.Flush(5 * time.Second)
ctx := context.Background()
handler := sentryslog.Option{
LogLevel: []slog.Level{slog.LevelWarn, slog.LevelInfo, slog.LevelError, sentryslog.LevelFatal},
}.NewSentryHandler(ctx)
logger := slog.New(handler)
// Example logging
logger.Info("This will be sent to Sentry as a log")
logger.Error("An error occurred", "user", "test-user")
// These will be ignored
logger.Debug("This will be ignored")
}
Configuration
The slog-sentry package offers several options to customize how logs are handled and sent to Sentry. These are specified through the Option struct:
-
LogLevel: Slice of specific levels to sendLogentries to Sentry. Defaults to[]slog.Level{slog.LevelDebug, slog.LevelInfo, slog.LevelWarn, slog.LevelError, LevelFatal}. -
AttrFromContext: Functions to extract additional attributes from the context. -
AddSource: Include file/line source info in Sentry log attributes. Defaults tofalse. -
ReplaceAttr: Allows modification or filtering of attributes before sending to Sentry.
Example Customization
handler := slogSentry.Option{
LogLevel: []slog.Level{slog.LevelWarn, slog.LevelError, sentryslog.LevelFatal},
AddSource: true,
}.NewSentryHandler(ctx)
Notes
- Always call
FlushorFlushWithContextto ensure all logs are sent to Sentry before program termination
Documentation
¶
Index ¶
Constants ¶
const LevelFatal = slog.Level(12)
LevelFatal is a custom slog.Level that maps to sentry.LevelFatal.
const SlogOrigin = "auto.log.slog"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option struct {
// LogLevel specifies the exact log levels to capture and send to Sentry as Log entries.
// Only logs at these specific levels will be processed as log entries.
// Defaults to []slog.Level{slog.LevelDebug, slog.LevelInfo, slog.LevelWarn, slog.LevelError, LevelFatal}.
LogLevel []slog.Level
// 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
}
Source Files