sentryslog

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"
	slogSentry "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)

	// Set up slog with Sentry handler
	handler := slogSentry.Option{
		Level: slog.LevelError, // Minimum log level
		AddSource: true,        // Include file/line source info
	}.NewSentryHandler()
	logger := slog.New(handler)

	// Example logging
	logger.Info("This will not be sent to Sentry")
	logger.Error("An error occurred", "user", "test-user")
}

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:

• Level: Minimum log level to send to Sentry. Defaults to slog.LevelDebug.

• Hub: Custom Sentry hub to use; defaults to the current Sentry hub if not set.

• Converter: Custom function to transform logs into Sentry events (default is DefaultConverter).

• AttrFromContext: Functions to extract additional attributes from the context.

• AddSource: Include file/line source info in Sentry events. Defaults to false.

• ReplaceAttr: Allows modification or filtering of attributes before sending to Sentry.

Example Customization

handler := slogSentry.Option{
	Level: slog.LevelWarn,
	Converter: func(addSource bool, replaceAttr func([]string, slog.Attr) slog.Attr, attrs []slog.Attr, groups []string, record *slog.Record, hub *sentry.Hub) *sentry.Event {
		// Custom conversion logic
		return &sentry.Event{
			Message: record.Message,
		}
	},
	AddSource: true,
}.NewSentryHandler()

Notes

• Always call Flush to ensure all events are sent to Sentry before program termination

Documentation

Index

• Variables
• func DefaultConverter(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, ...) *sentry.Event
• type Converter
• type Option
  • func (o Option) NewSentryHandler() slog.Handler
• type SentryHandler
  • func (h *SentryHandler) Enabled(_ context.Context, level slog.Level) bool
  • func (h *SentryHandler) Handle(ctx context.Context, record slog.Record) error
  • func (h *SentryHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (h *SentryHandler) WithGroup(name string) slog.Handler

Variables

var (
	LogLevels = map[slog.Level]sentry.Level{
		slog.LevelDebug: sentry.LevelDebug,
		slog.LevelInfo:  sentry.LevelInfo,
		slog.LevelWarn:  sentry.LevelWarning,
		slog.LevelError: sentry.LevelError,
	}
)

Functions

func DefaultConverter

func DefaultConverter(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, loggerAttr []slog.Attr, groups []string, record *slog.Record, _ *sentry.Hub) *sentry.Event

Types

type Converter

type Converter func(addSource bool, replaceAttr func(groups []string, a slog.Attr) slog.Attr, loggerAttr []slog.Attr, groups []string, record *slog.Record, hub *sentry.Hub) *sentry.Event

type Option

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
}

func (Option) NewSentryHandler

func (o Option) NewSentryHandler() slog.Handler

type SentryHandler

type SentryHandler struct {
	// contains filtered or unexported fields
}

func (*SentryHandler) Enabled

func (h *SentryHandler) Enabled(_ context.Context, level slog.Level) bool

func (*SentryHandler) Handle

func (h *SentryHandler) Handle(ctx context.Context, record slog.Record) error

func (*SentryHandler) WithAttrs

func (h *SentryHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (*SentryHandler) WithGroup

func (h *SentryHandler) WithGroup(name string) slog.Handler