Skip to content

[GOBBLIN-2247] Tune RPC retry policy to tolerate 1-2 min throttling on Temporal gRPC calls #4176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Blazer-007 merged 1 commit into from
Mar 24, 2026
Merged

[GOBBLIN-2247] Tune RPC retry policy to tolerate 1-2 min throttling on Temporal gRPC calls #4176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions ...-temporal/src/main/java/org/apache/gobblin/temporal/GobblinTemporalConfigurationKeys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,22 @@ public interface GobblinTemporalConfigurationKeys {
String TEMPORAL_ACTIVITY_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = TEMPORAL_ACTIVITY_RETRY_OPTIONS + "maximum.attempts";
int DEFAULT_TEMPORAL_ACTIVITY_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = 4;

/**
* RPC retry options for gRPC calls to the Temporal service (e.g. worker status reporting).
* Defaults are tuned to tolerate short-lived throttling windows of 1-2 minutes:
* with initialInterval=500ms, coefficient=2.0, maximumInterval=30s, the cumulative wait across
* 10 attempts is ~151.5s, providing coverage beyond a 2-minute throttle burst.
*/
String TEMPORAL_RPC_RETRY_OPTIONS = PREFIX + "rpc.retry.options.";
String TEMPORAL_RPC_RETRY_OPTIONS_INITIAL_INTERVAL_MILLIS = TEMPORAL_RPC_RETRY_OPTIONS + "initial.interval.millis";
int DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_INITIAL_INTERVAL_MILLIS = 500;
String TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_INTERVAL_SECONDS = TEMPORAL_RPC_RETRY_OPTIONS + "maximum.interval.seconds";
int DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_INTERVAL_SECONDS = 30;
String TEMPORAL_RPC_RETRY_OPTIONS_BACKOFF_COEFFICIENT = TEMPORAL_RPC_RETRY_OPTIONS + "backoff.coefficient";
double DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_BACKOFF_COEFFICIENT = 2.0;
String TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = TEMPORAL_RPC_RETRY_OPTIONS + "maximum.attempts";
int DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_ATTEMPTS = 10;

/**
* Memory allocation for execution worker containers.
*/
Expand Down
24 changes: 24 additions & 0 deletions ...main/java/org/apache/gobblin/temporal/workflows/client/TemporalWorkflowClientFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.io.IOException;
import java.io.InputStream;
import java.security.KeyStore;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
Expand All @@ -37,6 +38,7 @@
import io.grpc.netty.shaded.io.netty.handler.ssl.SslContext;
import io.temporal.client.WorkflowClient;
import io.temporal.client.WorkflowClientOptions;
import io.temporal.serviceclient.RpcRetryOptions;
import io.temporal.serviceclient.WorkflowServiceStubs;
import io.temporal.serviceclient.WorkflowServiceStubsOptions;
import javax.net.ssl.KeyManagerFactory;
Expand Down Expand Up @@ -118,6 +120,7 @@ public static ManagedWorkflowServiceStubs createServiceInstance(String connectio
.setEnableHttps(true)
.setSslContext(sslContext)
.setMetricsScope(metricsScope)
.setRpcRetryOptions(buildRpcRetryOptions(config))
.build();
return new ManagedWorkflowServiceStubs(WorkflowServiceStubs.newServiceStubs(options));
}
Expand All @@ -129,6 +132,27 @@ public static WorkflowClient createClientInstance(WorkflowServiceStubs service,
return WorkflowClient.newInstance(service, options);
}

private static RpcRetryOptions buildRpcRetryOptions(Config config) {
int initialIntervalMillis = ConfigUtils.getInt(config,
GobblinTemporalConfigurationKeys.TEMPORAL_RPC_RETRY_OPTIONS_INITIAL_INTERVAL_MILLIS,
GobblinTemporalConfigurationKeys.DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_INITIAL_INTERVAL_MILLIS);
int maximumIntervalSeconds = ConfigUtils.getInt(config,
GobblinTemporalConfigurationKeys.TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_INTERVAL_SECONDS,
GobblinTemporalConfigurationKeys.DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_INTERVAL_SECONDS);
double backoffCoefficient = ConfigUtils.getDouble(config,
GobblinTemporalConfigurationKeys.TEMPORAL_RPC_RETRY_OPTIONS_BACKOFF_COEFFICIENT,
GobblinTemporalConfigurationKeys.DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_BACKOFF_COEFFICIENT);
int maximumAttempts = ConfigUtils.getInt(config,
GobblinTemporalConfigurationKeys.TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_ATTEMPTS,
GobblinTemporalConfigurationKeys.DEFAULT_TEMPORAL_RPC_RETRY_OPTIONS_MAXIMUM_ATTEMPTS);
return RpcRetryOptions.newBuilder()
.setInitialInterval(Duration.ofMillis(initialIntervalMillis))
.setBackoffCoefficient(backoffCoefficient)
.setMaximumInterval(Duration.ofSeconds(maximumIntervalSeconds))
.setMaximumAttempts(maximumAttempts)
.build();
}

private static InputStream toInputStream(File storeFile)
throws IOException {
byte[] data = FileUtils.readFileToByteArray(storeFile);
Expand Down
Loading