add in zerolog integration

Author: tleffew

README.md

@@ -136,6 +136,7 @@ We support two major logging frameworks:
 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/log][zerolog], to check how to integrate gobrake with zerolog/log, see [example](examples/zerolog).
 
 ## Supported Go versions
 
@@ -177,3 +178,4 @@ The project uses the MIT License. See [LICENSE.md](https://github.com/airbrake/g
 [twitter]: https://twitter.com/airbrake
 [glog]: https://github.com/airbrake/glog
 [apexlog]: https://github.com/apex/log
+[zerolog]: https://github.com/rs/zerolog

examples/zerolog/main.go

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/airbrake/gobrake/v5"
+	airbrakeWriter "github.com/airbrake/gobrake/v5/zerolog"
+	"github.com/rs/zerolog"
+)
+
+var ProjectId int64 = 999999                               // Insert your Project Id here
+var ProjectKey string = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" // Insert your Project Key here
+
+func main() {
+	airbrake := gobrake.NewNotifierWithOptions(&gobrake.NotifierOptions{
+		ProjectId:   ProjectId,
+		ProjectKey:  ProjectKey,
+		Environment: "production",
+	})
+
+	defer airbrake.Close()
+
+	// Note: This writer only accepts errors, fatal and panic logs, all others will be ignored.
+	// You can still send logs to stdout or another writer via io.MultiWriter
+	w := airbrakeWriter.New(airbrake)
+
+	// Insert the newly created airbrakeWriter into zerolog
+	log := zerolog.New(io.MultiWriter(os.Stdout, w))
+	zerolog.SetGlobalLevel(zerolog.DebugLevel)
+
+	// Creates a sub logger that has additional ctx
+	loggerWithData := log.With().
+		Dict("ctx",
+			zerolog.Dict().
+				Str("BUILD", "gitsha").
+				Str("VERSION", "").
+				Str("TIME", ""),
+		).
+		Str("file", "something.png").
+		Str("type", "image/png").
+		Str("user", "tobi").
+		Logger()
+
+	fmt.Printf("Check your Airbrake dashboard at https://airbrake.io/projects/%v to see these log messages\n", ProjectId)
+
+	loggerWithData.Info().Msg("upload")       // will `not` be sent to airbrake but sent to stdout
+	loggerWithData.Warn().Msg("upload retry") // will `not` be sent to airbrake but sent to stdout
+	// This error will be sent both to stdout and to airbrake via the MultiWriter pipeline
+	loggerWithData.Error().Err(errors.New("unauthorized")).Msg("upload failed") // will `be` sent to airbrake & stdout
+}

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/ajg/form v1.5.1 // indirect
 	github.com/apex/log v1.9.0
 	github.com/beego/beego/v2 v2.0.2
+	github.com/buger/jsonparser v1.1.1
 	github.com/caio/go-tdigest v3.1.0+incompatible
 	github.com/gin-gonic/gin v1.7.7
 	github.com/gobuffalo/buffalo v0.18.5
@@ -21,6 +22,7 @@ require (
 	github.com/onsi/ginkgo v1.16.5
 	github.com/onsi/gomega v1.19.0
 	github.com/pkg/errors v0.9.1
+	github.com/rs/zerolog v1.15.0
 	github.com/smartystreets/goconvey v1.7.2 // indirect
 	github.com/urfave/negroni v1.0.0
 	github.com/valyala/fasthttp v1.35.0

go.sum

@@ -103,6 +103,8 @@ github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6r
 github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
 github.com/bketelsen/crypt v0.0.4/go.mod h1:aI6NrJ0pMGgvZKL1iVgXLnfIFJtfV+bKCoqOes/6LfM=
 github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA=
+github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
+github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/caio/go-tdigest v3.1.0+incompatible h1:uoVMJ3Q5lXmVLCCqaMGHLBWnbGoN6Lpu7OAUPR60cds=
 github.com/caio/go-tdigest v3.1.0+incompatible/go.mod h1:sHQM/ubZStBUmF1WbB8FAm8q9GjDajLC5T7ydxE3JHI=
 github.com/casbin/casbin v1.9.1/go.mod h1:z8uPsfBJGUsnkagrt3G8QvjgTKFMBJ32UP8HpZllfog=
@@ -706,6 +708,7 @@ github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUA
 github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
 github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ=
 github.com/rs/zerolog v1.13.0/go.mod h1:YbFCdg8HfsridGWAh22vktObvhZbQsZXe4/zB0OKkWU=
+github.com/rs/zerolog v1.15.0 h1:uPRuwkWF4J6fGsJ2R0Gn2jB1EQiav9k3S6CSdygQJXY=
 github.com/rs/zerolog v1.15.0/go.mod h1:xYTKnLHcpfU2225ny5qZjxnj9NvkumZYjJHlAThCjNc=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=

zerolog/zerolog.go

@@ -0,0 +1,70 @@
+package zerolog
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+
+	"github.com/airbrake/gobrake/v5"
+	"github.com/buger/jsonparser"
+	"github.com/rs/zerolog"
+)
+
+type Writer struct {
+	Gobrake *gobrake.Notifier
+}
+
+// New creates a new Writer
+func New(notifier *gobrake.Notifier) *Writer {
+	return &Writer{Gobrake: notifier}
+}
+
+// Write
+func (w *Writer) Write(data []byte) (int, error) {
+	lvlStr, err := jsonparser.GetUnsafeString(data, zerolog.LevelFieldName)
+	if err != nil {
+		return 0, fmt.Errorf("error getting zerolog level: %w", err)
+	}
+
+	lvl, err := zerolog.ParseLevel(lvlStr)
+	if err != nil {
+		return 0, fmt.Errorf("error parsing zerolog level: %w", err)
+	}
+
+	if lvl < zerolog.ErrorLevel || lvl > zerolog.PanicLevel {
+		return len(data), nil
+	}
+
+	var userData interface{}
+	err = json.Unmarshal(data, &userData)
+	if err != nil {
+		return 0, fmt.Errorf("error unmarshalling logs: %w", err)
+	}
+	type zeroError struct {
+		message string
+		error   string
+	}
+	var ze zeroError
+	_ = jsonparser.ObjectEach(data, func(key, value []byte, vt jsonparser.ValueType, offset int) error {
+		switch string(key) {
+		case zerolog.MessageFieldName:
+			ze.message = string(value)
+		case zerolog.ErrorFieldName:
+			ze.error = string(value)
+		}
+
+		return nil
+	})
+
+	notice := gobrake.NewNotice(ze.message, nil, 6)
+	notice.Context["severity"] = string(lvl)
+	notice.Params["userData"] = userData
+	notice.Error = errors.New(ze.error)
+	w.Gobrake.SendNoticeAsync(notice)
+	return len(data), nil
+}
+
+func (w *Writer) Close() error {
+	w.Gobrake.Flush()
+	return nil
+}