Merge branch 'main' into PR #4026 to update

Author: lqiu96

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractReadContext.java

@@ -693,17 +693,15 @@ QueryOptions buildQueryOptions(QueryOptions requestOptions) {
   }
 
   RequestOptions buildRequestOptions(Options options) {
-    // Shortcut for the most common return value.
-    if (!(options.hasPriority() || options.hasTag() || getTransactionTag() != null)) {
-      return RequestOptions.getDefaultInstance();
-    }
-
-    RequestOptions.Builder builder = RequestOptions.newBuilder();
-    if (options.hasPriority()) {
-      builder.setPriority(options.priority());
-    }
-    if (options.hasTag()) {
-      builder.setRequestTag(options.tag());
+    RequestOptions.Builder builder = options.toRequestOptionsProto(false).toBuilder();
+    RequestOptions.ClientContext defaultClientContext =
+        session.getSpanner().getOptions().getClientContext();
+    if (defaultClientContext != null) {
+      RequestOptions.ClientContext.Builder clientContextBuilder = defaultClientContext.toBuilder();
+      if (builder.hasClientContext()) {
+        clientContextBuilder.mergeFrom(builder.getClientContext());
+      }
+      builder.setClientContext(clientContextBuilder.build());
     }
     if (getTransactionTag() != null) {
       builder.setTransactionTag(getTransactionTag());

google-cloud-spanner/src/main/java/com/google/cloud/spanner/Options.java

@@ -20,6 +20,7 @@
 import com.google.spanner.v1.DirectedReadOptions;
 import com.google.spanner.v1.ReadRequest.LockHint;
 import com.google.spanner.v1.ReadRequest.OrderBy;
+import com.google.spanner.v1.RequestOptions;
 import com.google.spanner.v1.RequestOptions.Priority;
 import com.google.spanner.v1.TransactionOptions.IsolationLevel;
 import com.google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode;
@@ -265,6 +266,37 @@ public static ReadQueryUpdateTransactionOption priority(RpcPriority priority) {
     return new PriorityOption(priority);
   }
 
+  /**
+   * Specifying this will add the given client context to the request. The client context is used to
+   * pass side-channel or configuration information to the backend, such as a user ID for a
+   * parameterized secure view.
+   */
+  public static ReadQueryUpdateTransactionOption clientContext(
+      RequestOptions.ClientContext clientContext) {
+    return new ClientContextOption(clientContext);
+  }
+
+  RequestOptions toRequestOptionsProto(boolean isTransactionOption) {
+    if (!hasPriority() && !hasTag() && !hasClientContext()) {
+      return RequestOptions.getDefaultInstance();
+    }
+    RequestOptions.Builder builder = RequestOptions.newBuilder();
+    if (hasPriority()) {
+      builder.setPriority(priority());
+    }
+    if (hasTag()) {
+      if (isTransactionOption) {
+        builder.setTransactionTag(tag());
+      } else {
+        builder.setRequestTag(tag());
+      }
+    }
+    if (hasClientContext()) {
+      builder.setClientContext(clientContext());
+    }
+    return builder.build();
+  }
+
   public static TransactionOption maxCommitDelay(Duration maxCommitDelay) {
     Preconditions.checkArgument(!maxCommitDelay.isNegative(), "maxCommitDelay should be positive");
     return new MaxCommitDelayOption(maxCommitDelay);
@@ -462,6 +494,20 @@ void appendToOptions(Options options) {
     }
   }
 
+  static final class ClientContextOption extends InternalOption
+      implements ReadQueryUpdateTransactionOption {
+    private final RequestOptions.ClientContext clientContext;
+
+    ClientContextOption(RequestOptions.ClientContext clientContext) {
+      this.clientContext = clientContext;
+    }
+
+    @Override
+    void appendToOptions(Options options) {
+      options.clientContext = clientContext;
+    }
+  }
+
   static final class TagOption extends InternalOption implements ReadQueryUpdateTransactionOption {
     private final String tag;
 
@@ -574,6 +620,7 @@ void appendToOptions(Options options) {
   private String filter;
   private RpcPriority priority;
   private String tag;
+  private RequestOptions.ClientContext clientContext;
   private String etag;
   private Boolean validateOnly;
   private Boolean withExcludeTxnFromChangeStreams;
@@ -666,6 +713,14 @@ Priority priority() {
     return priority == null ? null : priority.proto;
   }
 
+  boolean hasClientContext() {
+    return clientContext != null;
+  }
+
+  RequestOptions.ClientContext clientContext() {
+    return clientContext;
+  }
+
   boolean hasTag() {
     return tag != null;
   }
@@ -777,6 +832,9 @@ public String toString() {
     if (priority != null) {
       b.append("priority: ").append(priority).append(' ');
     }
+    if (clientContext != null) {
+      b.append("clientContext: ").append(clientContext).append(' ');
+    }
     if (tag != null) {
       b.append("tag: ").append(tag).append(' ');
     }
@@ -850,6 +908,7 @@ public boolean equals(Object o) {
         && Objects.equals(pageToken(), that.pageToken())
         && Objects.equals(filter(), that.filter())
         && Objects.equals(priority(), that.priority())
+        && Objects.equals(clientContext(), that.clientContext())
         && Objects.equals(tag(), that.tag())
         && Objects.equals(etag(), that.etag())
         && Objects.equals(validateOnly(), that.validateOnly())
@@ -894,6 +953,9 @@ public int hashCode() {
     if (priority != null) {
       result = 31 * result + priority.hashCode();
     }
+    if (clientContext != null) {
+      result = 31 * result + clientContext.hashCode();
+    }
     if (tag != null) {
       result = 31 * result + tag.hashCode();
     }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java

@@ -32,7 +32,6 @@
 import com.google.cloud.spanner.SessionClient.SessionOption;
 import com.google.cloud.spanner.TransactionRunnerImpl.TransactionContextImpl;
 import com.google.cloud.spanner.spi.v1.SpannerRpc;
-import com.google.common.base.Strings;
 import com.google.common.base.Ticker;
 import com.google.common.collect.Lists;
 import com.google.common.util.concurrent.MoreExecutors;
@@ -182,6 +181,10 @@ ErrorHandler getErrorHandler() {
     return this.errorHandler;
   }
 
+  SpannerImpl getSpanner() {
+    return spanner;
+  }
+
   void setCurrentSpan(ISpan span) {
     currentSpan = span;
   }
@@ -486,9 +489,22 @@ ApiFuture<Transaction> beginTransactionAsync(
     if (sessionReference.getIsMultiplexed() && mutation != null) {
       requestBuilder.setMutationKey(mutation);
     }
-    if (sessionReference.getIsMultiplexed() && !Strings.isNullOrEmpty(transactionOptions.tag())) {
-      requestBuilder.setRequestOptions(
-          RequestOptions.newBuilder().setTransactionTag(transactionOptions.tag()).build());
+    RequestOptions.Builder optionsBuilder =
+        transactionOptions.toRequestOptionsProto(true).toBuilder();
+    RequestOptions.ClientContext defaultClientContext = spanner.getOptions().getClientContext();
+    if (defaultClientContext != null) {
+      RequestOptions.ClientContext.Builder builder = defaultClientContext.toBuilder();
+      if (optionsBuilder.hasClientContext()) {
+        builder.mergeFrom(optionsBuilder.getClientContext());
+      }
+      optionsBuilder.setClientContext(builder.build());
+    }
+    if (!sessionReference.getIsMultiplexed()) {
+      optionsBuilder.clearTransactionTag();
+    }
+    RequestOptions requestOptions = optionsBuilder.build();
+    if (!requestOptions.equals(RequestOptions.getDefaultInstance())) {
+      requestBuilder.setRequestOptions(requestOptions);
     }
     final BeginTransactionRequest request = requestBuilder.build();
     final ApiFuture<Transaction> requestFuture;

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

@@ -68,6 +68,7 @@
 import com.google.spanner.v1.DirectedReadOptions;
 import com.google.spanner.v1.ExecuteSqlRequest;
 import com.google.spanner.v1.ExecuteSqlRequest.QueryOptions;
+import com.google.spanner.v1.RequestOptions;
 import com.google.spanner.v1.SpannerGrpc;
 import com.google.spanner.v1.TransactionOptions;
 import com.google.spanner.v1.TransactionOptions.IsolationLevel;
@@ -227,6 +228,7 @@ public static GcpChannelPoolOptions createDefaultDynamicChannelPoolOptions() {
   private final boolean autoThrottleAdministrativeRequests;
   private final RetrySettings retryAdministrativeRequestsSettings;
   private final boolean trackTransactionStarter;
+  private final boolean enableGrpcGcpOtelMetrics;
   private final BuiltInMetricsProvider builtInMetricsProvider = BuiltInMetricsProvider.INSTANCE;
 
   /**
@@ -259,6 +261,7 @@ public static GcpChannelPoolOptions createDefaultDynamicChannelPoolOptions() {
   private final boolean enableEndToEndTracing;
   private final String monitoringHost;
   private final TransactionOptions defaultTransactionOptions;
+  private final RequestOptions.ClientContext clientContext;
 
   enum TracingFramework {
     OPEN_CENSUS,
@@ -895,6 +898,7 @@ protected SpannerOptions(Builder builder) {
     autoThrottleAdministrativeRequests = builder.autoThrottleAdministrativeRequests;
     retryAdministrativeRequestsSettings = builder.retryAdministrativeRequestsSettings;
     trackTransactionStarter = builder.trackTransactionStarter;
+    enableGrpcGcpOtelMetrics = builder.enableGrpcGcpOtelMetrics;
     defaultQueryOptions = builder.defaultQueryOptions;
     envQueryOptions = builder.getEnvironmentQueryOptions();
     if (envQueryOptions.equals(QueryOptions.getDefaultInstance())) {
@@ -925,13 +929,19 @@ protected SpannerOptions(Builder builder) {
     enableEndToEndTracing = builder.enableEndToEndTracing;
     monitoringHost = builder.monitoringHost;
     defaultTransactionOptions = builder.defaultTransactionOptions;
+    clientContext = builder.clientContext;
   }
 
   private String getResolvedUniverseDomain() {
     String universeDomain = getUniverseDomain();
     return Strings.isNullOrEmpty(universeDomain) ? GOOGLE_DEFAULT_UNIVERSE : universeDomain;
   }
 
+  /** Returns the default {@link RequestOptions.ClientContext} for this {@link SpannerOptions}. */
+  public RequestOptions.ClientContext getClientContext() {
+    return clientContext;
+  }
+
   /**
    * The environment to read configuration values from. The default implementation uses environment
    * variables.
@@ -975,6 +985,10 @@ default boolean isEnableGRPCBuiltInMetrics() {
       return false;
     }
 
+    default boolean isEnableGrpcGcpOtelMetrics() {
+      return true;
+    }
+
     default boolean isEnableEndToEndTracing() {
       return false;
     }
@@ -1013,6 +1027,8 @@ private static class SpannerEnvironmentImpl implements SpannerEnvironment {
     private static final String SPANNER_DISABLE_BUILTIN_METRICS = "SPANNER_DISABLE_BUILTIN_METRICS";
     private static final String SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS =
         "SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS";
+    private static final String SPANNER_DISABLE_GRPC_GCP_OTEL_METRICS =
+        "SPANNER_DISABLE_GRPC_GCP_OTEL_METRICS";
     private static final String SPANNER_MONITORING_HOST = "SPANNER_MONITORING_HOST";
 
     private SpannerEnvironmentImpl() {}
@@ -1058,6 +1074,11 @@ public boolean isEnableGRPCBuiltInMetrics() {
           System.getenv(SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS));
     }
 
+    @Override
+    public boolean isEnableGrpcGcpOtelMetrics() {
+      return !Boolean.parseBoolean(System.getenv(SPANNER_DISABLE_GRPC_GCP_OTEL_METRICS));
+    }
+
     @Override
     public boolean isEnableEndToEndTracing() {
       return Boolean.parseBoolean(System.getenv(SPANNER_ENABLE_END_TO_END_TRACING));
@@ -1128,6 +1149,8 @@ public static class Builder
     private boolean autoThrottleAdministrativeRequests = false;
     private boolean trackTransactionStarter = false;
     private Map<DatabaseId, QueryOptions> defaultQueryOptions = new HashMap<>();
+    private boolean enableGrpcGcpOtelMetrics =
+        SpannerOptions.environment.isEnableGrpcGcpOtelMetrics();
     private CallCredentialsProvider callCredentialsProvider;
     private CloseableExecutorProvider asyncExecutorProvider;
     private String compressorName;
@@ -1146,6 +1169,7 @@ public static class Builder
     private String experimentalHost = null;
     private boolean usePlainText = false;
     private TransactionOptions defaultTransactionOptions = TransactionOptions.getDefaultInstance();
+    private RequestOptions.ClientContext clientContext;
 
     private static String createCustomClientLibToken(String token) {
       return token + " " + ServiceOptions.getGoogApiClientLibName();
@@ -1231,6 +1255,7 @@ protected Builder() {
       this.autoThrottleAdministrativeRequests = options.autoThrottleAdministrativeRequests;
       this.retryAdministrativeRequestsSettings = options.retryAdministrativeRequestsSettings;
       this.trackTransactionStarter = options.trackTransactionStarter;
+      this.enableGrpcGcpOtelMetrics = options.enableGrpcGcpOtelMetrics;
       this.defaultQueryOptions = options.defaultQueryOptions;
       this.callCredentialsProvider = options.callCredentialsProvider;
       this.asyncExecutorProvider = options.asyncExecutorProvider;
@@ -1248,6 +1273,7 @@ protected Builder() {
       this.enableEndToEndTracing = options.enableEndToEndTracing;
       this.monitoringHost = options.monitoringHost;
       this.defaultTransactionOptions = options.defaultTransactionOptions;
+      this.clientContext = options.clientContext;
     }
 
     @Override
@@ -1750,6 +1776,17 @@ public Builder disableDynamicChannelPool() {
       return this;
     }
 
+    /**
+     * Sets whether to enable or disable grpc-gcp OpenTelemetry metrics injection. When disabled,
+     * Spanner will not automatically inject an OpenTelemetry {@link
+     * io.opentelemetry.api.metrics.Meter} into grpc-gcp. If a Meter or MetricRegistry is explicitly
+     * provided via {@link GcpManagedChannelOptions}, those settings will still be honored.
+     */
+    public Builder setGrpcGcpOtelMetricsEnabled(boolean enableGrpcGcpOtelMetrics) {
+      this.enableGrpcGcpOtelMetrics = enableGrpcGcpOtelMetrics;
+      return this;
+    }
+
     /**
      * Sets the channel pool options for dynamic channel pooling. Use this to configure the dynamic
      * channel pool behavior when {@link #enableDynamicChannelPool()} is enabled.
@@ -1989,6 +2026,12 @@ public Builder setDefaultTransactionOptions(
       return this;
     }
 
+    /** Sets the default {@link RequestOptions.ClientContext} for all requests. */
+    public Builder setDefaultClientContext(RequestOptions.ClientContext clientContext) {
+      this.clientContext = clientContext;
+      return this;
+    }
+
     @SuppressWarnings("rawtypes")
     @Override
     public SpannerOptions build() {
@@ -2211,6 +2254,10 @@ public boolean isGrpcGcpExtensionEnabled() {
     return grpcGcpExtensionEnabled;
   }
 
+  public boolean isGrpcGcpOtelMetricsEnabled() {
+    return enableGrpcGcpOtelMetrics;
+  }
+
   public GcpManagedChannelOptions getGrpcGcpOptions() {
     return grpcGcpOptions;
   }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java

@@ -464,15 +464,9 @@ public void run() {
                         waitForTransactionTimeoutMillis, TimeUnit.MILLISECONDS)
                     : transactionId);
           }
-          if (options.hasPriority() || getTransactionTag() != null) {
-            RequestOptions.Builder requestOptionsBuilder = RequestOptions.newBuilder();
-            if (options.hasPriority()) {
-              requestOptionsBuilder.setPriority(options.priority());
-            }
-            if (getTransactionTag() != null) {
-              requestOptionsBuilder.setTransactionTag(getTransactionTag());
-            }
-            requestBuilder.setRequestOptions(requestOptionsBuilder.build());
+          RequestOptions requestOptions = options.toRequestOptionsProto(true);
+          if (!requestOptions.equals(RequestOptions.getDefaultInstance())) {
+            requestBuilder.setRequestOptions(requestOptions);
           }
           if (session.getIsMultiplexed() && getLatestPrecommitToken() != null) {
             // Set the precommit token in the CommitRequest for multiplexed sessions.