sentry

README

sentry

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

Basic usage

import (
  "libs.altipla.consulting/sentry"
)

Documentation

Index

• Constants
• func LogBreadcrumb(ctx context.Context, level Level, category, message string)
• func WithContext(ctx context.Context) context.Context
• func WithContextRPC(ctx context.Context, rpcService, rpcMethod string) context.Context
• type Client
  • func NewClient(dsn string) *Client
  • func (client *Client) Report(ctx context.Context, appErr error)
  • func (client *Client) ReportInternal(ctx context.Context, appErr error)
  • func (client *Client) ReportPanics(ctx context.Context)
  • func (client *Client) ReportPanicsRequest(r *http.Request)
  • func (client *Client) ReportRequest(appErr error, r *http.Request)
• type Level
• type Sentry
  • func FromContext(ctx context.Context) *Sentry

Constants

const (
	// LevelCritical is a critical breadcrumb.
	LevelCritical = Level("critical")

	// LevelWarning is a warning breadcrumb.
	LevelWarning = Level("warning")

	// LevelError is an error breadcrumb.
	LevelError = Level("error")

	// LevelInfo is an info breadcrumb.
	LevelInfo = Level("info")

	// LevelDebug is a debug breadcrumb.
	LevelDebug = Level("debug")
)

Functions

func LogBreadcrumb

func LogBreadcrumb(ctx context.Context, level 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.

func WithContextRPC

func WithContextRPC(ctx context.Context, rpcService, rpcMethod string) context.Context

WithContextRPC stores a new instance of Sentry in the context and returns the new generated context that you should use everywhere annotating it with the RPC service name and RPC method name. Used mostly for GRPC calls.

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.

func (*Client) Report

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

Report reports an error to Sentry.

func (*Client) ReportInternal

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

ReportInternal reports an error not linked to a HTTP request.

func (*Client) ReportPanics

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

ReportPanics detects panics in the body of the function and reports them.

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(appErr error, r *http.Request)

ReportRequest reports an error linked to a HTTP request.

type Level

type Level string

Level of a breadcrumb.

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.