errors

README

Error Handling (sentry)

• Each microservice need to expose "/health" and return with http 200, this is important for the load balancing of the API gateway
• Unhandled exception handling ("in the wild")
• Frontend Application
• Returning 5xx to client (can indicate operations issues)
• Depending on application logic (additional errors; cases that should not happen; security)
• Implausible responses from upstream services (e.g. after validation of result from external API)

Environment based configuration

• ENVIRONMENT
  • Default environment of sentry reported in the dashboard
• SENTRY_DSN
  • URL of the sentry DSN
• SENTRY_RELEASE
  • Name of the release e.g. git commit or similar

Documentation

Index

• func ContextTransfer(ctx, targetCtx context.Context) context.Context
• func Handle(ctx context.Context, rp interface{})
• func HandleError(rp interface{}, handlerName string, w http.ResponseWriter, r *http.Request)
• func HandleErrorNoStack(ctx context.Context, err error)
• func HandleRequest(handlerName string, w http.ResponseWriter, r *http.Request)
• func HandleWithCtx(ctx context.Context, handlerName string)
• func Handler() func(http.Handler) http.Handler
• func Hide(ctx context.Context, err, exposedErr error) error
• func IsStdLibContextError(err error) bool
• func New(text string) error
• func WrapWithExtra(err error, extraInfo map[string]interface{}) error
• type BricksError
  • func NewBricksError(opts ...BricksErrorOption) *BricksError
  • func (e *BricksError) AsRuntimeError() *runtime.Error
  • func (e *BricksError) Code() string
  • func (e *BricksError) Detail() string
  • func (e *BricksError) Error() string
  • func (e *BricksError) Status() int
  • func (e *BricksError) Title() string
• type BricksErrorOption
  • func WithCode(s string) BricksErrorOption
  • func WithDetail(s string) BricksErrorOption
  • func WithStatus(s int) BricksErrorOption
  • func WithTitle(s string) BricksErrorOption
• type PanicWrap

Functions

func ContextTransfer

func ContextTransfer(ctx, targetCtx context.Context) context.Context

ContextTransfer copies error handling related information from one context to another.

func Handle

func Handle(ctx context.Context, rp interface{})

Handle logs the given error and reports it to sentry.

func HandleError

func HandleError(rp interface{}, handlerName string, w http.ResponseWriter, r *http.Request)

HandleError reports the passed error to sentry

func HandleErrorNoStack

func HandleErrorNoStack(ctx context.Context, err error)

func HandleRequest

func HandleRequest(handlerName string, w http.ResponseWriter, r *http.Request)

HandleRequest should be called with defer to recover panics in request handlers

func HandleWithCtx

func HandleWithCtx(ctx context.Context, handlerName string)

HandleWithCtx should be called with defer to recover panics in goroutines

func Handler

func Handler() func(http.Handler) http.Handler

Handler implements a panic recovering middleware

func Hide

func Hide(ctx context.Context, err, exposedErr error) error

Hide checks whether the given error err is a context.Canceled or context.DeadlineExceeded error and if so exposes these errors as wrapped errors while maintaining the given err as string. If the optional exposedErr is provided, it is attached as prefix to the returned error. If the given err is not any of the above ones, the given exposedErr (if present) is wrapped as prefix to the returned error, if there is an err that is not nil.

func IsStdLibContextError

func IsStdLibContextError(err error) bool

func New

func New(text string) error

New returns an error that formats as the given text.

func WrapWithExtra

func WrapWithExtra(err error, extraInfo map[string]interface{}) error

WrapWithExtra adds extra data to an error before reporting to Sentry

Types

type BricksError

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

BricksError - a bricks err is a bricks specific error which provides convenience functions to be transformed into runtime.Errors (JSON errors) pb generate can be used to create a set of pre defined BricksErrors based on a JSON specification, see pb generate for details

func NewBricksError

func NewBricksError(opts ...BricksErrorOption) *BricksError

func (*BricksError) AsRuntimeError

func (e *BricksError) AsRuntimeError() *runtime.Error

AsRuntimeError - returns the BricksError as bricks runtime.Error which aligns with a JSON error object

func (*BricksError) Code

func (e *BricksError) Code() string

func (*BricksError) Detail

func (e *BricksError) Detail() string

func (*BricksError) Error

func (e *BricksError) Error() string

func (*BricksError) Status

func (e *BricksError) Status() int

func (*BricksError) Title

func (e *BricksError) Title() string

type BricksErrorOption

type BricksErrorOption func(e *BricksError)

func WithCode

func WithCode(s string) BricksErrorOption

func WithDetail

func WithDetail(s string) BricksErrorOption

func WithStatus

func WithStatus(s int) BricksErrorOption

func WithTitle

func WithTitle(s string) BricksErrorOption

type PanicWrap

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

PanicWrap wraps a panic for HandleRequest