feat: add option to exclude server address attribute (#47)

* feat: add option to exclude server address attribute

* chore: formating tracing_test.go

Author: higordasneves

tracing/option.go

@@ -56,3 +56,10 @@ func WithRecordStackTrace() Option {
 		p.recordStackTraceInSpan = true
 	}
 }
+
+// WithoutServerAddress excludes db.server_address attribute.
+func WithoutServerAddress() Option {
+	return func(p *otelPlugin) {
+		p.excludeServerAddress = true
+	}
+}

tracing/tracing.go

@@ -36,6 +36,7 @@ type otelPlugin struct {
 	attrs                  []attribute.KeyValue
 	excludeQueryVars       bool
 	excludeMetrics         bool
+	excludeServerAddress   bool
 	recordStackTraceInSpan bool
 	queryFormatter         func(query string) string
 }
@@ -112,26 +113,28 @@ func (p *otelPlugin) before(spanName string) gormHookFunc {
 		ctx, span := p.tracer.Start(tx.Statement.Context, spanName, trace.WithSpanKind(trace.SpanKindClient))
 		tx.Statement.Context = ctx
 
-		// `server.address` is required in the latest semconv
-		var serverAddrAttr attribute.KeyValue
-		switch dialector := tx.Config.Dialector.(type) {
-		case *mysql.Dialector:
-			if dialector.Config.DSNConfig != nil && dialector.Config.DSNConfig.Addr != "" {
-				serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSNConfig.Addr)
-				span.SetAttributes(serverAddrAttr)
-			}
-		case *clickhouse.Dialector:
-			if dialector.Config.DSN != "" {
-				serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSN)
-				span.SetAttributes(serverAddrAttr)
-			}
-		case *postgres.Dialector:
-			if dialector.Config.DSN != "" {
-				serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSN)
-				span.SetAttributes(serverAddrAttr)
-			}
-		default:
+		if !p.excludeServerAddress {
+			// `server.address` is required in the latest semconv
+			var serverAddrAttr attribute.KeyValue
+			switch dialector := tx.Config.Dialector.(type) {
+			case *mysql.Dialector:
+				if dialector.Config.DSNConfig != nil && dialector.Config.DSNConfig.Addr != "" {
+					serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSNConfig.Addr)
+					span.SetAttributes(serverAddrAttr)
+				}
+			case *clickhouse.Dialector:
+				if dialector.Config.DSN != "" {
+					serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSN)
+					span.SetAttributes(serverAddrAttr)
+				}
+			case *postgres.Dialector:
+				if dialector.Config.DSN != "" {
+					serverAddrAttr = semconv.ServerAddressKey.String(dialector.Config.DSN)
+					span.SetAttributes(serverAddrAttr)
+				}
+			default:
 
+			}
 		}
 	}
 }

tracing/tracing_test.go

@@ -12,6 +12,7 @@ import (
 	"go.opentelemetry.io/otel/sdk/trace/tracetest"
 	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 	"go.opentelemetry.io/otel/trace"
+	"gorm.io/driver/postgres"
 	"gorm.io/driver/sqlite"
 	"gorm.io/gorm"
 )
@@ -112,6 +113,39 @@ func TestOtel(t *testing.T) {
 				require.Equal(t, "select", operation.AsString())
 			},
 		},
+		{
+			do: func(ctx context.Context, db *gorm.DB) {
+				var num int
+				db.Config.Dialector = &postgres.Dialector{
+					Config: &postgres.Config{
+						DSN: "test.dsn",
+					},
+				}
+				err := db.WithContext(ctx).Raw("SELECT 42").Scan(&num).Error
+				require.NoError(t, err)
+			},
+			require: func(t *testing.T, spans []sdktrace.ReadOnlySpan) {
+				m := attrMap(spans[0].Attributes())
+				require.Equal(t, "test.dsn", m[semconv.ServerAddressKey].AsString())
+			},
+		},
+		{
+			do: func(ctx context.Context, db *gorm.DB) {
+				var num int
+				db.Config.Dialector = &postgres.Dialector{
+					Config: &postgres.Config{
+						DSN: "test.dsn",
+					},
+				}
+				err := db.WithContext(ctx).Raw("SELECT 42").Scan(&num).Error
+				require.NoError(t, err)
+			},
+			opts: []Option{WithoutServerAddress()},
+			require: func(t *testing.T, spans []sdktrace.ReadOnlySpan) {
+				m := attrMap(spans[0].Attributes())
+				require.Equal(t, "", m[semconv.ServerAddressKey].AsString())
+			},
+		},
 	}
 
 	for i, test := range tests {