grpc metrics env check

Author: surbhigarg92

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

@@ -849,6 +849,10 @@ default boolean isEnableBuiltInMetrics() {
       return true;
     }
 
+    default boolean isEnableGRPCBuiltInMetrics() {
+      return false;
+    }
+
     default boolean isEnableEndToEndTracing() {
       return false;
     }
@@ -879,6 +883,8 @@ private static class SpannerEnvironmentImpl implements SpannerEnvironment {
     private static final String SPANNER_ENABLE_END_TO_END_TRACING =
         "SPANNER_ENABLE_END_TO_END_TRACING";
     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_MONITORING_HOST = "SPANNER_MONITORING_HOST";
 
     private SpannerEnvironmentImpl() {}
@@ -911,6 +917,12 @@ public boolean isEnableBuiltInMetrics() {
       return !Boolean.parseBoolean(System.getenv(SPANNER_DISABLE_BUILTIN_METRICS));
     }
 
+    @Override
+    public boolean isEnableGRPCBuiltInMetrics() {
+      return !Boolean.parseBoolean(
+          System.getenv(SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS));
+    }
+
     @Override
     public boolean isEnableEndToEndTracing() {
       return Boolean.parseBoolean(System.getenv(SPANNER_ENABLE_END_TO_END_TRACING));
@@ -1973,8 +1985,10 @@ public ApiTracerFactory getApiTracerFactory() {
   }
 
   public void enablegRPCMetrics(InstantiatingGrpcChannelProvider.Builder channelProviderBuilder) {
-    this.builtInMetricsProvider.enableGrpcMetrics(
-        channelProviderBuilder, this.getProjectId(), getCredentials(), this.monitoringHost);
+    if (SpannerOptions.environment.isEnableGRPCBuiltInMetrics()) {
+      this.builtInMetricsProvider.enableGrpcMetrics(
+          channelProviderBuilder, this.getProjectId(), getCredentials(), this.monitoringHost);
+    }
   }
 
   public ApiTracerFactory getApiTracerFactory(boolean isAdminClient, boolean isEmulatorEnabled) {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java

@@ -374,10 +374,8 @@ public GapicSpannerRpc(final SpannerOptions options) {
         defaultChannelProviderBuilder.setAttemptDirectPathXds();
       }
 
-      // Use condition to enable gRPC metrics
-      if (true) {
-        options.enablegRPCMetrics(defaultChannelProviderBuilder);
-      }
+      options.enablegRPCMetrics(defaultChannelProviderBuilder);
+
       if (options.isUseVirtualThreads()) {
         ExecutorService executor =
             tryCreateVirtualThreadPerTaskExecutor("spanner-virtual-grpc-executor");

google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBuiltInMetricsTest.java

@@ -17,13 +17,15 @@
 package com.google.cloud.spanner.it;
 
 import static com.google.common.truth.Truth.assertWithMessage;
+import static org.junit.Assume.assumeFalse;
 
 import com.google.cloud.monitoring.v3.MetricServiceClient;
 import com.google.cloud.spanner.Database;
 import com.google.cloud.spanner.DatabaseClient;
 import com.google.cloud.spanner.IntegrationTestEnv;
 import com.google.cloud.spanner.ParallelIntegrationTest;
 import com.google.cloud.spanner.Statement;
+import com.google.cloud.spanner.testing.EmulatorSpannerHelper;
 import com.google.common.base.Stopwatch;
 import com.google.monitoring.v3.ListTimeSeriesRequest;
 import com.google.monitoring.v3.ListTimeSeriesResponse;
@@ -34,6 +36,7 @@
 import java.time.Duration;
 import java.time.Instant;
 import java.util.concurrent.TimeUnit;
+import org.junit.After;
 import org.junit.BeforeClass;
 import org.junit.ClassRule;
 import org.junit.Test;
@@ -43,7 +46,6 @@
 
 @Category(ParallelIntegrationTest.class)
 @RunWith(JUnit4.class)
-// @Ignore("Built-in Metrics are not GA'ed yet. Enable this test once the metrics are released")
 public class ITBuiltInMetricsTest {
 
   private static Database db;
@@ -53,6 +55,10 @@ public class ITBuiltInMetricsTest {
 
   private static MetricServiceClient metricClient;
 
+  private static String[] METRICS = {
+    "operation_latencies", "attempt_latencies", "operation_count", "attempt_count",
+  };
+
   @BeforeClass
   public static void setUp() throws IOException {
     metricClient = MetricServiceClient.create();
@@ -61,8 +67,16 @@ public static void setUp() throws IOException {
     client = env.getTestHelper().getDatabaseClient(db);
   }
 
+  @After
+  public void tearDown() {
+    if (metricClient != null) {
+      metricClient.close();
+    }
+  }
+
   @Test
   public void testBuiltinMetricsWithDefaultOTEL() throws Exception {
+    assumeFalse("This test requires credentials", EmulatorSpannerHelper.isUsingEmulator());
     // This stopwatch is used for to limit fetching of metric data in verifyMetrics
     Stopwatch metricsPollingStopwatch = Stopwatch.createStarted();
     Instant start = Instant.now().minus(Duration.ofMinutes(2));
@@ -79,36 +93,36 @@ public void testBuiltinMetricsWithDefaultOTEL() throws Exception {
         .readWriteTransaction()
         .run(transaction -> transaction.executeQuery(Statement.of("Select 1")));
 
-    String metricFilter =
-        String.format(
-            "metric.type=\"spanner.googleapis.com/client/%s\""
-                + " AND resource.type=\"spanner_instance\""
-                + " AND metric.labels.method=\"Spanner.Commit\""
-                + " AND resource.labels.instance_id=\"%s\""
-                + " AND metric.labels.database=\"%s\"",
-            "operation_latencies",
-            db.getId().getInstanceId().getInstance(),
-            db.getId().getDatabase());
-
-    ListTimeSeriesRequest.Builder requestBuilder =
-        ListTimeSeriesRequest.newBuilder()
-            .setName(name.toString())
-            .setFilter(metricFilter)
-            .setInterval(interval)
-            .setView(ListTimeSeriesRequest.TimeSeriesView.FULL);
-
-    ListTimeSeriesRequest request = requestBuilder.build();
-
-    ListTimeSeriesResponse response = metricClient.listTimeSeriesCallable().call(request);
-    while (response.getTimeSeriesCount() == 0
-        && metricsPollingStopwatch.elapsed(TimeUnit.MINUTES) < 3) {
-      // Call listTimeSeries every minute
-      Thread.sleep(Duration.ofMinutes(1).toMillis());
-      response = metricClient.listTimeSeriesCallable().call(request);
+    for (String metric : METRICS) {
+      String metricFilter =
+          String.format(
+              "metric.type=\"spanner.googleapis.com/client/%s\""
+                  + " AND resource.type=\"spanner_instance\""
+                  + " AND metric.labels.method=\"Spanner.Commit\""
+                  + " AND resource.labels.instance_id=\"%s\""
+                  + " AND metric.labels.database=\"%s\"",
+              metric, db.getId().getInstanceId().getInstance(), db.getId().getDatabase());
+
+      ListTimeSeriesRequest.Builder requestBuilder =
+          ListTimeSeriesRequest.newBuilder()
+              .setName(name.toString())
+              .setFilter(metricFilter)
+              .setInterval(interval)
+              .setView(ListTimeSeriesRequest.TimeSeriesView.FULL);
+
+      ListTimeSeriesRequest request = requestBuilder.build();
+
+      ListTimeSeriesResponse response = metricClient.listTimeSeriesCallable().call(request);
+      while (response.getTimeSeriesCount() == 0
+          && metricsPollingStopwatch.elapsed(TimeUnit.MINUTES) < 3) {
+        // Call listTimeSeries every minute
+        Thread.sleep(Duration.ofMinutes(1).toMillis());
+        response = metricClient.listTimeSeriesCallable().call(request);
+      }
+
+      assertWithMessage("Metric" + metric + "didn't return any data.")
+          .that(response.getTimeSeriesCount())
+          .isGreaterThan(0);
     }
-
-    assertWithMessage("View operation_latencies didn't return any data.")
-        .that(response.getTimeSeriesCount())
-        .isGreaterThan(0);
   }
 }