Zerolog
Zerolog is a fast and efficient logging library for Go, designed for structured logging. This guide demonstrates how to integrate Zerolog with Sentry.
For a complete example, visit the Go SDK source code repository.
Go Dev-style API documentation is also available.
go get github.com/getsentry/sentry-go/zerolog
To integrate Sentry with Zerolog, you need to set up a custom writer that sends logs to Sentry based on the configured levels.
import (
"errors"
"time"
"os"
"github.com/getsentry/sentry-go"
sentryzerolog "github.com/getsentry/sentry-go/zerolog"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
// Initialize Sentry
err := sentry.Init(sentry.ClientOptions{
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
// Modify or filter events before sending them to Sentry
return event
},
Debug: true,
AttachStacktrace: true,
})
if err != nil {
log.Fatal().Err(err).Msg("sentry initialization failed")
}
defer sentry.Flush(2 * time.Second)
// Configure Zerolog to use Sentry as a writer
sentryWriter, err := sentryzerolog.New(sentryzerolog.Config{
ClientOptions: sentry.ClientOptions{
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
},
Options: sentryzerolog.Options{
Levels: []zerolog.Level{zerolog.ErrorLevel, zerolog.FatalLevel, zerolog.PanicLevel},
WithBreadcrumbs: true,
FlushTimeout: 3 * time.Second,
},
})
if err != nil {
log.Fatal().Err(err).Msg("failed to create sentry writer")
}
defer sentryWriter.Close()
// Use Sentry writer in Zerolog
log.Logger = log.Output(zerolog.MultiLevelWriter(zerolog.ConsoleWriter{Out: os.Stderr}, sentryWriter))
// Log an InfoLevel entry to STDERR (not sent to Sentry)
log.Info().Msg("Application has started")
// Log an ErrorLevel entry to STDERR and Sentry
log.Error().Msg("oh no!")
// Log a FatalLevel entry to STDERR, send to Sentry, and terminate the application
log.Fatal().Err(errors.New("can't continue")).Msg("fatal error occurred")
}
sentryzerolog provides options to configure the integration with Sentry. It expects a sentryzerolog.Config that has sentry.ClientOptions and sentryzerolog.Options. The sentry.ClientOptions are used to initialize the Sentry client, and the sentryzerolog.Options are used to configure the Zerolog integration.
The sentryzerolog.Options struct has the following fields:
// Levels specifies the log levels that will trigger event sending to Sentry.
// Only log messages at these levels will be sent. By default, the levels are
// Error, Fatal, and Panic.
Levels []zerolog.Level
// WithBreadcrumbs, when enabled, adds log entries as breadcrumbs in Sentry.
// Breadcrumbs provide a trail of events leading up to an error, which can
// be invaluable for understanding the context of issues.
WithBreadcrumbs bool
// FlushTimeout sets the maximum duration allowed for flushing events to Sentry.
// This is the time limit within which all pending events must be sent to Sentry
// before the application exits. A typical use is ensuring all logs are sent before
// application shutdown. The default timeout is usually 3 seconds.
FlushTimeout time.Duration
- Using
hubProviderfor Scoped Sentry Hubs
The hubProvider allows you to configure the Sentry hook to use a custom Sentry hub. This can be particularly useful when you want to scope logs to specific goroutines or operations, enabling more precise grouping and context in Sentry.
You can set a custom hubProvider function using the SetHubProvider method:
sentryHook.SetHubProvider(func() *sentry.Hub {
// Create or return a specific Sentry hub
return sentry.NewHub(sentry.GetCurrentHub().Client(), sentry.NewScope())
})
This ensures that logs from specific contexts or threads use the appropriate Sentry hub and scope.
Use Zerolog as you normally would, and it will automatically send logs at or above the specified levels to Sentry.
Note: Ensure Sentry is flushed before the application exits to avoid losing any pending events.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").