support semconv v1.30 (#44)

Author: minimAluminiumalism

.github/workflows/tests.yml

@@ -13,6 +13,9 @@ jobs:
         with:
           go-version: '1.22'
 
+      - name: Tidy modules
+        run: go mod tidy
+
       - uses: actions/cache@v3
         with:
           path: ~/go/pkg/mod

.gitignore

@@ -2,3 +2,6 @@
 metrics/test.db
 logging/logrus/test.db
 .DS_Store
+
+.vscode/
+

go.mod

@@ -4,23 +4,45 @@ go 1.22
 
 require (
 	github.com/sirupsen/logrus v1.9.3
-	github.com/stretchr/testify v1.9.0
+	github.com/stretchr/testify v1.10.0
 	go.opentelemetry.io/contrib/instrumentation/runtime v0.44.0
 	go.opentelemetry.io/contrib/propagators/b3 v1.19.0
 	go.opentelemetry.io/contrib/propagators/jaeger v1.19.0
 	go.opentelemetry.io/contrib/propagators/opencensus v0.44.0
 	go.opentelemetry.io/contrib/propagators/ot v1.19.0
-	go.opentelemetry.io/otel v1.32.0
+	go.opentelemetry.io/otel v1.35.0
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v0.42.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.19.0
 	go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.32.0
-	go.opentelemetry.io/otel/metric v1.32.0
+	go.opentelemetry.io/otel/metric v1.35.0
 	go.opentelemetry.io/otel/sdk v1.32.0
 	go.opentelemetry.io/otel/sdk/metric v1.32.0
-	go.opentelemetry.io/otel/trace v1.32.0
+	go.opentelemetry.io/otel/trace v1.35.0
 	gorm.io/driver/sqlite v1.5.0
-	gorm.io/gorm v1.25.1
+	gorm.io/gorm v1.25.10
+)
+
+require (
+	github.com/ClickHouse/ch-go v0.61.5 // indirect
+	github.com/ClickHouse/clickhouse-go/v2 v2.23.2 // indirect
+	github.com/andybalholm/brotli v1.1.0 // indirect
+	github.com/go-faster/city v1.0.1 // indirect
+	github.com/go-faster/errors v0.7.1 // indirect
+	github.com/go-sql-driver/mysql v1.7.0 // indirect
+	github.com/hashicorp/go-version v1.6.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgx/v5 v5.5.5 // indirect
+	github.com/jackc/puddle/v2 v2.2.1 // indirect
+	github.com/klauspost/compress v1.17.8 // indirect
+	github.com/paulmach/orb v0.11.1 // indirect
+	github.com/pierrec/lz4/v4 v4.1.21 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/segmentio/asm v1.2.0 // indirect
+	github.com/shopspring/decimal v1.4.0 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
 )
 
 require (
@@ -37,16 +59,20 @@ require (
 	github.com/mattn/go-sqlite3 v1.14.15 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
 	go.opentelemetry.io/otel/bridge/opencensus v0.41.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric v0.42.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.0.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	golang.org/x/net v0.17.0 // indirect
+	golang.org/x/net v0.22.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20230822172742-b8732ec3820d // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230822172742-b8732ec3820d // indirect
 	google.golang.org/grpc v1.59.0 // indirect
-	google.golang.org/protobuf v1.31.0 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
+	gorm.io/driver/clickhouse v0.6.1
+	gorm.io/driver/mysql v1.5.7
+	gorm.io/driver/postgres v1.5.11
 )

go.sum

@@ -9,7 +9,7 @@ import (
 	"go.opentelemetry.io/otel/propagation"
 	"go.opentelemetry.io/otel/sdk/resource"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
-	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 )
 
 // Option opts for opentelemetry tracer provider
@@ -70,21 +70,21 @@ func defaultConfig() *config {
 // WithServiceName configures `service.name` resource attribute
 func WithServiceName(serviceName string) Option {
 	return option(func(cfg *config) {
-		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.ServiceNameKey.String(serviceName))
+		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.ServiceName(serviceName))
 	})
 }
 
-// WithDeploymentEnvironment configures `deployment.environment` resource attribute
+// WithDeploymentEnvironment configures `deployment.environment.name` resource attribute
 func WithDeploymentEnvironment(env string) Option {
 	return option(func(cfg *config) {
-		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.DeploymentEnvironmentKey.String(env))
+		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.DeploymentEnvironmentName(env))
 	})
 }
 
 // WithServiceNamespace configures `service.namespace` resource attribute
 func WithServiceNamespace(namespace string) Option {
 	return option(func(cfg *config) {
-		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.ServiceNamespaceKey.String(namespace))
+		cfg.resourceAttributes = append(cfg.resourceAttributes, semconv.ServiceNamespace(namespace))
 	})
 }
 

