contrib/labstack/echo.v4: add WithErrorTranslator Option

contrib/labstack/echo.v4/echotrace.go

@@ -88,8 +88,8 @@ func Middleware(opts ...Option) echo.MiddlewareFunc {
 
 				// It is impossible to determine what the final status code of a request is in echo.
 				// This is the best we can do.
-				var echoErr *echo.HTTPError
-				if errors.As(err, &echoErr) {
+				var echoErr *echo.HTTPError = cfg.customErrorFunc(err)
+				if echoErr != nil || errors.As(err, &echoErr) {
 					if cfg.isStatusError(echoErr.Code) {
 						finishOpts = append(finishOpts, tracer.WithError(err))
 					}

contrib/labstack/echo.v4/echotrace_test.go

@@ -424,6 +424,57 @@ func TestIgnoreRequestFunc(t *testing.T) {
 	assert.Len(spans, 0)
 }
 
+type testCustomError struct {
+	TestCode int
+}
+
+// Error satisfies the apierror interface
+func (e *testCustomError) Error() string {
+	return "test"
+}
+
+func TestCustomErrorFunc(t *testing.T) {
+	assert := assert.New(t)
+	mt := mocktracer.Start()
+	defer mt.Stop()
+	var called, traced bool
+
+	// setup
+	customErrorFunc := func(e error) *echo.HTTPError {
+		return &echo.HTTPError{
+			Message: e.(*testCustomError).Error(),
+			Code:    e.(*testCustomError).TestCode,
+		}
+	}
+	router := echo.New()
+	router.Use(Middleware(WithCustomErrorFunc(customErrorFunc)))
+
+	// a handler with an error and make the requests
+	router.GET("/err", func(c echo.Context) error {
+		_, traced = tracer.SpanFromContext(c.Request().Context())
+		called = true
+		return &testCustomError{
+			TestCode: 401,
+		}
+	})
+	r := httptest.NewRequest("GET", "/err", nil)
+	w := httptest.NewRecorder()
+	router.ServeHTTP(w, r)
+
+	// verify the error is correct and the stacktrace is disabled
+	assert.True(called)
+	assert.True(traced)
+
+	spans := mt.FinishedSpans()
+	require.Len(t, spans, 1)
+	span := spans[0]
+	assert.Equal("http.request", span.OperationName())
+	assert.Equal(ext.SpanTypeWeb, span.Tag(ext.SpanType))
+	assert.Contains(span.Tag(ext.ResourceName), "/err")
+	assert.Equal("401", span.Tag(ext.HTTPCode))
+	assert.Equal("GET", span.Tag(ext.HTTPMethod))
+}
+
 func TestNamingSchema(t *testing.T) {
 	genSpans := namingschematest.GenSpansFn(func(t *testing.T, serviceOverride string) []mocktracer.Span {
 		var opts []Option

contrib/labstack/echo.v4/option.go

@@ -24,6 +24,7 @@ type config struct {
 	noDebugStack      bool
 	ignoreRequestFunc IgnoreRequestFunc
 	isStatusError     func(statusCode int) bool
+	customErrorFunc   CustomErrorFunc
 	headerTags        *internal.LockMap
 }
 
@@ -33,11 +34,15 @@ type Option func(*config)
 // IgnoreRequestFunc determines if tracing will be skipped for a request.
 type IgnoreRequestFunc func(c echo.Context) bool
 
+// CustomErrorFunc attempts to translate a non-standard echo error to the required format
+type CustomErrorFunc func(err error) *echo.HTTPError
+
 func defaults(cfg *config) {
 	cfg.serviceName = namingschema.NewDefaultServiceName(defaultServiceName).GetName()
 	cfg.analyticsRate = math.NaN()
 	cfg.isStatusError = isServerError
 	cfg.headerTags = globalconfig.HeaderTagMap()
+	cfg.customErrorFunc = func(err error) *echo.HTTPError { return nil }
 }
 
 // WithServiceName sets the given service name for the system.
@@ -87,6 +92,14 @@ func WithIgnoreRequest(ignoreRequestFunc IgnoreRequestFunc) Option {
 	}
 }
 
+// WithCustomErrorFunction sets a function to translate custom errors into the
+// expected format
+func WithCustomErrorFunc(customErrorFunc CustomErrorFunc) Option {
+	return func(cfg *config) {
+		cfg.customErrorFunc = customErrorFunc
+	}
+}
+
 // WithStatusCheck specifies a function fn which reports whether the passed
 // statusCode should be considered an error.
 func WithStatusCheck(fn func(statusCode int) bool) Option {