https://github.com/lob/sentry-echo
Report errors from Echo to Sentry
https://github.com/lob/sentry-echo
Last synced: 3 months ago
JSON representation
Report errors from Echo to Sentry
- Host: GitHub
- URL: https://github.com/lob/sentry-echo
- Owner: lob
- Created: 2018-12-27T23:35:55.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-06T23:34:10.000Z (about 2 years ago)
- Last Synced: 2025-01-19T07:12:16.782Z (5 months ago)
- Language: Go
- Size: 44.9 KB
- Stars: 0
- Watchers: 58
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sentry-echo
`sentry-echo` provides a thin wrapper around the [raven-go](https://github.com/getsentry/raven-go) Sentry client, along with an Echo [error handler](https://echo.labstack.com/guide/error-handling) which reports internal server errors to Sentry.
## Installation
```
$ go get github.com/lob/sentry-echo/...
```
## Usage
To create a new Sentry client you must provide the DSN along with an `environment`; the environment will be included as a tag with all reports.
```go
import github.com/lob/sentry-echo/pkg/client
...
sentryClient, err := client.New(dsn)
```
If the client is unable to be created, an error will be returned.
After you've created a client you can register it as the error handler for your Echo application.
```go
import (
github.com/lob/sentry-echo/pkg/client
github.com/lob/sentry-echo/pkg/sentry
)
var e echo.Echo
...
sentryClient, _ := client.New(dsn)
sentry.RegisterErrorHandler(e, sentryClient)
```
## Reporting Errors to Sentry
The Sentry client may also be used to report events to Sentry other than internal server errors.
```go
sentryClient.Report(someError, nil)
```
If an `*http.Request` is available, it may be passed as the second parameter. If passed, Raven will extract the HTTP context from the request and include it with the Sentry report.
## Payload Sanitizing
The error handler and Sentry client will sanitize fields in request payloads, replacing them with `[CENSORED]`. Cookies often contain session tokens; as such the Cookies are **always** censored. The client can also censor query string fields and sensitive headers.
To specify query string fields to be censored, specify them when creating the Sentry client.
For example, to filter `signature` and `credit_card`, create the client as follows:
```go,
client, err := client.NewWithOptions(
client.Options{
DSN: dsn,
FilteredFields: []string{
"signature",
"credit_card",
},
},
)
```
If the client is created via `client.New()`, the `Authorization` header will be censored. An alternative list of headers to censor may be provided as part of the `client.Options`.