https://github.com/airbrake/gobrake
Airbrake notifier for Golang
https://github.com/airbrake/gobrake
airbrake error-reporting go golang notifier
Last synced: 12 months ago
JSON representation
Airbrake notifier for Golang
- Host: GitHub
- URL: https://github.com/airbrake/gobrake
- Owner: airbrake
- License: mit
- Created: 2012-09-19T15:19:50.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T02:24:19.000Z (about 1 year ago)
- Last Synced: 2025-05-14T02:14:14.344Z (12 months ago)
- Topics: airbrake, error-reporting, go, golang, notifier
- Language: Go
- Homepage: https://docs.airbrake.io/docs/platforms/go-lang
- Size: 1.01 MB
- Stars: 105
- Watchers: 23
- Forks: 40
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Gobrake
[](https://github.com/airbrake/gobrake/actions/workflows/test.yml)
[][docs]
* [Gobrake official documentation][docs-official]
* [pkg.go.dev documentation][docs]
## Introduction
_Gobrake_ is the official notifier package for [Airbrake][airbrake.io] for the
Go programming language. Gobrake provides a minimalist API that enables the
ability to send _any_ Go error or panic to the Airbrake dashboard. The library
is extremely lightweight, with minimal overhead.
## Key features
* Simple, consistent and easy-to-use library API
* Asynchronous exception reporting
* Flexible configuration options
* Support for environments
* Add extra context to errors before reporting them
* Filters support (filter out sensitive or unwanted data that shouldn't be sent)
* Ignore errors based on class, message, status, file, or any other filter
* SSL support (all communication with Airbrake is encrypted by default)
* Notify Airbrake on panics
* Set error severity to control notification thresholds
* Support for code hunks (lines of code surrounding each backtrace frame)
* Automatic deploy tracking
* Performance monitoring features such as HTTP route statistics, SQL queries,
and Job execution statistics
* Integrations with [Beego][beego], [Buffalo][buffalo], [Echo][echo], [fasthttp][fasthttp], [Fiber][fiber],
[Gin][gin], [gorilla/mux][gorilla], [Iris][iris], [Negroni][negroni] and [net/http][nethttp]
* Last but not least, we follow [semantic versioning 2.0.0][semver2]
## Installation
When using Go Modules, you do not need to install anything to start using Airbrake with your Go application. Import the package and the go tool will automatically download the latest version of the package when you next build your program.
```go
import (
"github.com/airbrake/gobrake/v5"
)
```
With or without Go Modules, to use the latest version of the package, run:
```sh
go get github.com/airbrake/gobrake/v5
```
### Installing in a new project
Create a new directory, initialize a new module and `go get` the library:
```sh
mkdir airbrake_example && cd airbrake_example
go mod init airbrake_example
go get github.com/airbrake/gobrake/v5
```
## Example
This is the minimal example that you can use to test Gobrake with your project.
```go
package main
import (
"errors"
"github.com/airbrake/gobrake/v5"
)
var airbrake = gobrake.NewNotifierWithOptions(&gobrake.NotifierOptions{
ProjectId: , // <-- Fill in this value
ProjectKey: "", // <-- Fill in this value
Environment: "production",
})
func main() {
defer airbrake.Close()
airbrake.Notify(errors.New("operation failed"), nil)
}
```
### ProjectId & ProjectKey
You **must** set both `ProjectId` & `ProjectKey`.
To find your `ProjectId` (`int64`) and `ProjectKey` (`string`) navigate to your
project's _Settings_ and copy the values from the right sidebar.
![id-key][project-idkey]
## Getting Started
To check the complete Guide, visit our official [docs][docs-official].
## API
For complete API description please follow documentation on [pkg.go.dev
documentation][docs].
> **Note**: Gobrake provides middleware out of
the box and you may find our example apps more helpful:
* [Beego](examples/beego)
* [Buffalo](examples/buffalo)
* [Echo](examples/echo)
* [fasthttp](examples/fasthttp)
* [Fiber](examples/fiber)
* [Gin](examples/gin)
* [gorilla/mux](examples/gorilla)
* [Iris](examples/iris)
* [Negroni](examples/negroni)
* [net/http](examples/http)
## Additional notes
### Exception limit
The maximum size of an exception is 64KB. Exceptions that exceed this limit
will be truncated to fit the size.
### Logging
We support major logging frameworks:
* There's a [glog fork][glog], which integrates with Gobrake. It provides all of
original glog's functionality and adds the ability to send errors/logs to
[Airbrake.io][airbrake.io].
* [apex/log][apexlog], to check how to integrate gobrake with apex/log, see [example](examples/apexlog).
* [zerolog][zerolog], to check how to integrate gobrake with zerolog, see [example](examples/zerolog).
* [zap][zap], to check how to integrate gobrake with zap, see [example](examples/zap).
## Supported Go versions
The library supports Go v1.17+. The CI file would be the best source of truth
because it contains all Go versions that we test against.
## Contact
In case you have a problem, question or a bug report, feel free to:
* [file an issue][issues]
* [send us an email](mailto:support@airbrake.io)
* [tweet at us][twitter]
* chat with us (visit [airbrake.io][airbrake.io] and click on the round orange
button in the bottom right corner)
## License
The project uses the MIT License. See [LICENSE.md](https://github.com/airbrake/gobrake/blob/master/LICENSE.md) for details.
[airbrake.io]: https://airbrake.io
[docs-official]: https://docs.airbrake.io/docs/platforms/go-lang/
[docs]: https://pkg.go.dev/github.com/airbrake/gobrake/v5
[beego]: https://github.com/beego/beego
[buffalo]: https://github.com/gobuffalo/buffalo
[echo]: https://github.com/labstack/echo
[fasthttp]: https://github.com/valyala/fasthttp
[fiber]: https://github.com/gofiber/fiber
[gin]: https://github.com/gin-gonic/gin
[gorilla]: https://github.com/gorilla/mux
[iris]: https://github.com/kataras/iris
[negroni]: https://github.com/urfave/negroni
[nethttp]: https://pkg.go.dev/net/http
[semver2]: http://semver.org/spec/v2.0.0.html
[project-idkey]: https://s3.amazonaws.com/airbrake-github-assets/gobrake/project-id-key.png
[issues]: https://github.com/airbrake/gobrake/issues
[twitter]: https://twitter.com/airbrake
[glog]: https://github.com/airbrake/glog
[apexlog]: https://github.com/apex/log
[zerolog]: https://github.com/rs/zerolog
[zap]: https://github.com/uber-go/zap