zapsentry

README

Sentry client for zap logger

Integration of sentry client into zap.Logger is pretty simple:

func modifyToSentryLogger(log *zap.Logger, DSN string) *zap.Logger {
	cfg := zapsentry.Configuration{
		Level: zapcore.ErrorLevel, //when to send message to sentry
		Tags: map[string]string{
			"component": "system",
		},
	}
	core, err := zapsentry.NewCore(cfg, zapsentry.NewSentryClientFromDSN(DSN))
	//in case of err it will return noop core. so we can safely attach it
	if err != nil {
		log.Warn("failed to init zap", zap.Error(err))
	}
	return zapsentry.AttachCoreToLogger(core, log)
}

Documentation

Index

• func AttachCoreToLogger(sentryCore zapcore.Core, l *zap.Logger) *zap.Logger
• func NewCore(cfg Configuration, factory SentryClientFactory) (zapcore.Core, error)
• type ClientGetter
• type Configuration
• type SentryClientFactory
  • func NewSentryClientFromClient(client *sentry.Client) SentryClientFactory
  • func NewSentryClientFromDSN(DSN string) SentryClientFactory

Functions

func AttachCoreToLogger

func AttachCoreToLogger(sentryCore zapcore.Core, l *zap.Logger) *zap.Logger

AttachCoreToLogger attaches sentry to zap logger

func NewCore

func NewCore(cfg Configuration, factory SentryClientFactory) (zapcore.Core, error)

NewCore creates new zapcore object

Types

type ClientGetter

type ClientGetter interface {
	GetClient() *sentry.Client
}

ClientGetter interface getter for sentry client

type Configuration

type Configuration struct {
	Tags              map[string]string
	DisableStacktrace bool
	Level             zapcore.Level
	FlushTimeout      time.Duration
	Hub               *sentry.Hub
}

Configuration is a minimal set of parameters for Sentry integration.

type SentryClientFactory

type SentryClientFactory func() (*sentry.Client, error)

SentryClientFactory function that return sentry client

func NewSentryClientFromClient

func NewSentryClientFromClient(client *sentry.Client) SentryClientFactory

NewSentryClientFromClient creates new sentry client from sentry client reference

func NewSentryClientFromDSN

func NewSentryClientFromDSN(DSN string) SentryClientFactory

NewSentryClientFromDSN creates new sentry client from DSN value