Merge pull request #16 from snabble/add-stacktraces-to-log-entries

Add common stacktrace support for go-logging. Needs pretty printing.

Author: AndreasKl

go.mod

@@ -1,11 +1,18 @@
 module github.com/snabble/go-logging/v2
 
-go 1.14
+go 1.17
 
 require (
-	github.com/jinzhu/now v1.1.2 // indirect
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.3.0
-	golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
 	gorm.io/gorm v1.21.4
 )
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d // indirect
+)

go.sum

@@ -17,5 +17,7 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d h1:jbzgAvDZn8aEnytae+4ou0J0GwFZoHR0hOrTg4qH8GA=
 golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gorm.io/gorm v1.21.4 h1:J0xfPJMRfHgpVcYLrEAIqY/apdvTIkrltPQNHQLq9Qc=
 gorm.io/gorm v1.21.4/go.mod h1:0HFTzE/SqkGTzK6TlDPPQbAYCluiVvhzoA1+aVyzenw=

logger.go

@@ -2,6 +2,7 @@ package logging
 
 import (
 	"context"
+	"fmt"
 	"time"
 
 	"github.com/sirupsen/logrus"
@@ -75,7 +76,12 @@ func NewEntry(logger *Logger) *Entry {
 }
 
 func (entry *Entry) WithError(err error) *Entry {
-	return entry.WithField(logrus.ErrorKey, err)
+	withError := entry.WithField(logrus.ErrorKey, err)
+	stacktrace := ExtractStacktrace(err)
+	if stacktrace != nil {
+		 return withError.WithField("stacktrace", fmt.Sprintf("%+v", stacktrace))
+	}
+	return withError
 }
 
 func (entry *Entry) WithContext(ctx context.Context) *Entry {

logger_test.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
+	"golang.org/x/xerrors"
 )
 
 type logReccord struct {
@@ -51,6 +52,25 @@ func Test_Logger_Set(t *testing.T) {
 	a.Regexp(`^time.* level\=error msg\=oops foo\=bar.*`, b.String())
 }
 
+func Test_Logger_WithError(t *testing.T) {
+	a := assert.New(t)
+
+	// given: an logger in text format
+	Set("info", true)
+	defer Set("info", false)
+	Log.Formatter.(*logrus.TextFormatter).DisableColors = true
+	b := bytes.NewBuffer(nil)
+	Log.Out = b
+
+	err := func() error {
+		return xerrors.Errorf("found an error: %w", errors.New("an error occurred"))
+	}()
+	Log.WithError(err).Error("oops")
+
+	print( b.String())
+	a.Regexp(`^time.* level\=error msg\=oops error\="found an error: an error occurred" stacktrace\=".*"`, b.String())
+}
+
 func Test_Logger_Call(t *testing.T) {
 	a := assert.New(t)