provider/options.go

@@ -13,7 +13,7 @@ import (
 	"go.opentelemetry.io/otel/sdk/resource"
 
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
-	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 )
 
 type OtelProvider interface {

provider/provider.go

@@ -2,7 +2,7 @@ package tracing
 
 import (
 	"go.opentelemetry.io/otel/attribute"
-	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 	"go.opentelemetry.io/otel/trace"
 )
 
@@ -23,9 +23,9 @@ func WithAttributes(attrs ...attribute.KeyValue) Option {
 }
 
 // WithDBName configures a db.name attribute.
-func WithDBName(name string) Option {
+func WithDBSystem(name string) Option {
 	return func(p *otelPlugin) {
-		p.attrs = append(p.attrs, semconv.DBNameKey.String(name))
+		p.attrs = append(p.attrs, semconv.DBSystemNameKey.String(name))
 	}
 }
 

tracing/option.go

@@ -11,8 +11,11 @@ import (
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
-	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 	"go.opentelemetry.io/otel/trace"
+	"gorm.io/driver/clickhouse"
+	"gorm.io/driver/mysql"
+	"gorm.io/driver/postgres"
 	"gorm.io/gorm"
 
 	"gorm.io/plugin/opentelemetry/metrics"
@@ -106,7 +109,30 @@ func (p otelPlugin) Initialize(db *gorm.DB) (err error) {
 
 func (p *otelPlugin) before(spanName string) gormHookFunc {
 	return func(tx *gorm.DB) {
-		tx.Statement.Context, _ = p.tracer.Start(tx.Statement.Context, spanName, trace.WithSpanKind(trace.SpanKindClient))
+		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:
+
+		}
 	}
 }
 
@@ -135,10 +161,19 @@ func (p *otelPlugin) after() gormHookFunc {
 		}
 
 		formatQuery := p.formatQuery(query)
-		attrs = append(attrs, semconv.DBStatementKey.String(formatQuery))
-		attrs = append(attrs, semconv.DBOperationKey.String(dbOperation(formatQuery)))
+		attrs = append(attrs, semconv.DBQueryText(formatQuery))
+		operation := dbOperation(formatQuery)
+		attrs = append(attrs, semconv.DBOperationName(operation))
 		if tx.Statement.Table != "" {
-			attrs = append(attrs, semconv.DBSQLTableKey.String(tx.Statement.Table))
+			attrs = append(attrs, semconv.DBCollectionName(tx.Statement.Table))
+			// add attr `db.query.summary`
+			dbQuerySummary := operation + " " + tx.Statement.Table
+			attrs = append(attrs, semconv.DBQuerySummary(dbQuerySummary))
+
+			// according to semconv, we should update the span name here if `db.query.summary`is available
+			// Use `db.query.summary` as span name directly here instead of keeping the original span name like `gorm.Query`,
+			// as we cannot access the original span name here.
+			span.SetName(dbQuerySummary)
 		}
 		if tx.Statement.RowsAffected != -1 {
 			attrs = append(attrs, dbRowsAffected.Int64(tx.Statement.RowsAffected))
@@ -169,19 +204,19 @@ func (p *otelPlugin) formatQuery(query string) string {
 func dbSystem(tx *gorm.DB) attribute.KeyValue {
 	switch tx.Dialector.Name() {
 	case "mysql":
-		return semconv.DBSystemMySQL
+		return semconv.DBSystemNameMySQL
 	case "mssql":
-		return semconv.DBSystemMSSQL
+		return semconv.DBSystemNameMicrosoftSQLServer
 	case "postgres", "postgresql":
-		return semconv.DBSystemPostgreSQL
+		return semconv.DBSystemNamePostgreSQL
 	case "sqlite":
-		return semconv.DBSystemSqlite
+		return semconv.DBSystemNameSqlite
 	case "sqlserver":
-		return semconv.DBSystemKey.String("sqlserver")
+		return semconv.DBSystemNameMicrosoftSQLServer
 	case "clickhouse":
-		return semconv.DBSystemKey.String("clickhouse")
+		return semconv.DBSystemNameClickhouse
 	case "spanner":
-		return semconv.DBSystemKey.String("spanner")
+		return semconv.DBSystemNameGCPSpanner
 	default:
 		return attribute.KeyValue{}
 	}

tracing/tracing.go

@@ -10,7 +10,7 @@ import (
 	"go.opentelemetry.io/otel/codes"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 	"go.opentelemetry.io/otel/sdk/trace/tracetest"
-	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.30.0"
 	"go.opentelemetry.io/otel/trace"
 	"gorm.io/driver/sqlite"
 	"gorm.io/gorm"
@@ -37,15 +37,15 @@ func TestOtel(t *testing.T) {
 
 				m := attrMap(spans[0].Attributes())
 
-				sys, ok := m[semconv.DBSystemKey]
+				sys, ok := m[semconv.DBSystemNameKey]
 				require.True(t, ok)
 				require.Equal(t, "sqlite", sys.AsString())
 
-				stmt, ok := m[semconv.DBStatementKey]
+				stmt, ok := m[semconv.DBQueryTextKey]
 				require.True(t, ok)
 				require.Equal(t, "SELECT 42", stmt.AsString())
 
-				operation, ok := m[semconv.DBOperationKey]
+				operation, ok := m[semconv.DBOperationNameKey]
 				require.True(t, ok)
 				require.Equal(t, "select", operation.AsString())
 			},
@@ -66,15 +66,15 @@ func TestOtel(t *testing.T) {
 
 				m := attrMap(span.Attributes())
 
-				sys, ok := m[semconv.DBSystemKey]
+				sys, ok := m[semconv.DBSystemNameKey]
 				require.True(t, ok)
 				require.Equal(t, "sqlite", sys.AsString())
 
-				stmt, ok := m[semconv.DBStatementKey]
+				stmt, ok := m[semconv.DBQueryTextKey]
 				require.True(t, ok)
 				require.Equal(t, "SELECT foo_bar", stmt.AsString())
 
-				operation, ok := m[semconv.DBOperationKey]
+				operation, ok := m[semconv.DBOperationNameKey]
 				require.True(t, ok)
 				require.Equal(t, "select", operation.AsString())
 			},
@@ -94,20 +94,20 @@ func TestOtel(t *testing.T) {
 					fmt.Printf("span=%#v\n", s)
 				}
 				require.Equal(t, 2, len(spans))
-				require.Equal(t, "gorm.Row", spans[1].Name())
+				require.Equal(t, "select foo", spans[1].Name())
 				require.Equal(t, trace.SpanKindClient, spans[1].SpanKind())
 
 				m := attrMap(spans[1].Attributes())
 
-				sys, ok := m[semconv.DBSystemKey]
+				sys, ok := m[semconv.DBSystemNameKey]
 				require.True(t, ok)
 				require.Equal(t, "sqlite", sys.AsString())
 
-				stmt, ok := m[semconv.DBStatementKey]
+				stmt, ok := m[semconv.DBQueryTextKey]
 				require.True(t, ok)
 				require.Equal(t, "SELECT id FROM `foo` WHERE id = ?", stmt.AsString())
 
-				operation, ok := m[semconv.DBOperationKey]
+				operation, ok := m[semconv.DBOperationNameKey]
 				require.True(t, ok)
 				require.Equal(t, "select", operation.AsString())
 			},