close background executor

mutianf · mutianf · commit df91fd5abfb6 · 2025-12-30T11:29:11.000-05:00
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/BigtableClientContext.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/BigtableClientContext.java
@@ -19,6 +19,7 @@
 import com.google.api.core.InternalApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.core.CredentialsProvider;
+import com.google.api.gax.core.ExecutorAsBackgroundResource;
 import com.google.api.gax.core.FixedCredentialsProvider;
 import com.google.api.gax.core.FixedExecutorProvider;
 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
@@ -35,6 +36,7 @@
 import com.google.cloud.bigtable.data.v2.stub.metrics.NoopMetricsProvider;
 import com.google.cloud.bigtable.gaxx.grpc.BigtableTransportChannelProvider;
 import com.google.cloud.bigtable.gaxx.grpc.ChannelPrimer;
+import com.google.common.collect.ImmutableList;
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.opentelemetry.GrpcOpenTelemetry;
 import io.opentelemetry.api.OpenTelemetry;
@@ -77,9 +79,15 @@ public static BigtableClientContext create(EnhancedBigtableStubSettings settings
 
     String universeDomain = settings.getUniverseDomain();
 
+    boolean canAutoCloseExecutor = true;
     ScheduledExecutorService backgroundExecutor =
         settings.getBackgroundExecutorProvider().getExecutor();
-
+    if (settings.getBackgroundExecutorProvider() instanceof FixedExecutorProvider) {
+      // if the background executor in the settings is already a FixedExecutorProvider,
+      // we can't assume that we can autoclose it and the life cycle should be managed
+      // by the application
+      canAutoCloseExecutor = false;
+    }
     FixedExecutorProvider executorProvider = FixedExecutorProvider.create(backgroundExecutor);
     builder.setBackgroundExecutorProvider(executorProvider);
 
@@ -154,6 +162,17 @@ public static BigtableClientContext create(EnhancedBigtableStubSettings settings
     }
 
     ClientContext clientContext = ClientContext.create(builder.build());
+    if (canAutoCloseExecutor) {
+      // Since we converted background executor to a FixedExecutorProvider, we need
+      // to add it back to the background resources, so it will be closed when we close the
+      // client context.
+      ImmutableList<BackgroundResource> backgroundResources =
+          ImmutableList.<BackgroundResource>builder()
+              .addAll(clientContext.getBackgroundResources())
+              .add(new ExecutorAsBackgroundResource(backgroundExecutor))
+              .build();
+      clientContext = clientContext.toBuilder().setBackgroundResources(backgroundResources).build();
+    }
     if (channelPoolMetricsTracer != null) {
       channelPoolMetricsTracer.start(clientContext.getExecutor());
     }
@@ -208,6 +227,11 @@ public ClientContext getClientContext() {
     return this.clientContext;
   }
 
+  public BigtableClientContext setClientContext(ClientContext clientContext) {
+    return new BigtableClientContext(
+        clientContext, this.openTelemetry, this.internalOpenTelemetry, this.metricsProvider);
+  }
+
   public void close() throws Exception {
     for (BackgroundResource resource : clientContext.getBackgroundResources()) {
       resource.close();
diff --git a/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/metrics/BigtableCloudMonitoringExporter.java b/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/metrics/BigtableCloudMonitoringExporter.java
@@ -130,6 +130,9 @@ static BigtableCloudMonitoringExporter create(
 
     settingsBuilder.setUniverseDomain(universeDomain);
 
+    // If background executor is not null, use it for the monitoring client. This allows us to
+    // share the same background executor with the data client. When it's null, the monitoring
+    // client will create a new executor service from InstantiatingExecutorProvider.
     if (executorService != null) {
       settingsBuilder.setBackgroundExecutorProvider(FixedExecutorProvider.create(executorService));
     }

Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,9 @@ static BigtableCloudMonitoringExporter create(`
`130`	`130`
`131`	`131`	`settingsBuilder.setUniverseDomain(universeDomain);`
`132`	`132`
	`133`	`+ // If background executor is not null, use it for the monitoring client. This allows us to`
	`134`	`+ // share the same background executor with the data client. When it's null, the monitoring`
	`135`	`+ // client will create a new executor service from InstantiatingExecutorProvider.`
`133`	`136`	`if (executorService != null) {`
`134`	`137`	`settingsBuilder.setBackgroundExecutorProvider(FixedExecutorProvider.create(executorService));`
`135`	`138`	`}`