internal/shared/semconv: set http.route from Request.Pattern

CHANGELOG.md

@@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Added
+
+- `http.route` attribute to otelhttp server request spans, when `net/http.Request.Pattern` is set in `go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful/otelrestful`, `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`, `go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux`, `go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho` and `go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp`. (#6905)
+
 ### Changed
 
 - Jaeger remote sampler's probabilistic strategy now uses the same sampling algorithm as `trace.TraceIDRatioBased` in `go.opentelemetry.io/contrib/samplers/jaegerremote`. (#6892)

instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconv/httpconv.go

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

instrumentation/github.com/emicklei/go-restful/otelrestful/internal/semconv/httpconv_test.go

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}

instrumentation/github.com/gin-gonic/gin/otelgin/internal/semconv/httpconv.go

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

instrumentation/github.com/gin-gonic/gin/otelgin/internal/semconv/httpconv_test.go

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}

instrumentation/github.com/gorilla/mux/otelmux/internal/semconv/httpconv.go

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

instrumentation/github.com/gorilla/mux/otelmux/internal/semconv/httpconv_test.go

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}

instrumentation/net/http/httptrace/otelhttptrace/internal/semconv/httpconv.go

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

instrumentation/net/http/httptrace/otelhttptrace/internal/semconv/httpconv_test.go

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}

instrumentation/net/http/otelhttp/internal/semconv/httpconv.go

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

instrumentation/net/http/otelhttp/internal/semconv/httpconv_test.go

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}

internal/shared/semconv/httpconv.go.tmpl

@@ -22,7 +22,7 @@ import (
 
 type CurrentHTTPServer struct{}
 
-// TraceRequest returns trace attributes for an HTTP request received by a
+// RequestTraceAttrs returns trace attributes for an HTTP request received by a
 // server.
 //
 // The server must be the primary server name if it is known. For example this
@@ -96,6 +96,11 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		count++
 	}
 
+	httpRoute := req.Pattern
+	if httpRoute != "" {
+		count++
+	}
+
 	attrs := make([]attribute.KeyValue, 0, count)
 	attrs = append(attrs,
 		semconvNew.ServerAddress(host),
@@ -138,6 +143,10 @@ func (n CurrentHTTPServer) RequestTraceAttrs(server string, req *http.Request) [
 		attrs = append(attrs, semconvNew.NetworkProtocolVersion(protoVersion))
 	}
 
+	if httpRoute != "" {
+		attrs = append(attrs, n.Route(httpRoute))
+	}
+
 	return attrs
 }
 

internal/shared/semconv/httpconv_test.go.tmpl

@@ -8,6 +8,7 @@ package semconv
 
 import (
 	"net/http"
+	"net/http/httptest"
 	"strconv"
 	"testing"
 
@@ -256,3 +257,18 @@ func TestCurrentHttpClient_MetricAttributes(t *testing.T) {
 		})
 	}
 }
+
+func TestRequestTraceAttrs_HTTPRoute(t *testing.T) {
+	req := httptest.NewRequest("GET", "/high/cardinality/path/abc123", nil)
+	req.Pattern = "/high/cardinality/path/{id}"
+
+	var found bool
+	for _, attr := range (CurrentHTTPServer{}).RequestTraceAttrs("", req) {
+		if attr.Key != "http.route" {
+			continue
+		}
+		found = true
+		assert.Equal(t, req.Pattern, attr.Value.AsString())
+	}
+	require.True(t, found)
+}