(feature/all) Extend DialSettings.Validate to support OpenTelemetryOpts

Author: surik

internal/settings.go

@@ -15,6 +15,8 @@ import (
 	"time"
 
 	"cloud.google.com/go/auth"
+	"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
+	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
 	"golang.org/x/oauth2"
 	"golang.org/x/oauth2/google"
 	"google.golang.org/api/internal/impersonate"
@@ -78,7 +80,9 @@ type DialSettings struct {
 	EnableAsyncRefreshDryRun func()
 
 	// otelhttp/otelgrpc options
-	OpenTelemetryOpts []any
+	OpenTelemetryOpts     []any
+	OpenTelemetryOptsGRPC []otelgrpc.Option
+	OpenTelemetryOptsHTTP []otelhttp.Option
 }
 
 // GetScopes returns the user-provided scopes, if set, or else falls back to the
@@ -181,6 +185,16 @@ func (ds *DialSettings) Validate() error {
 	if ds.ImpersonationConfig != nil && len(ds.ImpersonationConfig.Scopes) == 0 && len(ds.Scopes) == 0 {
 		return errors.New("WithImpersonatedCredentials requires scopes being provided")
 	}
+	for _, opt := range ds.OpenTelemetryOpts {
+		switch o := opt.(type) {
+		case otelhttp.Option:
+			ds.OpenTelemetryOptsHTTP = append(ds.OpenTelemetryOptsHTTP, o)
+		case otelgrpc.Option:
+			ds.OpenTelemetryOptsGRPC = append(ds.OpenTelemetryOptsGRPC, o.(otelgrpc.Option))
+		default:
+			return errors.New("WithOpenTelemetryOpts options must be of type otelhttp.Option or otelgrpc.Option")
+		}
+	}
 	return nil
 }
 

internal/settings_test.go

@@ -12,7 +12,10 @@ import (
 
 	"google.golang.org/api/internal/impersonate"
 	"google.golang.org/grpc"
+	"google.golang.org/grpc/stats"
 
+	"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
+	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
 	"golang.org/x/oauth2"
 	"golang.org/x/oauth2/google"
 )
@@ -38,6 +41,13 @@ func TestSettingsValidate(t *testing.T) {
 		{ClientCertSource: dummyGetClientCertificate},
 		{ImpersonationConfig: &impersonate.Config{Scopes: []string{"x"}}},
 		{ImpersonationConfig: &impersonate.Config{}, Scopes: []string{"x"}},
+		{OpenTelemetryOpts: []any{
+			otelgrpc.WithFilter(func(ri *stats.RPCTagInfo) bool {
+				return true
+			}),
+			otelhttp.WithFilter(func(ri *http.Request) bool {
+				return true
+			})}},
 	} {
 		err := ds.Validate()
 		if err != nil {
@@ -67,6 +77,7 @@ func TestSettingsValidate(t *testing.T) {
 		{ClientCertSource: dummyGetClientCertificate, GRPCDialOpts: []grpc.DialOption{grpc.WithInsecure()}},
 		{ClientCertSource: dummyGetClientCertificate, GRPCConnPoolSize: 1},
 		{ImpersonationConfig: &impersonate.Config{}},
+		{OpenTelemetryOpts: []any{"string"}},
 	} {
 		err := ds.Validate()
 		if err == nil {

transport/grpc/dial.go

@@ -400,12 +400,7 @@ func addOpenTelemetryStatsHandler(opts []grpc.DialOption, settings *internal.Dia
 	if settings.TelemetryDisabled {
 		return opts
 	}
-	otelOpts := []otelgrpc.Option{}
-	for _, opt := range settings.OpenTelemetryOpts {
-		if opt, ok := opt.(otelgrpc.Option); ok {
-			otelOpts = append(otelOpts, opt)
-		}
-	}
+	otelOpts := settings.OpenTelemetryOptsGRPC
 	return append(opts, grpc.WithStatsHandler(otelGRPCStatsHandler(otelOpts)))
 }
 

transport/http/dial.go

@@ -306,15 +306,7 @@ func addOpenTelemetryTransport(trans http.RoundTripper, settings *internal.DialS
 	if settings.TelemetryDisabled {
 		return trans
 	}
-
-	opts := []otelhttp.Option{}
-	for _, opt := range settings.OpenTelemetryOpts {
-		if opt, ok := opt.(otelhttp.Option); ok {
-			opts = append(opts, opt)
-		}
-	}
-
-	return otelhttp.NewTransport(trans, opts...)
+	return otelhttp.NewTransport(trans, settings.OpenTelemetryOptsHTTP...)
 }
 
 // clonedTransport returns the given RoundTripper as a cloned *http.Transport.