Yeller notifier for Golang.
In your program initialization:
func main() {
// Start yeller in a specific deployment environment
yeller.StartEnv("YOUR_API_KEY", "staging")
// Alternatively, default to "production" environment
// yeller.Start("YOUR_API_KEY")
}When handling errors that you'd like to log to Yeller:
file, err := os.Open("filename.ext")
if err != nil {
// Notify the error by itself, with additional information
// about what was going on when the error happened.
info := make(map[string]interface{})
info["filename"] = "filename.ext"
yeller.NotifyInfo(err, info)
// Alternatively, notify the error by itself, with no additional information.
// yeller.Notify(err)
}Generally you should log your errors to Yeller at the highest possible level that still has good context information about what happened.
If you're inside an http handler, Yeller can log request information as well:
http.HandleFunc("/foo", func(w http.ResponseWriter, req *http.Request) {
file, err := os.Open("filename.ext")
if err != nil {
// Log an error to yeller with HTTP request information
// in addition to information pertinent to the error.
info := make(map[string]interface{})
info["filename"] = "filename.ext"
yeller.NotifyHTTPInfo(err, request, info)
// Alternatively, just log information about the HTTP request.
yeller.NotifyHTTP(err, request)
}
})Most golang programs never use panic intentionally, but it is essential to know
when your program panics. Yeller handles that for you, deduplicating panics so
even if you have thousands of crashes, you'll be able to distinguish between
causes.
func f() {
myFunctionThatPanics()
defer func() {
if r := recover(); r != nil {
yeller.NotifyPanic(r)
}
}()
}If you have any questions, feel free to shoot me an email, tcrayford@yellerapp.com.
Think you've found a bug? Sorry about that. Please open an issue on Github, or email me at tcrayford@yellerapp.com and I'll check it out as soon as possible.