awsxrayexporter - OTel Go SDK stacktrace translation support (#4670)

* go stack trace translation support - awsxrayexporter

* added tests

* minor changes

* ran gofmt

* remove unused var

* added condition to check array length

* using regex for string matching

* fix lint error

* fix linter issue

* address CR comments

Author: bhautikpip

exporter/awsxrayexporter/internal/translator/cause.go

@@ -17,6 +17,7 @@ package translator
 import (
 	"bufio"
 	"net/textproto"
+	"regexp"
 	"strconv"
 	"strings"
 
@@ -167,6 +168,8 @@ func parseException(exceptionType string, message string, stacktrace string, lan
 	case "php":
 		// The PHP SDK formats stack traces exactly like Java would
 		exceptions = fillJavaStacktrace(stacktrace, exceptions)
+	case "go":
+		exceptions = fillGoStacktrace(stacktrace, exceptions)
 	}
 
 	return exceptions
@@ -486,6 +489,58 @@ func fillDotnetStacktrace(stacktrace string, exceptions []awsxray.Exception) []a
 	return exceptions
 }
 
+func fillGoStacktrace(stacktrace string, exceptions []awsxray.Exception) []awsxray.Exception {
+	var line string
+	var label string
+	var path string
+	var lineNumber int
+
+	plnre := regexp.MustCompile(`([^:\s]+)\:(\d+)`)
+	re := regexp.MustCompile(`^goroutine.*\brunning\b.*:$`)
+
+	r := textproto.NewReader(bufio.NewReader(strings.NewReader(stacktrace)))
+
+	// Skip first line containing top level exception / message
+	_, _ = r.ReadLine()
+	exception := &exceptions[0]
+	line, err := r.ReadLine()
+	if err != nil {
+		return exceptions
+	}
+
+	exception.Stack = make([]awsxray.StackFrame, 0)
+	for {
+		match := re.Match([]byte(line))
+		if match {
+			line, _ = r.ReadLine()
+		}
+
+		label = line
+		line, _ = r.ReadLine()
+
+		matches := plnre.FindStringSubmatch(line)
+		if len(matches) == 3 {
+			path = matches[1]
+			lineNumber, _ = strconv.Atoi(matches[2])
+		}
+
+		stack := awsxray.StackFrame{
+			Path:  aws.String(path),
+			Label: aws.String(label),
+			Line:  aws.Int(lineNumber),
+		}
+
+		exception.Stack = append(exception.Stack, stack)
+
+		line, err = r.ReadLine()
+		if err != nil {
+			break
+		}
+	}
+
+	return exceptions
+}
+
 // indexOf returns position of the first occurrence of a Byte in str starting at pos index.
 func indexOf(str string, c byte, pos int) int {
 	if pos < 0 {

exporter/awsxrayexporter/internal/translator/cause_test.go

@@ -1014,3 +1014,105 @@ func TestParseExceptionPhpStacktraceMalformedLines(t *testing.T) {
 	assert.Equal(t, "test.php", *exceptions[0].Stack[1].Path)
 	assert.Equal(t, 89, *exceptions[0].Stack[1].Line)
 }
+
+func TestParseExceptionGoWithoutStacktrace(t *testing.T) {
+	exceptionType := "Exception"
+	message := "Thrown from grandparent"
+
+	stacktrace := ""
+
+	exceptions := parseException(exceptionType, message, stacktrace, "go")
+
+	assert.Len(t, exceptions, 1)
+	assert.NotEmpty(t, exceptions[0].ID)
+	assert.Equal(t, "Exception", *exceptions[0].Type)
+	assert.Equal(t, "Thrown from grandparent", *exceptions[0].Message)
+	assert.Nil(t, exceptions[0].Stack)
+}
+
+func TestParseExceptionGoWithStacktrace(t *testing.T) {
+	exceptionType := "Exception"
+	message := "error message"
+
+	stacktrace := `goroutine 19 [running]:
+go.opentelemetry.io/otel/sdk/trace.recordStackTrace(0x0, 0x0)
+	otel-go-core/opentelemetry-go/sdk/trace/span.go:323 +0x9b
+go.opentelemetry.io/otel/sdk/trace.(*span).RecordError(0xc0003a6000, 0x14a5f00, 0xc00038c000, 0xc000390140, 0x3, 0x4)
+	otel-go-core/opentelemetry-go/sdk/trace/span.go:302 +0x3fc
+go.opentelemetry.io/otel/sdk/trace.TestRecordErrorWithStackTrace(0xc000102900)
+	otel-go-core/opentelemetry-go/sdk/trace/trace_test.go:1167 +0x3ef
+testing.tRunner(0xc000102900, 0x1484410)
+	/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go:1193 +0x1a3
+created by testing.(*T).Run
+	/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go:1238 +0x63c`
+
+	exceptions := parseException(exceptionType, message, stacktrace, "go")
+	assert.Len(t, exceptions, 1)
+	assert.NotEmpty(t, exceptions[0].ID)
+	assert.Equal(t, "Exception", *exceptions[0].Type)
+	assert.Equal(t, "error message", *exceptions[0].Message)
+	assert.Len(t, exceptions[0].Stack, 5)
+
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[0].Label, "go.opentelemetry.io/otel/sdk/trace.recordStackTrace"))
+	assert.Equal(t, "otel-go-core/opentelemetry-go/sdk/trace/span.go", *exceptions[0].Stack[0].Path)
+	assert.Equal(t, 323, *exceptions[0].Stack[0].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[1].Label, "go.opentelemetry.io/otel/sdk/trace.(*span).RecordError"))
+	assert.Equal(t, "otel-go-core/opentelemetry-go/sdk/trace/span.go", *exceptions[0].Stack[1].Path)
+	assert.Equal(t, 302, *exceptions[0].Stack[1].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[3].Label, "testing.tRunner"))
+	assert.Equal(t, "/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go", *exceptions[0].Stack[3].Path)
+	assert.Equal(t, 1193, *exceptions[0].Stack[3].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[4].Label, "created by testing.(*T).Run"))
+	assert.Equal(t, "/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go", *exceptions[0].Stack[4].Path)
+	assert.Equal(t, 1238, *exceptions[0].Stack[4].Line)
+}
+
+func TestParseMultipleExceptionGoWithStacktrace(t *testing.T) {
+	exceptionType := "Exception"
+	message := "panic"
+
+	stacktrace := `goroutine 19 [running]:
+go.opentelemetry.io/otel/sdk/trace.recordStackTrace(0x0, 0x0)
+	Documents/otel-go-core/opentelemetry-go/sdk/trace/span.go:318 +0x9b
+go.opentelemetry.io/otel/sdk/trace.(*span).End(0xc000082300, 0xc0000a0040, 0x1, 0x1)
+	Documents/otel-go-core/opentelemetry-go/sdk/trace/span.go:252 +0x4ee
+panic(0x1414f00, 0xc0000a0050)
+	/usr/local/Cellar/go/1.16.3/libexec/src/runtime/panic.go:971 +0x4c7
+go.opentelemetry.io/otel/sdk/trace.TestSpanCapturesPanicWithStackTrace.func1()
+	Documents/otel-go-core/opentelemetry-go/sdk/trace/trace_test.go:1425 +0x225
+github.com/stretchr/testify/assert.didPanic.func1(0xc0001ad0e8, 0xc0001ad0d7, 0xc0001ad0d8, 0xc00009e048)
+	go/pkg/mod/github.com/stretchr/[email protected]/assert/assertions.go:1018 +0xb8
+github.com/stretchr/testify/assert.didPanic(0xc00009e048, 0x14a5b00, 0x0, 0x0, 0x0, 0x0)
+	go/pkg/mod/github.com/stretchr/[email protected]/assert/assertions.go:1020 +0x85
+github.com/stretchr/testify/assert.PanicsWithError(0x14a5b60, 0xc000186600, 0x146e31c, 0xd, 0xc00009e048, 0x0, 0x0, 0x0, 0xc000038900)
+	go/pkg/mod/github.com/stretchr/[email protected]/assert/assertions.go:1071 +0x10c
+goroutine 26 [running]:
+github.com/stretchr/testify/require.PanicsWithError(0x14a7328, 0xc000186600, 0x146e31c, 0xd, 0xc00009e048, 0x0, 0x0, 0x0)
+	go/pkg/mod/github.com/stretchr/[email protected]/require/require.go:1607 +0x15e
+go.opentelemetry.io/otel/sdk/trace.TestSpanCapturesPanicWithStackTrace(0xc000186600)
+	Documents/otel-go-core/opentelemetry-go/sdk/trace/trace_test.go:1427 +0x33a
+testing.tRunner(0xc000186600, 0x1484440)
+	/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go:1193 +0x1a3
+created by testing.(*T).Run
+	/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go:1238 +0x63c`
+
+	exceptions := parseException(exceptionType, message, stacktrace, "go")
+	assert.Len(t, exceptions, 1)
+	assert.NotEmpty(t, exceptions[0].ID)
+	assert.Equal(t, "Exception", *exceptions[0].Type)
+	assert.Equal(t, "panic", *exceptions[0].Message)
+	assert.Len(t, exceptions[0].Stack, 11)
+
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[0].Label, "go.opentelemetry.io/otel/sdk/trace.recordStackTrace"))
+	assert.Equal(t, "Documents/otel-go-core/opentelemetry-go/sdk/trace/span.go", *exceptions[0].Stack[0].Path)
+	assert.Equal(t, 318, *exceptions[0].Stack[0].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[7].Label, "github.com/stretchr/testify/require.PanicsWithError"))
+	assert.Equal(t, "go/pkg/mod/github.com/stretchr/[email protected]/require/require.go", *exceptions[0].Stack[7].Path)
+	assert.Equal(t, 1607, *exceptions[0].Stack[7].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[8].Label, "go.opentelemetry.io/otel/sdk/trace.TestSpanCapturesPanicWithStackTrace"))
+	assert.Equal(t, "Documents/otel-go-core/opentelemetry-go/sdk/trace/trace_test.go", *exceptions[0].Stack[8].Path)
+	assert.Equal(t, 1427, *exceptions[0].Stack[8].Line)
+	assert.True(t, strings.HasPrefix(*exceptions[0].Stack[10].Label, "created by testing.(*T).Run"))
+	assert.Equal(t, "/usr/local/Cellar/go/1.16.3/libexec/src/testing/testing.go", *exceptions[0].Stack[10].Path)
+	assert.Equal(t, 1238, *exceptions[0].Stack[10].Line)
+}