chore(Datastore): Enable default client-side metrics to be set to Cloud Monitoring

Author: lqiu96

java-datastore/google-cloud-datastore/pom.xml

@@ -140,6 +140,28 @@
       <groupId>io.opentelemetry.instrumentation</groupId>
       <artifactId>opentelemetry-grpc-1.6</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-common</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-metrics</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-monitoring</artifactId>
+      <version>3.90.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-monitoring:current} -->
+    </dependency>
+    <dependency>
+      <groupId>com.google.api.grpc</groupId>
+      <artifactId>proto-google-cloud-monitoring-v3</artifactId>
+      <version>3.90.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-monitoring:current} -->
+    </dependency>
 
     <dependency>
       <groupId>${project.groupId}</groupId>
@@ -193,16 +215,6 @@
       <version>1.17</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk</artifactId>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk-common</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk-testing</artifactId>
@@ -213,11 +225,6 @@
       <artifactId>opentelemetry-sdk-trace</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk-metrics</artifactId>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-semconv</artifactId>

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/DatastoreImpl.java

@@ -53,7 +53,6 @@
 import com.google.cloud.datastore.telemetry.TelemetryUtils;
 import com.google.cloud.datastore.telemetry.TraceUtil;
 import com.google.cloud.datastore.telemetry.TraceUtil.Scope;
-import com.google.cloud.http.HttpTransportOptions;
 import com.google.common.base.MoreObjects;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Stopwatch;
@@ -102,15 +101,12 @@ final class DatastoreImpl extends BaseService<DatastoreOptions> implements Datas
   private final com.google.cloud.datastore.telemetry.TraceUtil otelTraceUtil =
       getOptions().getTraceUtil();
   private final MetricsRecorder metricsRecorder = getOptions().getMetricsRecorder();
