sentry

README

sentry

Sentry client with additional functionality and helpers to complement the official one.

Install

go get github.com/altipla-consulting/sentry

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using gofmt.

License

MIT License

Documentation

Overview

Package sentry has a client with additional functionality and helpers to complement the official one.

Index

• Constants
• func LogBreadcrumb(ctx context.Context, level sentry.Level, category, message string)
• func WithContext(ctx context.Context) context.Context
• type Client
  • func NewClient(dsn string) *Client
  • func (client *Client) Report(ctx context.Context, appErr error)
  • func (client *Client) ReportPanic(ctx context.Context, panicErr interface{})
  • func (client *Client) ReportPanics(ctx context.Context)
  • func (client *Client) ReportPanicsRequest(r *http.Request)
  • func (client *Client) ReportRequest(r *http.Request, appErr error)
• type Sentry
  • func FromContext(ctx context.Context) *Sentry

Constants

const (
	LevelFatal   = sentry.LevelFatal
	LevelWarning = sentry.LevelWarning
	LevelError   = sentry.LevelError
	LevelInfo    = sentry.LevelInfo
	LevelDebug   = sentry.LevelDebug
)

Functions

func LogBreadcrumb

func LogBreadcrumb(ctx context.Context, level sentry.Level, category, message string)

LogBreadcrumb logs a new breadcrumb in the Sentry instance of the context.

func WithContext

func WithContext(ctx context.Context) context.Context

WithContext stores a new instance of Sentry in the context and returns the new generated context that you should use everywhere.

Types

type Client

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

Client wraps a Sentry connection.

func NewClient

func NewClient(dsn string) *Client

NewClient opens a new connection to the Sentry report API. If dsn is empty it will return nil. A nil client can be used safely but it won't report anything.

func (*Client) Report

func (client *Client) Report(ctx context.Context, appErr error)

Report reports an error to Sentry.

func (*Client) ReportPanic

func (client *Client) ReportPanic(ctx context.Context, panicErr interface{})

ReportPanic sends a panic correctly formated to the server if the argument is not nil.

func (*Client) ReportPanics

func (client *Client) ReportPanics(ctx context.Context)

ReportPanics detects panics in the rest of the body of the function and reports it if one occurs.

func (*Client) ReportPanicsRequest

func (client *Client) ReportPanicsRequest(r *http.Request)

ReportPanicsRequest detects pancis in the body of the function and reports them linked to a HTTP request.

func (*Client) ReportRequest

func (client *Client) ReportRequest(r *http.Request, appErr error)

ReportRequest reports an error linked to a HTTP request.

type Sentry

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

Sentry accumulates info through out the whole request to send them in case an error is reported.

func FromContext

func FromContext(ctx context.Context) *Sentry

FromContext returns the Sentry instance stored in the context. If no instance was created it will return nil.