contrib/gin-gonic/gin: rename errorPropagation to useGinErrors

Author: theo303

contrib/gin-gonic/gin/gintrace.go

@@ -55,12 +55,9 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
 		span, ctx, finishSpans := httptrace.StartRequestSpan(c.Request, opts...)
 		defer func() {
 			status := c.Writer.Status()
-			if cfg.propagateError && cfg.isStatusError(status) {
-				var err error
-				for _, e := range c.Errors {
-					err = errors.Join(err, e.Err)
-				}
-				finishSpans(status, cfg.isStatusError, tracer.WithError(err))
+			errMsg := c.Errors.String()
+			if errMsg != "" && cfg.useGinErrors && cfg.isStatusError(status) {
+				finishSpans(status, cfg.isStatusError, tracer.WithError(errors.New(errMsg)))
 			}
 			finishSpans(status, cfg.isStatusError)
 		}()

contrib/gin-gonic/gin/gintrace_test.go

@@ -185,7 +185,7 @@ func TestError(t *testing.T) {
 		defer mt.Reset()
 
 		router := gin.New()
-		router.Use(Middleware("foobar", WithErrorPropagation()))
+		router.Use(Middleware("foobar", WithUseGinErrors()))
 
 		// configure a handler that returns an error and 5xx status code
 		router.GET("/server_err", func(c *gin.Context) {
@@ -210,7 +210,7 @@ func TestError(t *testing.T) {
 		assert.Equal("500", span.Tag(ext.HTTPCode))
 		assert.Equal(fmt.Sprintf("Error #01: %s\n", responseErr), span.Tag("gin.errors"))
 		// server errors set the ext.ErrorMsg tag
-		assert.Equal("oh no", span.Tag(ext.ErrorMsg))
+		assert.Equal(fmt.Sprintf("Error #01: %s\n", responseErr), span.Tag(ext.ErrorMsg))
 		assert.Equal(ext.SpanKindServer, span.Tag(ext.SpanKind))
 		assert.Equal("gin-gonic/gin", span.Tag(ext.Component))
 		assert.Equal(componentName, span.Integration())
@@ -220,7 +220,7 @@ func TestError(t *testing.T) {
 		defer mt.Reset()
 
 		router := gin.New()
-		router.Use(Middleware("foobar", WithErrorPropagation()))
+		router.Use(Middleware("foobar", WithUseGinErrors()))
 
 		// configure a handler that returns an error and 5xx status code
 		router.GET("/server_err", func(c *gin.Context) {

contrib/gin-gonic/gin/option.go

@@ -15,13 +15,13 @@ import (
 )
 
 type config struct {
-	analyticsRate  float64
-	resourceNamer  func(c *gin.Context) string
-	serviceName    string
-	ignoreRequest  func(c *gin.Context) bool
-	isStatusError  func(statusCode int) bool
-	propagateError bool
-	headerTags     instrumentation.HeaderTags
+	analyticsRate float64
+	resourceNamer func(c *gin.Context) string
+	serviceName   string
+	ignoreRequest func(c *gin.Context) bool
+	isStatusError func(statusCode int) bool
+	useGinErrors  bool
+	headerTags    instrumentation.HeaderTags
 }
 
 func newConfig(serviceName string) *config {
@@ -30,13 +30,13 @@ func newConfig(serviceName string) *config {
 	}
 	rate := instr.AnalyticsRate(true)
 	return &config{
-		analyticsRate:  rate,
-		resourceNamer:  defaultResourceNamer,
-		serviceName:    serviceName,
-		ignoreRequest:  func(_ *gin.Context) bool { return false },
-		isStatusError:  isServerError,
-		propagateError: false,
-		headerTags:     instr.HTTPHeadersAsTags(),
+		analyticsRate: rate,
+		resourceNamer: defaultResourceNamer,
+		serviceName:   serviceName,
+		ignoreRequest: func(_ *gin.Context) bool { return false },
+		isStatusError: isServerError,
+		useGinErrors:  false,
+		headerTags:    instr.HTTPHeadersAsTags(),
 	}
 }
 
@@ -95,11 +95,11 @@ func isServerError(statusCode int) bool {
 	return statusCode >= 500 && statusCode < 600
 }
 
-// WithErrorPropagation enables the propagation of gin's errors to the span.
+// WithUseGinErrors enables the usage of gin's errors for the span instead of crafting generic errors from the status code.
 // If there are multiple errors in the gin context, they will be all added to the span.
-func WithErrorPropagation() OptionFn {
+func WithUseGinErrors() OptionFn {
 	return func(cfg *config) {
-		cfg.propagateError = true
+		cfg.useGinErrors = true
 	}
 }