-  private final boolean isHttpTransport;
-
   private final ReadOptionProtoPreparer readOptionProtoPreparer;
   private final AggregationQueryExecutor aggregationQueryExecutor;
 
   DatastoreImpl(DatastoreOptions options) {
     super(options);
     this.datastoreRpc = options.getDatastoreRpcV1();
-    this.isHttpTransport = options.getTransportOptions() instanceof HttpTransportOptions;
     retrySettings =
         MoreObjects.firstNonNull(options.getRetrySettings(), ServiceOptions.getNoRetrySettings());
 
@@ -805,15 +801,12 @@ private <T> T runWithObservability(
       ResultRetryAlgorithm<?> exceptionHandler) {
     com.google.cloud.datastore.telemetry.TraceUtil.Span span = otelTraceUtil.startSpan(spanName);
 
-    // Gax already records operation and attempt metrics. Since Datastore HttpJson does not
-    // integrate with Gax, manually instrument these metrics when using HttpJson for parity
-    Stopwatch operationStopwatch = isHttpTransport ? Stopwatch.createStarted() : null;
+    Stopwatch operationStopwatch = Stopwatch.createStarted();
     String operationStatus = StatusCode.Code.OK.toString();
 
     DatastoreOptions options = getOptions();
     Callable<T> attemptCallable =
-        TelemetryUtils.attemptMetricsCallable(
-            callable, metricsRecorder, options, isHttpTransport, methodName);
+        TelemetryUtils.attemptMetricsCallable(callable, metricsRecorder, options, methodName);
     try (TraceUtil.Scope ignored = span.makeCurrent()) {
       return RetryHelper.runWithRetries(
           attemptCallable, retrySettings, exceptionHandler, options.getClock());
@@ -823,12 +816,7 @@ private <T> T runWithObservability(
       throw DatastoreException.translateAndThrow(e);
     } finally {
       TelemetryUtils.recordOperationMetrics(
-          metricsRecorder,
-          options,
-          isHttpTransport,
-          operationStopwatch,
-          methodName,
-          operationStatus);
+          metricsRecorder, options, operationStopwatch, methodName, operationStatus);
       span.end();
     }
   }

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/DatastoreOpenTelemetryOptions.java

@@ -20,14 +20,21 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+/**
+ * Represents the options that are used to configure the use of OpenTelemetry for telemetry
+ * collection in the Datastore SDK.
+ */
 public class DatastoreOpenTelemetryOptions {
   private final boolean tracingEnabled;
   private final boolean metricsEnabled;
+  private final boolean exportBuiltinMetricsToGoogleCloudMonitoring;
   private final @Nullable OpenTelemetry openTelemetry;
 
   DatastoreOpenTelemetryOptions(Builder builder) {
     this.tracingEnabled = builder.tracingEnabled;
     this.metricsEnabled = builder.metricsEnabled;
+    this.exportBuiltinMetricsToGoogleCloudMonitoring =
+        builder.exportBuiltinMetricsToGoogleCloudMonitoring;
     this.openTelemetry = builder.openTelemetry;
   }
 
@@ -50,24 +57,53 @@ public boolean isTracingEnabled() {
   }
 
   /**
-   * Returns whether metrics are enabled.
+   * Returns whether metrics are enabled for the custom (user-provided) OpenTelemetry backend.
    *
    * @return {@code true} if metrics are enabled, {@code false} otherwise.
    */
   public boolean isMetricsEnabled() {
     return metricsEnabled;
   }
 
+  /**
+   * Returns whether built-in metrics should be exported to Google Cloud Monitoring.
+   *
+   * <p>When enabled, client-side metrics are automatically exported to Google Cloud Monitoring using
+   * the Cloud Monitoring API. This is independent of the custom OpenTelemetry backend configured via
+   * {@link #getOpenTelemetry()}.
+   *
+   * @return {@code true} if built-in metrics export to Cloud Monitoring is enabled, {@code false}
+   *     otherwise.
+   */
+  public boolean isExportBuiltinMetricsToGoogleCloudMonitoring() {
+    return exportBuiltinMetricsToGoogleCloudMonitoring;
+  }
+
+  /**
+   * Returns the custom {@link OpenTelemetry} instance, if one was provided.
+   *
+   * @return the custom {@link OpenTelemetry} instance, or {@code null} if none was provided.
+   */
   @Nullable
   public OpenTelemetry getOpenTelemetry() {
     return openTelemetry;
   }
 
+  /**
+   * Returns a new {@link Builder} initialized with the values from this options instance.
+   *
+   * @return a new {@link Builder}.
+   */
   @Nonnull
   public DatastoreOpenTelemetryOptions.Builder toBuilder() {
     return new DatastoreOpenTelemetryOptions.Builder(this);
   }
 
+  /**
+   * Returns a new default {@link Builder}.
+   *
+   * @return a new {@link Builder}.
+   */
   @Nonnull
   public static DatastoreOpenTelemetryOptions.Builder newBuilder() {
     return new DatastoreOpenTelemetryOptions.Builder();
@@ -77,25 +113,30 @@ public static class Builder {
 
     private boolean tracingEnabled;
     private boolean metricsEnabled;
+    private boolean exportBuiltinMetricsToGoogleCloudMonitoring;
 
     @Nullable private OpenTelemetry openTelemetry;
 
     private Builder() {
       tracingEnabled = false;
       metricsEnabled = false;
+      exportBuiltinMetricsToGoogleCloudMonitoring = true;
       openTelemetry = null;
     }
 
     private Builder(DatastoreOpenTelemetryOptions options) {
       this.tracingEnabled = options.tracingEnabled;
       this.metricsEnabled = options.metricsEnabled;
+      this.exportBuiltinMetricsToGoogleCloudMonitoring =
+          options.exportBuiltinMetricsToGoogleCloudMonitoring;
       this.openTelemetry = options.openTelemetry;
     }
 
     /**
      * Sets whether tracing should be enabled.
      *
      * @param enabled Whether tracing should be enabled.
+     * @return this builder instance.
      */
     @Nonnull
     public DatastoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enabled) {
@@ -104,23 +145,42 @@ public DatastoreOpenTelemetryOptions.Builder setTracingEnabled(boolean enabled)
     }
 
     /**
-     * Sets whether metrics should be enabled.
+     * Sets whether metrics should be enabled for the custom (user-provided) OpenTelemetry backend.
      *
      * @param enabled Whether metrics should be enabled.
-     * @return the builder instance.
+     * @return this builder instance.
      */
     @Nonnull
     DatastoreOpenTelemetryOptions.Builder setMetricsEnabled(boolean enabled) {
       this.metricsEnabled = enabled;
       return this;
     }
 
+    /**
+     * Sets whether built-in metrics should be exported to Google Cloud Monitoring.
+     *
+     * <p>When enabled (the default), client-side metrics are automatically exported to Google Cloud
+     * Monitoring using the Cloud Monitoring API. This can be disabled to prevent metrics from being
+     * sent to Cloud Monitoring while still allowing metrics to flow to a custom OpenTelemetry
+     * backend.
+     *
+     * @param exportBuiltinMetrics Whether built-in metrics should be exported to Cloud Monitoring.
+     * @return this builder instance.
+     */
+    @Nonnull
+    public DatastoreOpenTelemetryOptions.Builder setExportBuiltinMetricsToGoogleCloudMonitoring(
+        boolean exportBuiltinMetrics) {
+      this.exportBuiltinMetricsToGoogleCloudMonitoring = exportBuiltinMetrics;
+      return this;
+    }
+
     /**
      * Sets the {@link OpenTelemetry} to use with this Datastore instance. If telemetry collection
-     * is enabled, but an `OpenTelemetry` is not provided, the Datastore SDK will attempt to use the
-     * `GlobalOpenTelemetry`.
+     * is enabled, but an {@code OpenTelemetry} is not provided, the Datastore SDK will attempt to
+     * use the {@code GlobalOpenTelemetry}.
      *
      * @param openTelemetry The OpenTelemetry that should be used by this Datastore instance.
+     * @return this builder instance.
      */
     @Nonnull
     public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(
@@ -129,6 +189,11 @@ public DatastoreOpenTelemetryOptions.Builder setOpenTelemetry(
       return this;
     }
 
+    /**
+     * Builds a new {@link DatastoreOpenTelemetryOptions} instance from this builder.
+     *
+     * @return a new {@link DatastoreOpenTelemetryOptions}.
+     */
     @Nonnull
     public DatastoreOpenTelemetryOptions build() {
       return new DatastoreOpenTelemetryOptions(this);

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/DatastoreOptions.java

@@ -223,7 +223,7 @@ private DatastoreOptions(Builder builder) {
             ? builder.openTelemetryOptions
             : DatastoreOpenTelemetryOptions.newBuilder().build();
     this.traceUtil = com.google.cloud.datastore.telemetry.TraceUtil.getInstance(this);
-    this.metricsRecorder = MetricsRecorder.getInstance(openTelemetryOptions);
+    this.metricsRecorder = MetricsRecorder.getInstance(this);
 
     namespace = MoreObjects.firstNonNull(builder.namespace, defaultNamespace());
     databaseId = MoreObjects.firstNonNull(builder.databaseId, DEFAULT_DATABASE_ID);

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/RetryAndTraceDatastoreRpcDecorator.java

@@ -29,7 +29,6 @@
 import com.google.cloud.datastore.telemetry.TelemetryConstants;
 import com.google.cloud.datastore.telemetry.TelemetryUtils;
 import com.google.cloud.datastore.telemetry.TraceUtil;
-import com.google.cloud.http.HttpTransportOptions;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Stopwatch;
 import com.google.datastore.v1.AllocateIdsRequest;
@@ -63,7 +62,6 @@ public class RetryAndTraceDatastoreRpcDecorator implements DatastoreRpc {
   private final RetrySettings retrySettings;
   private final DatastoreOptions datastoreOptions;
   private final MetricsRecorder metricsRecorder;
-  private final boolean isHttpTransport;
 
   @ObsoleteApi("Prefer to create RetryAndTraceDatastoreRpcDecorator via the Builder")
   public RetryAndTraceDatastoreRpcDecorator(
@@ -76,7 +74,6 @@ public RetryAndTraceDatastoreRpcDecorator(
     this.datastoreOptions = datastoreOptions;
     this.otelTraceUtil = otelTraceUtil;
     this.metricsRecorder = new NoOpMetricsRecorder();
-    this.isHttpTransport = datastoreOptions.getTransportOptions() instanceof HttpTransportOptions;
   }
 
   private RetryAndTraceDatastoreRpcDecorator(Builder builder) {
@@ -85,7 +82,6 @@ private RetryAndTraceDatastoreRpcDecorator(Builder builder) {
     this.retrySettings = builder.retrySettings;
     this.datastoreOptions = builder.datastoreOptions;
     this.metricsRecorder = builder.metricsRecorder;
-    this.isHttpTransport = builder.isHttpTransport;
   }
 
   public static Builder newBuilder() {
@@ -100,7 +96,6 @@ public static class Builder {
 
     // Defaults configured for this class
     private MetricsRecorder metricsRecorder = new NoOpMetricsRecorder();
-    private boolean isHttpTransport = false;
 
     private Builder() {}
 
@@ -135,7 +130,6 @@ public RetryAndTraceDatastoreRpcDecorator build() {
       Preconditions.checkNotNull(otelTraceUtil, "otelTraceUtil is required");
       Preconditions.checkNotNull(retrySettings, "retrySettings is required");
       Preconditions.checkNotNull(datastoreOptions, "datastoreOptions is required");
-      this.isHttpTransport = datastoreOptions.getTransportOptions() instanceof HttpTransportOptions;
       return new RetryAndTraceDatastoreRpcDecorator(this);
     }
   }
@@ -207,12 +201,12 @@ public <O> O invokeRpc(Callable<O> block, String startSpan) {
 
   <O> O invokeRpc(Callable<O> block, String startSpan, String methodName) {
     TraceUtil.Span span = otelTraceUtil.startSpan(startSpan);
-    Stopwatch stopwatch = isHttpTransport ? Stopwatch.createStarted() : null;
+    Stopwatch stopwatch = Stopwatch.createStarted();
     String operationStatus = StatusCode.Code.UNKNOWN.toString();
     try (TraceUtil.Scope ignored = span.makeCurrent()) {
       Callable<O> callable =
           TelemetryUtils.attemptMetricsCallable(
-              block, metricsRecorder, datastoreOptions, isHttpTransport, methodName);
+              block, metricsRecorder, datastoreOptions, methodName);
       O result =
           RetryHelper.runWithRetries(
               callable, this.retrySettings, EXCEPTION_HANDLER, this.datastoreOptions.getClock());
@@ -224,12 +218,7 @@ <O> O invokeRpc(Callable<O> block, String startSpan, String methodName) {
       throw DatastoreException.translateAndThrow(e);
     } finally {
       TelemetryUtils.recordOperationMetrics(
-          metricsRecorder,
-          datastoreOptions,
-          isHttpTransport,
-          stopwatch,
-          methodName,
-          operationStatus);
+          metricsRecorder, datastoreOptions, stopwatch, methodName, operationStatus);
       span.end();
     }
   }