README
¶
roll
roll is a basic Rollbar client for Go that reports errors and logs
messages. It automatically builds stack traces and also supports
arbitrary traces. All errors and messages are sent to Rollbar
synchronously.
roll is intentionally simple. For more advanced functionality, check
out heroku/rollbar.
Notes
- Critical-, Error-, and Warning-level messages include a stack trace.
However, Go's
errortype doesn't include stack information from the location the error was set or allocated. Instead,rolluses the stack information from where the error was reported. - Info- and Debug-level Rollbar messages do not include stack traces.
- When calling
rollaway from where the error actually occurred,roll's stack walking won't represent the actual stack trace at the time the error occurred. The*Stackvariants of Critical, Error, and Warning take a[]uintptr, allowing the stack to be provided, rather than walked.
Running Tests
go test will run tests against a fake server by default.
If the environment variable TOKEN is a Rollbar access token, running
go test will produce errors using an environment named test.
TOKEN=f0df01587b8f76b2c217af34c479f9ea go test
Verify the reported errors manually in the Rollbar dashboard.
Contributors
- @challiwill
- @tysonmote
- @apg
This library was forked from stvp/rollbar, which had contributions from:
- @kjk
- @Soulou
- @paulmach
Documentation
¶
Index ¶
- Variables
- func Critical(err error, custom map[string]string) (uuid string, e error)
- func CriticalStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
- func Debug(msg string, custom map[string]string) (uuid string, e error)
- func Error(err error, custom map[string]string) (uuid string, e error)
- func ErrorStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
- func Info(msg string, custom map[string]string) (uuid string, e error)
- func Warning(err error, custom map[string]string) (uuid string, e error)
- func WarningStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
- type Client
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Endpoint is the default HTTP(S) endpoint that all Rollbar API requests // will be sent to. By default, this is Rollbar's "Items" API endpoint. If // this is blank, no items will be sent to Rollbar. Endpoint = endpoint // Rollbar access token for the global client. If this is blank, no items // will be sent to Rollbar. Token = "" // Environment for all items reported with the global client. Environment = "development" )
Functions ¶
func CriticalStack ¶
func ErrorStack ¶
Types ¶
type Client ¶
type Client interface {
Critical(err error, custom map[string]string) (uuid string, e error)
CriticalStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
Error(err error, custom map[string]string) (uuid string, e error)
ErrorStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
Warning(err error, custom map[string]string) (uuid string, e error)
WarningStack(err error, ptrs []uintptr, custom map[string]string) (uuid string, e error)
Info(msg string, custom map[string]string) (uuid string, e error)
Debug(msg string, custom map[string]string) (uuid string, e error)
}
Client reports items to a single Rollbar project.
Source Files
Click to show internal directories.
Click to hide internal directories.