README
¶
Golang logging integration with Sentry
Package slog implements way to log to Sentry along with such a logging libraries as standard package log and go-logging. Also it provides a way to catch Golang panics with a special watchdog process. For logging to Sentry raven-go library is used.
Installation
go get github.com/muravjov/slog
Usage
dsn := "https://aaa:bbb@app.getsentry.com/nnn"
slog.MustSetDSNAndHandler(dsn)
// log package support
slog.HookStandardLog()
// to capture panics
watcher.StartWatcher(dsn, "")
// you cannot survive that, see
// https://github.com/golang/go/issues/20161
go func() {
i := 0
i = 1 / i
}()
After that code you receive an error into Sentry like that:
Post-mortem [/usr/sbin/cdn-mapi], pid=1: panic: runtime error: integer divide by zero
goroutine 30488 [running]:
slog.UncontrolledCrash.func1()
/slog.go:36 +0x11
created by slog.UncontrolledCrash
/slog.go:37 +0x35
Oneshot for simple logging
If you need to log errors to a local file log and to Sentry and you use package log for logging, e.g. in a simple utility, then take a look at this handy API:
slog.SetupLog(logPath, sentryDsn)
If you use go-logging:
slog.SetupGoLogging(logPath, sentryDsn, true)
If you use logrus:
slog.SetupLogrus(logPath, sentryDsn)
API documentation
https://godoc.org/github.com/muravjov/slog/sentry
https://godoc.org/github.com/muravjov/slog/watcher
sentry_prober
sentry_prober is utility to test/troubleshoot Sentry logging:
$ sentry_prober --help
Usage of ./sentry_prober:
--message string message to send (default "sentry-prober")
--random add random string to message
--transport string transport to use (not for --watcher): default|raven-go|slog|curl-print|curl-execute (default "default")
--warning warning (without stacktrace) vs error
--watcher send message via watcher
$ sentry_prober --transport curl-execute --warning https://user:password@sentry.io/ID
Sending "sentry-prober"...
curl -X POST -H 'X-Sentry-Auth: Sentry sentry_version=4, sentry_key=key, sentry_secret=key' -H 'User-Agent: slog/1.0' -H 'Content-Type: application/json' https://sentry.io/api/ID/store/ --data-binary \{\"message\":\"sentry-prober\"}
{"id":"uuid"}Event ID: uuid
Documentation
¶
Index ¶
- func AddForceErrorOption() *string
- func ForceException()
- func OpenLogOrNil(logPath string) io.Writer
- func RunForceErrorOption(forceError string, errorFunc func(string))
- func SetupGoLogging(logPath string, dsn string, andStandardLog bool)
- func SetupLog(logPath string, dsn string)
- func SetupLogrus(logPath string, dsn string)
- func UncontrolledCrash()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddForceErrorOption ¶
func AddForceErrorOption() *string
func ForceException ¶
func ForceException()
func OpenLogOrNil ¶
func RunForceErrorOption ¶
func SetupGoLogging ¶
andStandardLog - hook https://golang.org/pkg/log calls also
func SetupLogrus ¶
func UncontrolledCrash ¶
func UncontrolledCrash()
go program may neither avoid crash from this, nor manage it - the panic mandatory goes to stderr + os.exit(2) see https://github.com/golang/go/issues/20161
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package sentry implements sending errors and messages to Sentry with proper aggregation.
|
Package sentry implements sending errors and messages to Sentry with proper aggregation. |
|
Package watcher implements StartWatcher() function to catch Golang panics with a special watchdog process.
|
Package watcher implements StartWatcher() function to catch Golang panics with a special watchdog process. |