otelgin: Change the Filter parameter from *http.Request to *gin.Context

CHANGELOG.md

@@ -8,6 +8,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Changed
+
+- Change the `Filter` parameter from `*http.Request` to `*gin.Context` in `go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin`. (#4444)
+
 ### Added
 
 - Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068, #3108)

instrumentation/github.com/gin-gonic/gin/otelgin/gintrace.go

@@ -55,7 +55,7 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
 	}
 	return func(c *gin.Context) {
 		for _, f := range cfg.Filters {
-			if !f(c.Request) {
+			if !f(c) {
 				// Serve the request to the next middleware
 				// if a filter rejects the request.
 				c.Next()

instrumentation/github.com/gin-gonic/gin/otelgin/option.go

@@ -19,6 +19,7 @@ package otelgin // import "go.opentelemetry.io/contrib/instrumentation/github.co
 import (
 	"net/http"
 
+	"github.com/gin-gonic/gin"
 	"go.opentelemetry.io/otel/propagation"
 	oteltrace "go.opentelemetry.io/otel/trace"
 )
@@ -30,9 +31,9 @@ type config struct {
 	SpanNameFormatter SpanNameFormatter
 }
 
-// Filter is a predicate used to determine whether a given http.request should
+// Filter is a predicate used to determine whether a given gin.Context should
 // be traced. A Filter must return true if the request should be traced.
-type Filter func(*http.Request) bool
+type Filter func(*gin.Context) bool
 
 // SpanNameFormatter is used to set span name by http.request.
 type SpanNameFormatter func(r *http.Request) string

instrumentation/github.com/gin-gonic/gin/otelgin/test/gintrace_test.go

@@ -235,7 +235,7 @@ func TestWithFilter(t *testing.T) {
 		otel.SetTracerProvider(sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr)))
 
 		router := gin.New()
-		f := func(req *http.Request) bool { return req.URL.Path != "/healthcheck" }
+		f := func(req *gin.Context) bool { return c.Request.URL.Path != "/healthcheck" }
 		router.Use(otelgin.Middleware("foobar", otelgin.WithFilter(f)))
 		router.GET("/healthcheck", func(c *gin.Context) {})
 
@@ -251,7 +251,7 @@ func TestWithFilter(t *testing.T) {
 		otel.SetTracerProvider(sdktrace.NewTracerProvider(sdktrace.WithSpanProcessor(sr)))
 
 		router := gin.New()
-		f := func(req *http.Request) bool { return req.URL.Path != "/healthcheck" }
+		f := func(req *gin.Context) bool { return c.Request.URL.Path != "/healthcheck" }
 		router.Use(otelgin.Middleware("foobar", otelgin.WithFilter(f)))
 		router.GET("/user/:id", func(c *gin.Context) {})