adding options pattern to hypersql and hyperpgx

Author: varkey98

examples/sql-query/main.go

@@ -16,7 +16,6 @@ import (
 	"github.com/hypertrace/goagent/instrumentation/hypertrace"
 	"github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
 	"github.com/hypertrace/goagent/instrumentation/hypertrace/net/hyperhttp"
-	sdkSQL "github.com/hypertrace/goagent/sdk/instrumentation/database/sql"
 )
 
 const mysqlLoopCount int = 5
@@ -74,7 +73,7 @@ func fooHandler(db *sql.DB, w http.ResponseWriter, r *http.Request) {
 
 func dbConn() (db *sql.DB) {
 	// Explicitly wrap the MySQLDriver driver with hypersql.
-	driver := hypersql.Wrap(&mysql.MySQLDriver{}, &sdkSQL.Options{})
+	driver := hypersql.Wrap(&mysql.MySQLDriver{})
 
 	// Register our hypersql wrapper as a database driver.
 	sql.Register("ht-mysql", driver)

instrumentation/hypertrace/database/hypersql/README.md

@@ -39,3 +39,42 @@ sql.Register("ht-mysql", driver)
 // Connect to a MySQL database using the hypersql driver wrapper
 db, err = sql.Open("ht-mysql", "user:password@/dbname")
 ```
+
+For adding a filter implementation to the instrumentation, there's an option to use hypersql.WithFilter to add filters to the instrumentation.
+```go
+
+import (
+    "github.com/go-sql-driver/mysql"
+    "github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
+    "github.com/hypertrace/goagent/sdk/filter"
+)
+
+// Explicitly wrap the MySQL driver with hypersql
+driver := hypersql.Wrap(&mysql.MySQLDriver{}, hypersql.WithFilter(filter.NoopFilter{}))
+
+// Register our hypersql wrapper as a database driver
+sql.Register("ht-mysql", driver)
+
+// Connect to a MySQL database using the hypersql driver wrapper
+db, err = sql.Open("ht-mysql", "user:password@/dbname")
+```
+
+OR
+
+```go
+import (
+    "database/sql"
+    "github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
+    "github.com/hypertrace/goagent/sdk/filter"
+)
+
+// Register our hypersql wrapper for the provided MySQL driver.
+driverName, err = hypersql.Register("mysql", hypersql.WithFilter(filter.NoopFilter{}))
+if err != nil {
+    log.Fatalf("unable to register goagent driver: %v\n", err)
+}
+
+// Connect to a MySQL database using the hypersql driver wrapper.
+db, err = sql.Open(driverName, "user:password@/dbname")
+
+```

instrumentation/hypertrace/database/hypersql/options.go

@@ -0,0 +1,24 @@
+package hypersql // import "github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
+
+import (
+	"github.com/hypertrace/goagent/sdk/filter"
+	sdkSQL "github.com/hypertrace/goagent/sdk/instrumentation/database/sql"
+)
+
+type options struct {
+	Filter filter.Filter
+}
+
+func (o *options) toSDKOptions() *sdkSQL.Options {
+	opts := (sdkSQL.Options)(*o)
+	return &opts
+}
+
+type Option func(o *options)
+
+// WithFilter adds a filter to the GRPC option.
+func WithFilter(f filter.Filter) Option {
+	return func(o *options) {
+		o.Filter = f
+	}
+}

instrumentation/hypertrace/database/hypersql/options_test.go

@@ -0,0 +1,15 @@
+package hypersql // import "github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
+
+import (
+	"testing"
+
+	"github.com/hypertrace/goagent/sdk/filter"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestOptionsToSDK(t *testing.T) {
+	o := &options{
+		Filter: filter.NoopFilter{},
+	}
+	assert.Equal(t, filter.NoopFilter{}, o.toSDKOptions().Filter)
+}

instrumentation/hypertrace/database/hypersql/sql.go

@@ -1,13 +1,28 @@
 package hypersql // import "github.com/hypertrace/goagent/instrumentation/hypertrace/database/hypersql"
 
 import (
+	"database/sql/driver"
 	otelsql "github.com/hypertrace/goagent/instrumentation/opentelemetry/database/hypersql"
 )
 
 // Wrap takes a SQL driver and wraps it with Hypertrace instrumentation.
-var Wrap = otelsql.Wrap
+func Wrap(d driver.Driver, opts ...Option) driver.Driver {
+	o := &options{}
+	for _, opt := range opts {
+		opt(o)
+	}
+
+	return otelsql.Wrap(d, o.toSDKOptions())
+}
 
 // Register initializes and registers the hypersql wrapped database driver
 // identified by its driverName. On success it
 // returns the generated driverName to use when calling sql.Open.
-var Register = otelsql.Register
+func Register(driverName string, opts ...Option) (string, error) {
+	o := &options{}
+	for _, opt := range opts {
+		opt(o)
+	}
+	return otelsql.Register(driverName, o.toSDKOptions())
+
+}

instrumentation/hypertrace/github.com/jackc/hyperpgx/go.mod

@@ -8,10 +8,15 @@ replace github.com/hypertrace/goagent => ../../../../..
 
 replace github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx => ../../../../../instrumentation/opentelemetry/github.com/jackc/hyperpgx
 
-require github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx v0.0.0-00010101000000-000000000000
+require (
+	github.com/hypertrace/goagent v0.0.0-00010101000000-000000000000
+	github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx v0.0.0-00010101000000-000000000000
+	github.com/stretchr/testify v1.10.0
+)
 
 require (
 	github.com/cenkalti/backoff/v5 v5.0.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/ghodss/yaml v1.0.0 // indirect
 	github.com/go-logr/logr v1.4.3 // indirect
@@ -20,7 +25,6 @@ require (
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 // indirect
 	github.com/hypertrace/agent-config/gen/go v0.0.0-20240523214336-1259231da906 // indirect
-	github.com/hypertrace/goagent v0.0.0-00010101000000-000000000000 // indirect
 	github.com/jackc/chunkreader/v2 v2.0.1 // indirect
 	github.com/jackc/pgconn v1.8.1 // indirect
 	github.com/jackc/pgio v1.0.0 // indirect
@@ -30,6 +34,7 @@ require (
 	github.com/jackc/pgtype v1.7.0 // indirect
 	github.com/jackc/pgx/v4 v4.11.0 // indirect
 	github.com/openzipkin/zipkin-go v0.4.3 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/tklauser/go-sysconf v0.3.14 // indirect
 	github.com/tklauser/numcpus v0.8.0 // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
@@ -59,4 +64,5 @@ require (
 	google.golang.org/grpc v1.72.2 // indirect
 	google.golang.org/protobuf v1.36.6 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

instrumentation/hypertrace/github.com/jackc/hyperpgx/options.go

@@ -0,0 +1,24 @@
+package hyperpgx // import "github.com/hypertrace/goagent/instrumentation/hypertrace/github.com/jackc/hyperpgx"
+
+import (
+	otelpgx "github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx"
+	"github.com/hypertrace/goagent/sdk/filter"
+)
+
+type options struct {
+	Filter filter.Filter
+}
+
+func (o *options) toSDKOptions() *otelpgx.Options {
+	opts := (otelpgx.Options)(*o)
+	return &opts
+}
+
+type Option func(o *options)
+
+// WithFilter adds a filter to the GRPC option.
+func WithFilter(f filter.Filter) Option {
+	return func(o *options) {
+		o.Filter = f
+	}
+}

instrumentation/hypertrace/github.com/jackc/hyperpgx/options_test.go

@@ -0,0 +1,15 @@
+package hyperpgx // import "github.com/hypertrace/goagent/instrumentation/hypertrace/github.com/jackc/hyperpgx"
+
+import (
+	"testing"
+
+	"github.com/hypertrace/goagent/sdk/filter"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestOptionsToSDK(t *testing.T) {
+	o := &options{
+		Filter: filter.NoopFilter{},
+	}
+	assert.Equal(t, filter.NoopFilter{}, o.toSDKOptions().Filter)
+}

instrumentation/hypertrace/github.com/jackc/hyperpgx/pgx.go

@@ -1,5 +1,16 @@
 package hyperpgx // import "github.com/hypertrace/goagent/instrumentation/hypertrace/github.com/jackc/hyperpgx"
 
-import otelpgx "github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx"
+import (
+	"context"
 
-var Connect = otelpgx.Connect
+	otelpgx "github.com/hypertrace/goagent/instrumentation/opentelemetry/github.com/jackc/hyperpgx"
+)
+
+func Connect(ctx context.Context, connString string, opts ...Option) (otelpgx.PGXConn, error) {
+	o := &options{}
+	for _, opt := range opts {
+		opt(o)
+	}
+
+	return otelpgx.Connect(ctx, connString, o.toSDKOptions())
+}