clsentry

Documentation

Overview

Package clsentry provides Sentry error reporting.

Index

• Variables
• func Provide() fx.Option
• func StringFromEventID(id *sentry.EventID) *string
• func TestProvide() fx.Option
• type BeforeSendFunc
• type Config
• type ObservedEvents
  • func (o *ObservedEvents) Events() (evs []sentry.Event)

Variables

var ErrFlushFailed = errors.New("failed to flush sentry hub")

ErrFlushFailed is returned when the flush fails during fx shutdown.

Functions

func Provide

func Provide() fx.Option

Provide configures the DI for providng rpc.

func StringFromEventID

func StringFromEventID(id *sentry.EventID) *string

StringFromEventID converts a sentry event ID to a string pointer.

func TestProvide

func TestProvide() fx.Option

TestProvide provides dependencies in a way that makes testing Sentry integration easier.

Types

type BeforeSendFunc

type BeforeSendFunc func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event

BeforeSendFunc allows events to be modified before they are sent to Sentry.

type Config

type Config struct {
	// Sentry DSN to send data to.
	DSN string `env:"DSN"`
	// TracesSampleRate is the rate at which traces are captures for Sentry.
	TracesSampleRate float64 `env:"TRACES_SAMPLE_RATE" envDefault:"1.0"`
	// DefaultFlushTimeout is the default timeout for flushing to Sentry.
	DefaultFlushTimeout time.Duration `env:"DEFAULT_FLUSH_TIMEOUT" envDefault:"2s"`
	// AttachStacktrace is whether to attach stacktrace to pure capture message calls.
	AttachStacktrace bool `env:"ATTACH_STACKTRACE" envDefault:"true"`
	// If set, will add this environment to the Sentry scope.
	Environment string `env:"ENVIRONMENT" envDefault:"development"`
}

Config configures.

type ObservedEvents

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

ObservedEvents keeps observe logs.

func (*ObservedEvents) Events

func (o *ObservedEvents) Events() (evs []sentry.Event)

Events returns a copy of all the ovserved events. It is safe to call from multiple goroutines.