fix(otelecho): comply with span naming semconv

CHANGELOG.md

@@ -12,6 +12,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 - Added support for providing `endpoint`, `pollingIntervalMs` and `initialSamplingRate` using environment variable `OTEL_TRACES_SAMPLER_ARG` in `go.opentelemetry.io/contrib/samples/jaegerremote`. (#6310)
 - Added support exporting logs via OTLP over gRPC in `go.opentelemetry.io/contrib/config`. (#6340)
+- Added support custom span name in `go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho`. (#6365)
 
 ### Fixed
 

instrumentation/github.com/labstack/echo/otelecho/config.go

@@ -4,17 +4,28 @@
 package otelecho // import "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
 
 import (
+	"net/http"
+
 	"github.com/labstack/echo/v4/middleware"
 
 	"go.opentelemetry.io/otel/propagation"
 	oteltrace "go.opentelemetry.io/otel/trace"
 )
 
+// defaultSpanNameFormatter is the default function used for formatting span names.
+var defaultSpanNameFormatter = func(path string, _ *http.Request) string {
+	return path
+}
+
+// SpanNameFormatter is a function that takes a path and an HTTP request and returns a span name.
+type SpanNameFormatter func(string, *http.Request) string
+
 // config is used to configure the mux middleware.
 type config struct {
-	TracerProvider oteltrace.TracerProvider
-	Propagators    propagation.TextMapPropagator
-	Skipper        middleware.Skipper
+	TracerProvider    oteltrace.TracerProvider
+	Propagators       propagation.TextMapPropagator
+	Skipper           middleware.Skipper
+	spanNameFormatter SpanNameFormatter
 }
 
 // Option specifies instrumentation configuration options.
@@ -55,3 +66,12 @@ func WithSkipper(skipper middleware.Skipper) Option {
 		cfg.Skipper = skipper
 	})
 }
+
+// WithSpanNameFormatter specifies a function to use for formatting span names.
+func WithSpanNameFormatter(formatter SpanNameFormatter) Option {
+	return optionFunc(func(cfg *config) {
+		if formatter != nil {
+			cfg.spanNameFormatter = formatter
+		}
+	})
+}

instrumentation/github.com/labstack/echo/otelecho/echo.go

@@ -9,9 +9,8 @@ import (
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
 
-	"go.opentelemetry.io/otel"
-
 	"go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/internal/semconvutil"
+	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/propagation"
 	semconv "go.opentelemetry.io/otel/semconv/v1.20.0"
@@ -45,6 +44,10 @@ func Middleware(service string, opts ...Option) echo.MiddlewareFunc {
 		cfg.Skipper = middleware.DefaultSkipper
 	}
 
+	if cfg.spanNameFormatter == nil {
+		cfg.spanNameFormatter = defaultSpanNameFormatter
+	}
+
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
 		return func(c echo.Context) error {
 			if cfg.Skipper(c) {
@@ -67,7 +70,7 @@ func Middleware(service string, opts ...Option) echo.MiddlewareFunc {
 				rAttr := semconv.HTTPRoute(path)
 				opts = append(opts, oteltrace.WithAttributes(rAttr))
 			}
-			spanName := c.Path()
+			spanName := cfg.spanNameFormatter(c.Path(), c.Request())
 			if spanName == "" {
 				spanName = fmt.Sprintf("HTTP %s route not found", request.Method)
 			}

instrumentation/github.com/labstack/echo/otelecho/echo_test.go

@@ -14,12 +14,11 @@ import (
 	"github.com/labstack/echo/v4"
 	"github.com/stretchr/testify/assert"
 
+	b3prop "go.opentelemetry.io/contrib/propagators/b3"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/propagation"
 	"go.opentelemetry.io/otel/trace"
 	"go.opentelemetry.io/otel/trace/noop"
-
-	b3prop "go.opentelemetry.io/contrib/propagators/b3"
 )
 
 func TestGetSpanNotInstrumented(t *testing.T) {

instrumentation/github.com/labstack/echo/otelecho/test/echo_test.go

@@ -12,17 +12,15 @@ import (
 	"testing"
 
 	"github.com/labstack/echo/v4"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho"
 	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/sdk/trace"
 	"go.opentelemetry.io/otel/sdk/trace/tracetest"
-
-	"go.opentelemetry.io/otel/attribute"
 	oteltrace "go.opentelemetry.io/otel/trace"
 )
 
@@ -202,3 +200,57 @@ func TestErrorNotSwallowedByMiddleware(t *testing.T) {
 	err := h(c)
 	assert.Equal(t, assert.AnError, err)
 }
+
+func TestSpanNameFormatter(t *testing.T) {
+	imsb := tracetest.NewInMemoryExporter()
+	otel.SetTracerProvider(trace.NewTracerProvider(
+		trace.WithSyncer(imsb),
+	))
+
+	tests := []struct {
+		name      string
+		formatter otelecho.SpanNameFormatter
+		expected  string
+	}{
+		{
+			name:      "default",
+			formatter: nil,
+			expected:  "/user/:id",
+		},
+		{
+			name: "custom",
+			formatter: func(path string, req *http.Request) string {
+				return "custom " + path
+			},
+			expected: "custom /user/:id",
+		},
+		{
+			name: "has_request",
+			formatter: func(path string, req *http.Request) string {
+				return req.Method + " " + path
+			},
+			expected: "GET /user/:id",
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			defer imsb.Reset()
+
+			router := echo.New()
+			router.Use(otelecho.Middleware("foobar", otelecho.WithSpanNameFormatter(test.formatter)))
+			router.GET("/user/:id", func(c echo.Context) error {
+				return c.NoContent(http.StatusOK)
+			})
+
+			r := httptest.NewRequest("GET", "/user/123", nil)
+			w := httptest.NewRecorder()
+
+			router.ServeHTTP(w, r)
+
+			spans := imsb.GetSpans()
+			assert.Len(t, spans, 1)
+			assert.Equal(t, test.expected, spans[0].Name)
+		})
+	}
+}