Allow to disable driver baggage

Author: lukasz-antoniak

core/src/main/java/com/datastax/oss/driver/api/core/config/DefaultDriverOption.java

@@ -1035,7 +1035,13 @@ public enum DefaultDriverOption implements DriverOption {
    *
    * <p>Value-Type: boolean
    */
-  ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES("advanced.address-translator.resolve-addresses");
+  ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES("advanced.address-translator.resolve-addresses"),
+  /**
+   * Option to include driver configuration parameters in startup message.
+   *
+   * <p>Value-type: boolean
+   */
+  REQUEST_STARTUP_BAGGAGE_ENABLED("advanced.request.startup-baggage-enabled");
 
   private final String path;
 

core/src/main/java/com/datastax/oss/driver/api/core/config/OptionsMap.java

@@ -383,6 +383,7 @@ protected static void fillWithDriverDefaults(OptionsMap map) {
     map.put(TypedDriverOption.METRICS_GENERATE_AGGREGABLE_HISTOGRAMS, true);
     map.put(
         TypedDriverOption.LOAD_BALANCING_DC_FAILOVER_PREFERRED_REMOTE_DCS, ImmutableList.of(""));
+    map.put(TypedDriverOption.REQUEST_STARTUP_BAGGAGE_ENABLED, true);
   }
 
   @Immutable

core/src/main/java/com/datastax/oss/driver/api/core/config/TypedDriverOption.java

@@ -920,6 +920,11 @@ public String toString() {
               DefaultDriverOption.LOAD_BALANCING_DC_FAILOVER_PREFERRED_REMOTE_DCS,
               GenericType.listOf(String.class));
 
+  /** Option to include driver configuration parameters in startup message. */
+  public static final TypedDriverOption<Boolean> REQUEST_STARTUP_BAGGAGE_ENABLED =
+      new TypedDriverOption<>(
+          DefaultDriverOption.REQUEST_STARTUP_BAGGAGE_ENABLED, GenericType.BOOLEAN);
+
   private static Iterable<TypedDriverOption<?>> introspectBuiltInValues() {
     try {
       ImmutableList.Builder<TypedDriverOption<?>> result = ImmutableList.builder();

core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java

@@ -216,8 +216,8 @@ public class DefaultDriverContext implements InternalDriverContext {
       new LazyReference<>("metricIdGenerator", this::buildMetricIdGenerator, cycleDetector);
   private final LazyReference<RequestThrottler> requestThrottlerRef =
       new LazyReference<>("requestThrottler", this::buildRequestThrottler, cycleDetector);
-  private final LazyReference<Map<String, String>> startupOptionsRef =
-      new LazyReference<>("startupOptions", this::buildStartupOptions, cycleDetector);
+  private final LazyReference<StartupOptionsBuilder> startupOptionsRef =
+      new LazyReference<>("startupOptionsFactory", this::buildStartupOptionsFactory, cycleDetector);
   private final LazyReference<NodeStateListener> nodeStateListenerRef;
   private final LazyReference<SchemaChangeListener> schemaChangeListenerRef;
   private final LazyReference<RequestTracker> requestTrackerRef;
@@ -335,16 +335,15 @@ public DefaultDriverContext(
   }
 
   /**
-   * Builds a map of options to send in a Startup message.
+   * Returns builder of options to send in a Startup message.
    *
    * @see #getStartupOptions()
    */
-  protected Map<String, String> buildStartupOptions() {
+  protected StartupOptionsBuilder buildStartupOptionsFactory() {
     return new StartupOptionsBuilder(this)
         .withClientId(startupClientId)
         .withApplicationName(startupApplicationName)
-        .withApplicationVersion(startupApplicationVersion)
-        .build();
+        .withApplicationVersion(startupApplicationVersion);
   }
 
   protected Map<String, LoadBalancingPolicy> buildLoadBalancingPolicies() {
@@ -1013,7 +1012,8 @@ public ProtocolVersion getProtocolVersion() {
   @NonNull
   @Override
   public Map<String, String> getStartupOptions() {
-    return startupOptionsRef.get();
+    // startup options are calculated dynamically and maj vary per connection
+    return startupOptionsRef.get().build();
   }
 
   protected RequestLogFormatter buildRequestLogFormatter() {

core/src/main/java/com/datastax/oss/driver/internal/core/context/StartupOptionsBuilder.java

@@ -18,6 +18,7 @@
 package com.datastax.oss.driver.internal.core.context;
 
 import com.datastax.dse.driver.api.core.config.DseDriverOption;
+import com.datastax.oss.driver.api.core.config.DefaultDriverOption;
 import com.datastax.oss.driver.api.core.config.DriverExecutionProfile;
 import com.datastax.oss.driver.api.core.loadbalancing.LoadBalancingPolicy;
 import com.datastax.oss.driver.api.core.session.Session;
@@ -129,8 +130,12 @@ public Map<String, String> build() {
     if (applicationVersion != null) {
       builder.put(APPLICATION_VERSION_KEY, applicationVersion);
     }
-    // do not cache local DC as it can change within LBP implementation
-    driverBaggage().ifPresent(s -> builder.put(DRIVER_BAGGAGE, s));
+    boolean baggageEnabled =
+        config.getBoolean(DefaultDriverOption.REQUEST_STARTUP_BAGGAGE_ENABLED, true);
+    if (baggageEnabled) {
+      // do not cache local DC as it can change within LBP implementation
+      driverBaggage().ifPresent(s -> builder.put(DRIVER_BAGGAGE, s));
+    }
 
     return builder.build();
   }

core/src/main/resources/reference.conf

@@ -1150,6 +1150,14 @@ datastax-java-driver {
     # Overridable in a profile: no
     warn-if-set-keyspace = true
 
+    # Enable publishing driver baggage with Startup message that contains
+    # driver configuration details.
+    #
+    # Required: no
+    # Modifiable at runtime: yes
+    # Overridable in a profile: no
+    startup-baggage-enabled = true
+
     # If tracing is enabled for a query, this controls how the trace is fetched.
     trace {
       # How many times the driver will attempt to fetch the query if it is not ready yet.

core/src/test/java/com/datastax/dse/driver/internal/core/context/DseStartupOptionsBuilderTest.java renamed to core/src/test/java/com/datastax/dse/driver/internal/core/context/StartupOptionsBuilderTest.java

@@ -58,7 +58,7 @@
 import org.mockito.Mock;
 
 @RunWith(DataProviderRunner.class)
-public class DseStartupOptionsBuilderTest {
+public class StartupOptionsBuilderTest {
 
   private DefaultDriverContext driverContext;
 
@@ -73,6 +73,8 @@ public void before() {
     when(configLoader.getInitialConfig()).thenReturn(driverConfig);
     when(driverConfig.getDefaultProfile()).thenReturn(defaultProfile);
     when(defaultProfile.isDefined(DseDriverOption.CONTINUOUS_PAGING_PAGE_SIZE)).thenReturn(true);
+    when(defaultProfile.getBoolean(DefaultDriverOption.REQUEST_STARTUP_BAGGAGE_ENABLED, true))
+        .thenReturn(true);
   }
 
   private void buildContext(