refactor: rename GinFilter and GinMetricAttributeFn to Filter and MetricAttributeFn

Author: flc1125

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

@@ -19,12 +19,12 @@ import (
 )
 
 type config struct {
-	TracerProvider       oteltrace.TracerProvider
-	Propagators          propagation.TextMapPropagator
-	GinFilters           []GinFilter
-	SpanNameFormatter    SpanNameFormatter
-	MeterProvider        metric.MeterProvider
-	GinMetricAttributeFn GinMetricAttributeFn
+	TracerProvider    oteltrace.TracerProvider
+	Propagators       propagation.TextMapPropagator
+	Filters           []Filter
+	SpanNameFormatter SpanNameFormatter
+	MeterProvider     metric.MeterProvider
+	MetricAttributeFn MetricAttributeFn
 }
 
 // defaultSpanNameFormatter is the default span name formatter.
@@ -47,15 +47,15 @@ var defaultSpanNameFormatter SpanNameFormatter = func(c *gin.Context) string {
 	return method
 }
 
-// GinFilter filters an [net/http.Request] based on content of a [gin.Context].
-type GinFilter func(*gin.Context) bool
+// Filter filters an [net/http.Request] based on content of a [gin.Context].
+type Filter func(*gin.Context) bool
 
 // SpanNameFormatter is used by `WithSpanNameFormatter` to customize the request's span name.
 type SpanNameFormatter func(*gin.Context) string
 
-// GinMetricAttributeFn is used to extract additional attributes from the gin.Context
+// MetricAttributeFn is used to extract additional attributes from the gin.Context
 // and return them as a slice of attribute.KeyValue.
-type GinMetricAttributeFn func(*gin.Context) []attribute.KeyValue
+type MetricAttributeFn func(*gin.Context) []attribute.KeyValue
 
 // Option specifies instrumentation configuration options.
 type Option interface {
@@ -89,10 +89,10 @@ func WithTracerProvider(provider oteltrace.TracerProvider) Option {
 	})
 }
 
-// WithGinFilter adds a gin filter to the list of filters used by the handler.
-func WithGinFilter(f ...GinFilter) Option {
+// WithFilter adds a gin filter to the list of filters used by the handler.
+func WithFilter(f ...Filter) Option {
 	return optionFunc(func(c *config) {
-		c.GinFilters = append(c.GinFilters, f...)
+		c.Filters = append(c.Filters, f...)
 	})
 }
 
@@ -112,12 +112,12 @@ func WithMeterProvider(mp metric.MeterProvider) Option {
 	})
 }
 
-// WithGinMetricAttributeFn specifies a function that extracts additional attributes from the gin.Context
+// WithMetricAttributeFn specifies a function that extracts additional attributes from the gin.Context
 // and returns them as a slice of attribute.KeyValue.
 //
 // If attributes are duplicated between this method and `WithMetricAttributeFn`, the attributes in this method will be used.
-func WithGinMetricAttributeFn(f GinMetricAttributeFn) Option {
+func WithMetricAttributeFn(f MetricAttributeFn) Option {
 	return optionFunc(func(c *config) {
-		c.GinMetricAttributeFn = f
+		c.MetricAttributeFn = f
 	})
 }

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

@@ -61,7 +61,7 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		requestStartTime := time.Now()
 
-		for _, f := range cfg.GinFilters {
+		for _, f := range cfg.Filters {
 			if !f(c) {
 				// Serve the request to the next middleware
 				// if a filter rejects the request.
@@ -114,8 +114,8 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
 
 		// Record the server-side attributes.
 		var additionalAttributes []attribute.KeyValue
-		if cfg.GinMetricAttributeFn != nil {
-			additionalAttributes = append(additionalAttributes, cfg.GinMetricAttributeFn(c)...)
+		if cfg.MetricAttributeFn != nil {
+			additionalAttributes = append(additionalAttributes, cfg.MetricAttributeFn(c)...)
 		}
 
 		sc.RecordMetrics(ctx, semconv.ServerMetricData{

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

@@ -395,7 +395,7 @@ func TestWithGinFilter(t *testing.T) {
 
 		router := gin.New()
 		f := func(c *gin.Context) bool { return c.Request.URL.Path != "/healthcheck" }
-		router.Use(otelgin.Middleware("foobar", otelgin.WithGinFilter(f)))
+		router.Use(otelgin.Middleware("foobar", otelgin.WithFilter(f)))
 		router.GET("/healthcheck", func(c *gin.Context) {})
 
 		r := httptest.NewRequest("GET", "/healthcheck", nil)
@@ -411,7 +411,7 @@ func TestWithGinFilter(t *testing.T) {
 
 		router := gin.New()
 		f := func(c *gin.Context) bool { return c.Request.URL.Path != "/user/:id" }
-		router.Use(otelgin.Middleware("foobar", otelgin.WithGinFilter(f)))
+		router.Use(otelgin.Middleware("foobar", otelgin.WithFilter(f)))
 		router.GET("/user/:id", func(c *gin.Context) {})
 
 		r := httptest.NewRequest("GET", "/user/123", nil)
@@ -424,16 +424,16 @@ func TestWithGinFilter(t *testing.T) {
 
 func TestMetrics(t *testing.T) {
 	tests := []struct {
-		name                        string
-		ginMetricAttributeExtractor func(*gin.Context) []attribute.KeyValue
+		name                     string
+		metricAttributeExtractor func(*gin.Context) []attribute.KeyValue
 	}{
 		{
-			name:                        "default",
-			ginMetricAttributeExtractor: nil,
+			name:                     "default",
+			metricAttributeExtractor: nil,
 		},
 		{
 			name: "with metric attributes callback",
-			ginMetricAttributeExtractor: func(c *gin.Context) []attribute.KeyValue {
+			metricAttributeExtractor: func(c *gin.Context) []attribute.KeyValue {
 				return []attribute.KeyValue{
 					attribute.String("key1", "value1"),
 					attribute.String("key2", "value"),
@@ -451,7 +451,7 @@ func TestMetrics(t *testing.T) {
 			router := gin.New()
 			router.Use(otelgin.Middleware("foobar",
 				otelgin.WithMeterProvider(meterProvider),
-				otelgin.WithGinMetricAttributeFn(tt.ginMetricAttributeExtractor),
+				otelgin.WithMetricAttributeFn(tt.metricAttributeExtractor),
 			))
 			router.GET("/user/:id", func(c *gin.Context) {
 				id := c.Param("id")
@@ -483,8 +483,8 @@ func TestMetrics(t *testing.T) {
 				attribute.String("url.scheme", "http"),
 			}
 
-			if tt.ginMetricAttributeExtractor != nil {
-				attrs = append(attrs, tt.ginMetricAttributeExtractor(c)...)
+			if tt.metricAttributeExtractor != nil {
+				attrs = append(attrs, tt.metricAttributeExtractor(c)...)
 			}
 
 			metricdatatest.AssertEqual(t, metricdata.Metrics{