import "github.com/getsentry/sentry-go"
client.go dsn.go hub.go integrations.go interfaces.go scope.go sentry.go sourcereader.go stacktrace.go transport.go util.go
const HubContextKey = contextKey(1)HubContextKey is a context key used to store Hub on any context.Context type
const RequestContextKey = contextKey(2)RequestContextKey is a context key used to store http.Request on the context passed to RecoverWithContext
const Version = "0.3.1"Version is the version of the sentry-go SDK.
Logger is an instance of log.Logger that is use to provide debug information about running Sentry Client can be enabled by either using `Logger.SetOutput` directly or with `Debug` client option
func AddBreadcrumb(breadcrumb *Breadcrumb)
AddBreadcrumb records a new breadcrumb.
The total number of breadcrumbs that can be recorded are limited by the configuration on the client.
func AddGlobalEventProcessor(processor EventProcessor)
ConfigureScope invokes a function that can modify the current scope.
The function is passed a mutable reference to the `Scope` so that modifications can be performed.
Flush notifies when all the buffered events have been sent by returning `true` or `false` if timeout was reached.
HasHubOnContext checks whether `Hub` instance is bound to a given `Context` struct.
func Init(options ClientOptions) error
Init initializes whole SDK by creating new `Client` and binding it to the current `Hub`
func PopScope()
PopScope pushes a new scope.
func PushScope()
PushScope pushes a new scope.
SetHubOnContext stores given `Hub` instance on the `Context` struct and returns a new `Context`.
WithScope temporarily pushes a scope for a single call.
This function takes one argument, a callback that executes in the context of that scope.
This is useful when extra data should be send with a single capture call for instance a different level or tags
type Breadcrumb struct {
Category string `json:"category,omitempty"`
Data map[string]interface{} `json:"data,omitempty"`
Level Level `json:"level,omitempty"`
Message string `json:"message,omitempty"`
Timestamp int64 `json:"timestamp,omitempty"`
Type string `json:"type,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/breadcrumbs/
TODO: This type could be more useful, as map of interface{} is too generic and requires a lot of type assertions in beforeBreadcrumb calls plus it could just be `map[string]interface{}` then
Client is the underlying processor that's used by the main API and `Hub` instances.
func NewClient(options ClientOptions) (*Client, error)
NewClient creates and returns an instance of `Client` configured using `ClientOptions`.
func (client *Client) AddEventProcessor(processor EventProcessor)
AddEventProcessor adds an event processor to the client.
CaptureEvent captures an event on the currently active client if any.
The event must already be assembled. Typically code would instead use the utility methods like `CaptureException`. The return value is the event ID. In case Sentry is disabled or event was dropped, the return value will be nil.
func (client *Client) CaptureException(exception error, hint *EventHint, scope EventModifier) *EventID
CaptureException captures an error.
func (client *Client) CaptureMessage(message string, hint *EventHint, scope EventModifier) *EventID
CaptureMessage captures an arbitrary message.
Flush notifies when all the buffered events have been sent by returning `true` or `false` if timeout was reached. It calls `Flush` method of the configured `Transport`.
func (client Client) Options() ClientOptions
Options return `ClientOptions` for the current `Client`.
func (client *Client) Recover(err interface{}, hint *EventHint, scope EventModifier) *EventID
Recover captures a panic. Returns `EventID` if successfully, or `nil` if there's no error to recover from.
func (client *Client) RecoverWithContext( ctx context.Context, err interface{}, hint *EventHint, scope EventModifier, ) *EventID
Recover captures a panic and passes relevant context object. Returns `EventID` if successfully, or `nil` if there's no error to recover from.
type ClientOptions struct {
// The DSN to use. If the DSN is not set, the client is effectively disabled.
Dsn string
// In debug mode, the debug information is printed to stdout to help you understand what
// sentry is doing.
Debug bool
// Configures whether SDK should generate and attach stacktraces to pure capture message calls.
AttachStacktrace bool
// The sample rate for event submission (0.0 - 1.0, defaults to 1.0).
SampleRate float64
// List of regexp strings that will be used to match against event's message
// and if applicable, caught errors type and value.
// If the match is found, then a whole event will be dropped.
IgnoreErrors []string
// Before send callback.
BeforeSend func(event *Event, hint *EventHint) *Event
// Before breadcrumb add callback.
BeforeBreadcrumb func(breadcrumb *Breadcrumb, hint *BreadcrumbHint) *Breadcrumb
// Integrations to be installed on the current Client, receives default integrations
Integrations func([]Integration) []Integration
// io.Writer implementation that should be used with the `Debug` mode
DebugWriter io.Writer
// The transport to use.
// This is an instance of a struct implementing `Transport` interface.
// Defaults to `httpTransport` from `transport.go`
Transport Transport
// The server name to be reported.
ServerName string
// The release to be sent with events.
Release string
// The dist to be sent with events.
Dist string
// The environment to be sent with events.
Environment string
// Maximum number of breadcrumbs.
MaxBreadcrumbs int
// An optional pointer to `http.Client` that will be used with a default HTTPTransport.
// Using your own client will make HTTPTransport, HTTPProxy, HTTPSProxy and CaCerts options ignored.
HTTPClient *http.Client
// An optional pointer to `http.Transport` that will be used with a default HTTPTransport.
// Using your own transport will make HTTPProxy, HTTPSProxy and CaCerts options ignored.
HTTPTransport *http.Transport
// An optional HTTP proxy to use.
// This will default to the `http_proxy` environment variable.
// or `https_proxy` if that one exists.
HTTPProxy string
// An optional HTTPS proxy to use.
// This will default to the `HTTPS_PROXY` environment variable
// or `http_proxy` if that one exists.
HTTPSProxy string
// An optional CaCerts to use.
// Defaults to `gocertifi.CACerts()`.
CaCerts *x509.CertPool
}ClientOptions that configures a SDK Client
type Dsn struct {
// contains filtered or unexported fields
}Dsn is used as the remote address source to client transport.
NewDsn creates an instance of `Dsn` by parsing provided url in a `string` format. If Dsn is not set the client is effectively disabled.
RequestHeaders returns all the necessary headers that have to be used in the transport.
StoreAPIURL returns assembled url to be used in the transport. It points to configures Sentry instance.
String formats Dsn struct into a valid string url
func (e DsnParseError) Error() string
type Event struct {
Breadcrumbs []*Breadcrumb `json:"breadcrumbs,omitempty"`
Contexts map[string]interface{} `json:"contexts,omitempty"`
Dist string `json:"dist,omitempty"`
Environment string `json:"environment,omitempty"`
EventID EventID `json:"event_id,omitempty"`
Extra map[string]interface{} `json:"extra,omitempty"`
Fingerprint []string `json:"fingerprint,omitempty"`
Level Level `json:"level,omitempty"`
Message string `json:"message,omitempty"`
Platform string `json:"platform,omitempty"`
Release string `json:"release,omitempty"`
Sdk SdkInfo `json:"sdk,omitempty"`
ServerName string `json:"server_name,omitempty"`
Threads []Thread `json:"threads,omitempty"`
Tags map[string]string `json:"tags,omitempty"`
Timestamp int64 `json:"timestamp,omitempty"`
Transaction string `json:"transaction,omitempty"`
User User `json:"user,omitempty"`
Logger string `json:"logger,omitempty"`
Modules map[string]string `json:"modules,omitempty"`
Request Request `json:"request,omitempty"`
Exception []Exception `json:"exception,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/
type EventHint struct {
Data interface{}
EventID string
OriginalException error
RecoveredException interface{}
Context context.Context
Request *http.Request
Response *http.Response
}CaptureEvent captures an event on the currently active client if any.
The event must already be assembled. Typically code would instead use the utility methods like `CaptureException`. The return value is the event ID. In case Sentry is disabled or event was dropped, the return value will be nil.
CaptureException captures an error.
CaptureMessage captures an arbitrary message.
LastEventID returns an ID of last captured event.
Recover captures a panic.
Recover captures a panic and passes relevant context object.
type Exception struct {
Type string `json:"type,omitempty"`
Value string `json:"value,omitempty"`
Module string `json:"module,omitempty"`
Stacktrace *Stacktrace `json:"stacktrace,omitempty"`
RawStacktrace *Stacktrace `json:"raw_stacktrace,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/exception/
type Frame struct {
Function string `json:"function,omitempty"`
Symbol string `json:"symbol,omitempty"`
Module string `json:"module,omitempty"`
Package string `json:"package,omitempty"`
Filename string `json:"filename,omitempty"`
AbsPath string `json:"abs_path,omitempty"`
Lineno int `json:"lineno,omitempty"`
Colno int `json:"colno,omitempty"`
PreContext []string `json:"pre_context,omitempty"`
ContextLine string `json:"context_line,omitempty"`
PostContext []string `json:"post_context,omitempty"`
InApp bool `json:"in_app,omitempty"`
Vars map[string]interface{} `json:"vars,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/stacktrace/
NewFrame assembles a stacktrace frame out of `runtime.Frame`.
type HTTPSyncTransport struct {
// HTTP Client request timeout. Defaults to 30 seconds.
Timeout time.Duration
// contains filtered or unexported fields
}HTTPSyncTransport is an implementation of `Transport` interface which blocks after each captured event.
func NewHTTPSyncTransport() *HTTPSyncTransport
NewHTTPSyncTransport returns a new pre-configured instance of HTTPSyncTransport
func (t *HTTPSyncTransport) Configure(options ClientOptions)
Configure is called by the `Client` itself, providing it it's own `ClientOptions`.
func (t *HTTPSyncTransport) Flush(_ time.Duration) bool
Flush notifies when all the buffered events have been sent by returning `true` or `false` if timeout was reached. No-op for HTTPSyncTransport.
func (t *HTTPSyncTransport) SendEvent(event *Event)
SendEvent assembles a new packet out of `Event` and sends it to remote server.
type HTTPTransport struct {
// Size of the transport buffer. Defaults to 30.
BufferSize int
// HTTP Client request timeout. Defaults to 30 seconds.
Timeout time.Duration
// contains filtered or unexported fields
}HTTPTransport is a default implementation of `Transport` interface used by `Client`.
func NewHTTPTransport() *HTTPTransport
NewHTTPTransport returns a new pre-configured instance of HTTPTransport
func (t *HTTPTransport) Configure(options ClientOptions)
Configure is called by the `Client` itself, providing it it's own `ClientOptions`.
func (t *HTTPTransport) Flush(timeout time.Duration) bool
Flush notifies when all the buffered events have been sent by returning `true` or `false` if timeout was reached.
func (t *HTTPTransport) SendEvent(event *Event)
SendEvent assembles a new packet out of `Event` and sends it to remote server.
type Hub struct {
// contains filtered or unexported fields
}Hub is the central object that can manages scopes and clients.
This can be used to capture events and manage the scope. The default hub that is available automatically.
In most situations developers do not need to interface the hub. Instead toplevel convenience functions are exposed that will automatically dispatch to global (`CurrentHub`) hub. In some situations this might not be possible in which case it might become necessary to manually work with the hub. This is for instance the case when working with async code.
CurrentHub returns an instance of previously initialized `Hub` stored in the global namespace.
GetHubFromContext tries to retrieve `Hub` instance from the given `Context` struct or return `nil` if one is not found.
NewHub returns an instance of a `Hub` with provided `Client` and `Scope` bound.
func (hub *Hub) AddBreadcrumb(breadcrumb *Breadcrumb, hint *BreadcrumbHint)
AddBreadcrumb records a new breadcrumb.
The total number of breadcrumbs that can be recorded are limited by the configuration on the client.
BindClient binds a new `Client` for the current `Hub`.
CaptureEvent calls the method of a same name on currently bound `Client` instance passing it a top-level `Scope`. Returns `EventID` if successfully, or `nil` if there's no `Scope` or `Client` available.
CaptureException calls the method of a same name on currently bound `Client` instance passing it a top-level `Scope`. Returns `EventID` if successfully, or `nil` if there's no `Scope` or `Client` available.
CaptureMessage calls the method of a same name on currently bound `Client` instance passing it a top-level `Scope`. Returns `EventID` if successfully, or `nil` if there's no `Scope` or `Client` available.
Scope returns top-level `Client` of the current `Hub` or `nil` if no `Client` is bound.
Clone returns a copy of the current Hub with top-most scope and client copied over.
ConfigureScope invokes a function that can modify the current scope.
The function is passed a mutable reference to the `Scope` so that modifications can be performed.
Flush calls the method of a same name on currently bound `Client` instance.
LastEventID returns an ID of last captured event for the current `Hub`.
PushScope pops the most recent scope for the current `Hub`.
PushScope pushes a new scope for the current `Hub` and reuses previously bound `Client`.
Recover calls the method of a same name on currently bound `Client` instance passing it a top-level `Scope`. Returns `EventID` if successfully, or `nil` if there's no `Scope` or `Client` available.
RecoverWithContext calls the method of a same name on currently bound `Client` instance passing it a top-level `Scope`. Returns `EventID` if successfully, or `nil` if there's no `Scope` or `Client` available.
Scope returns top-level `Scope` of the current `Hub` or `nil` if no `Scope` is bound.
WithScope temporarily pushes a scope for a single call.
A shorthand for: PushScope() f(scope) PopScope()
Integration allows for registering a functions that modify or discard captured events.
Level marks the severity of the event
const (
LevelDebug Level = "debug"
LevelInfo Level = "info"
LevelWarning Level = "warning"
LevelError Level = "error"
LevelFatal Level = "fatal"
)type Request struct {
URL string `json:"url,omitempty"`
Method string `json:"method,omitempty"`
Data string `json:"data,omitempty"`
QueryString string `json:"query_string,omitempty"`
Cookies string `json:"cookies,omitempty"`
Headers map[string]string `json:"headers,omitempty"`
Env map[string]string `json:"env,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/request/
type Scope struct {
// contains filtered or unexported fields
}Scope holds contextual data for the current scope.
The scope is an object that can cloned efficiently and stores data that is locally relevant to an event. For instance the scope will hold recorded breadcrumbs and similar information.
The scope can be interacted with in two ways:
1. the scope is routinely updated with information by functions such as
`AddBreadcrumb` which will modify the currently top-most scope.
2. the topmost scope can also be configured through the `ConfigureScope`
method.
Note that the scope can only be modified but not inspected. Only the client can use the scope to extract information currently.
func (scope *Scope) AddBreadcrumb(breadcrumb *Breadcrumb, limit int)
AddBreadcrumb adds new breadcrumb to the current scope and optionally throws the old one if limit is reached.
func (scope *Scope) AddEventProcessor(processor EventProcessor)
AddEventProcessor adds an event processor to the current scope.
ApplyToEvent takes the data from the current scope and attaches it to the event.
Clear removes the data from the current scope. Not safe for concurrent use.
ClearBreadcrumbs clears all breadcrumbs from the current scope.
Clone returns a copy of the current scope with all data copied over.
RemoveContext removes a context from the current scope.
RemoveExtra removes a extra from the current scope.
RemoveTag removes a tag from the current scope.
SetContext adds a context to the current scope.
SetContexts assigns multiple contexts to the current scope.
SetExtra adds an extra to the current scope.
SetExtras assigns multiple extras to the current scope.
SetFingerprint sets new fingerprint for the current scope.
SetLevel sets new level for the current scope.
SetRequest sets new request for the current scope.
SetTag adds a tag to the current scope.
SetTags assigns multiple tags to the current scope.
SetTransaction sets new transaction name for the current transaction.
SetUser sets new user for the current scope.
type SdkInfo struct {
Name string `json:"name,omitempty"`
Version string `json:"version,omitempty"`
Integrations []string `json:"integrations,omitempty"`
Packages []SdkPackage `json:"packages,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/sdk/
type SdkPackage struct {
Name string `json:"name,omitempty"`
Version string `json:"version,omitempty"`
}type Stacktrace struct {
Frames []Frame `json:"frames,omitempty"`
FramesOmitted []uint `json:"frames_omitted,omitempty"`
}Stacktrace holds information about the frames of the stack.
func ExtractStacktrace(err error) *Stacktrace
ExtractStacktrace creates a new `Stacktrace` based on the given `error` object. TODO: Make it configurable so that anyone can provide their own implementation? Use of reflection allows us to not have a hard dependency on any given package, so we don't have to import it
func NewStacktrace() *Stacktrace
NewStacktrace creates a stacktrace using `runtime.Callers`.
type Thread struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Stacktrace *Stacktrace `json:"stacktrace,omitempty"`
RawStacktrace *Stacktrace `json:"raw_stacktrace,omitempty"`
Crashed bool `json:"crashed,omitempty"`
Current bool `json:"current,omitempty"`
}type Transport interface {
Flush(timeout time.Duration) bool
Configure(options ClientOptions)
SendEvent(event *Event)
}Transport is used by the `Client` to deliver events to remote server.
type User struct {
Email string `json:"email,omitempty"`
ID string `json:"id,omitempty"`
IPAddress string `json:"ip_address,omitempty"`
Username string `json:"username,omitempty"`
}https://docs.sentry.io/development/sdk-dev/event-payloads/user/
| Path | Synopsis |
|---|---|
| echo | |
| fasthttp | |
| gin | |
| http | |
| iris | |
| martini | |
| negroni |
Package sentry imports 27 packages (graph) and is imported by 54 packages. Updated 2019-12-13. Refresh now. Tools for package owners.