Exporter/Trace/Stackdriver: Provide Deadline option and don't do retry by default. (#1881)

Author: songy23

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Unreleased
 - Disable RunningSpanStore by default unless the z-pages contrib is linked and initialized. This may
 break behaviors for applications that rely on this to be always enabled.
+- Provide a `Deadline` option to Stackdriver Trace exporter. Default value is 10 seconds if it's not set.
 
 ## 0.21.0 - 2019-04-30
 - Add HTTP text format serializer to Tag propagation component.

exporters/trace/stackdriver/src/main/java/io/opencensus/exporter/trace/stackdriver/StackdriverTraceConfiguration.java

@@ -20,8 +20,10 @@
 import com.google.auto.value.AutoValue;
 import com.google.cloud.ServiceOptions;
 import com.google.cloud.trace.v2.stub.TraceServiceStub;
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
+import io.opencensus.common.Duration;
 import io.opencensus.trace.AttributeValue;
 import java.util.Collections;
 import java.util.LinkedHashMap;
@@ -41,6 +43,8 @@ public abstract class StackdriverTraceConfiguration {
   private static final String DEFAULT_PROJECT_ID =
       Strings.nullToEmpty(ServiceOptions.getDefaultProjectId());
 
+  @VisibleForTesting static final Duration DEFAULT_DEADLINE = Duration.create(10, 0);
+
   StackdriverTraceConfiguration() {}
 
   /**
@@ -77,6 +81,16 @@ public abstract class StackdriverTraceConfiguration {
    */
   public abstract Map<String, AttributeValue> getFixedAttributes();
 
+  /**
+   * Returns the deadline for exporting to Stackdriver Trace backend.
+   *
+   * <p>Default value is 10 seconds.
+   *
+   * @return the export deadline.
+   * @since 0.22
+   */
+  public abstract Duration getDeadline();
+
   /**
    * Returns a new {@link Builder}.
    *
@@ -86,7 +100,8 @@ public abstract class StackdriverTraceConfiguration {
   public static Builder builder() {
     return new AutoValue_StackdriverTraceConfiguration.Builder()
         .setProjectId(DEFAULT_PROJECT_ID)
-        .setFixedAttributes(Collections.<String, AttributeValue>emptyMap());
+        .setFixedAttributes(Collections.<String, AttributeValue>emptyMap())
+        .setDeadline(DEFAULT_DEADLINE);
   }
 
   /**
@@ -97,6 +112,8 @@ public static Builder builder() {
   @AutoValue.Builder
   public abstract static class Builder {
 
+    @VisibleForTesting static final Duration ZERO = Duration.fromMillis(0);
+
     Builder() {}
 
     /**
@@ -135,10 +152,24 @@ public abstract static class Builder {
      */
     public abstract Builder setFixedAttributes(Map<String, AttributeValue> fixedAttributes);
 
+    /**
+     * Sets the deadline for exporting to Stackdriver Trace backend.
+     *
+     * <p>If both {@code TraceServiceStub} and {@code Deadline} are set, {@code TraceServiceStub}
+     * takes precedence and {@code Deadline} will not be respected.
+     *
+     * @param deadline the export deadline.
+     * @return this
+     * @since 0.22
+     */
+    public abstract Builder setDeadline(Duration deadline);
+
     abstract String getProjectId();
 
     abstract Map<String, AttributeValue> getFixedAttributes();
 
+    abstract Duration getDeadline();
+
     abstract StackdriverTraceConfiguration autoBuild();
 
     /**
@@ -159,6 +190,7 @@ public StackdriverTraceConfiguration build() {
         Preconditions.checkNotNull(fixedAttribute.getKey(), "attribute key");
         Preconditions.checkNotNull(fixedAttribute.getValue(), "attribute value");
       }
+      Preconditions.checkArgument(getDeadline().compareTo(ZERO) > 0, "Deadline must be positive.");
       return autoBuild();
     }
   }

exporters/trace/stackdriver/src/main/java/io/opencensus/exporter/trace/stackdriver/StackdriverTraceExporter.java

@@ -86,7 +86,8 @@ public static void createAndRegister(StackdriverTraceConfiguration configuration
             StackdriverV2ExporterHandler.createWithCredentials(
                 projectId,
                 credentials != null ? credentials : GoogleCredentials.getApplicationDefault(),
-                configuration.getFixedAttributes());
+                configuration.getFixedAttributes(),
+                configuration.getDeadline());
       } else {
         handler =
             StackdriverV2ExporterHandler.createWithStub(

exporters/trace/stackdriver/src/main/java/io/opencensus/exporter/trace/stackdriver/StackdriverV2ExporterHandler.java

@@ -37,6 +37,7 @@
 import com.google.protobuf.BoolValue;
 import com.google.protobuf.Int32Value;
 import com.google.rpc.Status;
+import io.opencensus.common.Duration;
 import io.opencensus.common.Function;
 import io.opencensus.common.Functions;
 import io.opencensus.common.OpenCensusLibraryInformation;
@@ -171,15 +172,19 @@ static StackdriverV2ExporterHandler createWithStub(
   static StackdriverV2ExporterHandler createWithCredentials(
       String projectId,
       Credentials credentials,
-      Map<String, io.opencensus.trace.AttributeValue> fixedAttributes)
+      Map<String, io.opencensus.trace.AttributeValue> fixedAttributes,
+      Duration deadline)
       throws IOException {
-    TraceServiceSettings traceServiceSettings =
+    TraceServiceSettings.Builder builder =
         TraceServiceSettings.newBuilder()
             .setCredentialsProvider(
-                FixedCredentialsProvider.create(checkNotNull(credentials, "credentials")))
-            .build();
+                FixedCredentialsProvider.create(checkNotNull(credentials, "credentials")));
+    // We only use the batchWriteSpans API in this exporter.
+    builder
+        .batchWriteSpansSettings()
+        .setSimpleTimeoutNoRetries(org.threeten.bp.Duration.ofMillis(deadline.toMillis()));
     return new StackdriverV2ExporterHandler(
-        projectId, TraceServiceClient.create(traceServiceSettings), fixedAttributes);
+        projectId, TraceServiceClient.create(builder.build()), fixedAttributes);
   }
 
   @VisibleForTesting

exporters/trace/stackdriver/src/test/java/io/opencensus/exporter/trace/stackdriver/StackdriverTraceConfigurationTest.java

@@ -22,6 +22,7 @@
 import com.google.auth.oauth2.AccessToken;
 import com.google.auth.oauth2.GoogleCredentials;
 import com.google.cloud.ServiceOptions;
+import io.opencensus.common.Duration;
 import io.opencensus.trace.AttributeValue;
 import java.util.Collections;
 import java.util.Date;
@@ -39,6 +40,8 @@ public class StackdriverTraceConfigurationTest {
   private static final Credentials FAKE_CREDENTIALS =
       GoogleCredentials.newBuilder().setAccessToken(new AccessToken("fake", new Date(100))).build();
   private static final String PROJECT_ID = "project";
+  private static final Duration ONE_MINUTE = Duration.create(60, 0);
+  private static final Duration NEG_ONE_MINUTE = Duration.create(-60, 0);
 
   @Rule public final ExpectedException thrown = ExpectedException.none();
 
@@ -55,6 +58,8 @@ public void defaultConfiguration() {
     assertThat(configuration.getProjectId()).isNotNull();
     assertThat(configuration.getTraceServiceStub()).isNull();
     assertThat(configuration.getFixedAttributes()).isEmpty();
+    assertThat(configuration.getDeadline())
+        .isEqualTo(StackdriverTraceConfiguration.DEFAULT_DEADLINE);
   }
 
   @Test
@@ -66,10 +71,12 @@ public void updateAll() {
             .setCredentials(FAKE_CREDENTIALS)
             .setProjectId(PROJECT_ID)
             .setFixedAttributes(attributes)
+            .setDeadline(ONE_MINUTE)
             .build();
     assertThat(configuration.getCredentials()).isEqualTo(FAKE_CREDENTIALS);
     assertThat(configuration.getProjectId()).isEqualTo(PROJECT_ID);
     assertThat(configuration.getFixedAttributes()).isEqualTo(attributes);
+    assertThat(configuration.getDeadline()).isEqualTo(ONE_MINUTE);
   }
 
   @Test
@@ -124,4 +131,22 @@ public void disallowNullFixedAttributeValue() {
     thrown.expect(NullPointerException.class);
     builder.build();
   }
+
+  @Test
+  public void disallowZeroDuration() {
+    StackdriverTraceConfiguration.Builder builder =
+        StackdriverTraceConfiguration.builder().setProjectId("test");
+    builder.setDeadline(StackdriverTraceConfiguration.Builder.ZERO);
+    thrown.expect(IllegalArgumentException.class);
+    builder.build();
+  }
+
+  @Test
+  public void disallowNegativeDuration() {
+    StackdriverTraceConfiguration.Builder builder =
+        StackdriverTraceConfiguration.builder().setProjectId("test");
+    builder.setDeadline(NEG_ONE_MINUTE);
+    thrown.expect(IllegalArgumentException.class);
+    builder.build();
+  }
 }

exporters/trace/stackdriver/src/test/java/io/opencensus/exporter/trace/stackdriver/StackdriverV2ExporterHandlerProtoTest.java

@@ -17,6 +17,7 @@
 package io.opencensus.exporter.trace.stackdriver;
 
 import static com.google.common.truth.Truth.assertThat;
+import static io.opencensus.exporter.trace.stackdriver.StackdriverTraceConfiguration.DEFAULT_DEADLINE;
 import static io.opencensus.exporter.trace.stackdriver.StackdriverV2ExporterHandler.createResourceLabelKey;
 import static io.opencensus.exporter.trace.stackdriver.StackdriverV2ExporterHandler.toStringAttributeValueProto;
 
@@ -156,7 +157,8 @@ public void setUp() throws IOException {
         StackdriverV2ExporterHandler.createWithCredentials(
             PROJECT_ID,
             FAKE_CREDENTIALS,
-            Collections.<String, io.opencensus.trace.AttributeValue>emptyMap());
+            Collections.<String, io.opencensus.trace.AttributeValue>emptyMap(),
+            DEFAULT_DEADLINE);
   }
 
   @Test