Skip to content

CASSJAVA-92: Local DC provided for nodetool clientstats #2036

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
merged 1 commit into from
Oct 3, 2025
Merged

CASSJAVA-92: Local DC provided for nodetool clientstats #2036

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
7 changes: 7 additions & 0 deletions core/src/main/java/com/datastax/oss/driver/api/core/loadbalancing/LoadBalancingPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.datastax.oss.driver.api.core.tracker.RequestTracker;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Collections;
import java.util.Map;
import java.util.Optional;
import java.util.Queue;
Expand Down Expand Up @@ -76,6 +77,12 @@ default Optional<RequestTracker> getRequestTracker() {
*/
void init(@NonNull Map<UUID, Node> nodes, @NonNull DistanceReporter distanceReporter);

/** Returns map containing details that impact C* node connectivity. */
@NonNull
default Map<String, ?> getStartupConfiguration() {
return Collections.emptyMap();
}

/**
* Returns the coordinators to use for a new query.
*
Expand Down
14 changes: 7 additions & 7 deletions core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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() {
Expand Down Expand Up @@ -1013,7 +1012,8 @@ public ProtocolVersion getProtocolVersion() {
@NonNull
@Override
public Map<String, String> getStartupOptions() {
return startupOptionsRef.get();
// startup options are calculated dynamically and may vary per connection
return startupOptionsRef.get().build();
}

protected RequestLogFormatter buildRequestLogFormatter() {
Expand Down
28 changes: 28 additions & 0 deletions core/src/main/java/com/datastax/oss/driver/internal/core/context/StartupOptionsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,34 @@

import com.datastax.dse.driver.api.core.config.DseDriverOption;
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;
import com.datastax.oss.driver.api.core.uuid.Uuids;
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
import com.datastax.oss.protocol.internal.request.Startup;
import com.datastax.oss.protocol.internal.util.collection.NullAllowingImmutableMap;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import net.jcip.annotations.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Immutable
public class StartupOptionsBuilder {

public static final String DRIVER_NAME_KEY = "DRIVER_NAME";
public static final String DRIVER_VERSION_KEY = "DRIVER_VERSION";
public static final String DRIVER_BAGGAGE = "DRIVER_BAGGAGE";
public static final String APPLICATION_NAME_KEY = "APPLICATION_NAME";
public static final String APPLICATION_VERSION_KEY = "APPLICATION_VERSION";
public static final String CLIENT_ID_KEY = "CLIENT_ID";

private static final Logger LOG = LoggerFactory.getLogger(StartupOptionsBuilder.class);
private static final ObjectMapper mapper = new ObjectMapper();

protected final InternalDriverContext context;
private UUID clientId;
private String applicationName;
Expand Down Expand Up @@ -119,6 +129,7 @@ public Map<String, String> build() {
if (applicationVersion != null) {
builder.put(APPLICATION_VERSION_KEY, applicationVersion);
}
driverBaggage().ifPresent(s -> builder.put(DRIVER_BAGGAGE, s));

return builder.build();
}
Expand All @@ -142,4 +153,21 @@ protected String getDriverName() {
protected String getDriverVersion() {
return Session.OSS_DRIVER_COORDINATES.getVersion().toString();
}

private Optional<String> driverBaggage() {
ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<>();
for (Map.Entry<String, LoadBalancingPolicy> entry :
context.getLoadBalancingPolicies().entrySet()) {
Map<String, ?> config = entry.getValue().getStartupConfiguration();
Copy link
Contributor

@aratno aratno Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should offer a configuration to disable getStartupConfiguration that matches the current behavior, for users with tons of profiles or custom policies that don't support it properly yet

Copy link
Contributor

@absurdfarce absurdfarce Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that I'm super-worried about this honestly. Users with custom LBPs should be okay; this PR includes an update to the primary interface com.datastax.oss.driver.api.core.loadbalancing.LoadBalancingPolicy with a default impl of getStartupConfiguration() that returns an empty map. So even if the user is working with a custom LBP that was implemented before this change they'll still be covered by the default method... and since DriverContext.getLoadBalancingPolicies() guarantees we'll get a map of Strings onto LoadBalancingPolicy impls that should cover everybody, right?

Users with lots of LBPs may have some slight overhead but it's far from clear to me that it's enough to worry about disabling the functionality all together.

Whaddya think @aratno?

Copy link
Contributor

@aratno aratno Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, fine with me

if (!config.isEmpty()) {
builder.put(entry.getKey(), config);
}
}
try {
return Optional.of(mapper.writeValueAsString(builder.build()));
} catch (Exception e) {
LOG.warn("Failed to construct startup driver baggage", e);
return Optional.empty();
}
}
Copy link
Contributor

@absurdfarce absurdfarce Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DefaultDriverContext already defines lazy instantiation for (and access to) the startup options map for a given run. Rather than splitting the logic for determining the contents of a STARTUP message between DefaultDriverContext and this class the majority of the logic in this class should be consolidated into the existing DefaultDriverContext methods.

Copy link
Member Author

@lukasz-antoniak lukasz-antoniak Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have noticed that and though that other entries of the STARTUP options are added here. The justification of the logic would be that all "dedicated" properties for STARTUP message are lazily instantiated where you pointed out, whereas all properties taken from other components (e.g. compression) are automatically injected in build() method.

Copy link
Contributor

@absurdfarce absurdfarce Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, as I look at this again you're right, there's something of a bifurcation here already. The entries returned by DefaultDriverContext.buildStartupOptions() are more static key/value pairs, mostly (exclusively?) pairs that were used by Insights. Nearly all of those should be removed as part of CASSJAVA-73; driver name and version will stay but the rest should disappear.

So how should we format this data? That question is still under discussion in CASSJAVA-92... we probably need to settle on what the data should look like and then adjust this impl accordingly.

}
31 changes: 30 additions & 1 deletion ...in/java/com/datastax/oss/driver/internal/core/loadbalancing/BasicLoadBalancingPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import com.datastax.oss.driver.internal.core.util.collection.QueryPlan;
import com.datastax.oss.driver.internal.core.util.collection.SimpleQueryPlan;
import com.datastax.oss.driver.shaded.guava.common.base.Predicates;
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
import com.datastax.oss.driver.shaded.guava.common.collect.Lists;
import com.datastax.oss.driver.shaded.guava.common.collect.Sets;
import edu.umd.cs.findbugs.annotations.NonNull;
Expand Down Expand Up @@ -155,10 +156,38 @@ public BasicLoadBalancingPolicy(@NonNull DriverContext context, @NonNull String
* Before initialization, this method always returns null.
*/
@Nullable
protected String getLocalDatacenter() {
public String getLocalDatacenter() {
return localDc;
}

@NonNull
@Override
public Map<String, ?> getStartupConfiguration() {
ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<>();
if (localDc != null) {
builder.put("localDc", localDc);
} else {
// Local data center may not be discovered prior to connection pool initialization.
// In such scenario, return configured local data center name.
// Note that when using DC inferring load balancing policy, startup configuration
// may not show local DC name, because it will be discovered only once control connection
// is established and datacenter of contact points known.
Optional<String> configuredDc =
new OptionalLocalDcHelper(context, profile, logPrefix).configuredLocalDc();
configuredDc.ifPresent(d -> builder.put("localDc", d));
}
if (!preferredRemoteDcs.isEmpty()) {
builder.put("preferredRemoteDcs", preferredRemoteDcs);
}
if (allowDcFailoverForLocalCl) {
builder.put("allowDcFailoverForLocalCl", allowDcFailoverForLocalCl);
}
if (maxNodesPerRemoteDc > 0) {
builder.put("maxNodesPerRemoteDc", maxNodesPerRemoteDc);
}
return ImmutableMap.of(BasicLoadBalancingPolicy.class.getSimpleName(), builder.build());
}

/** @return The nodes currently considered as live. */
protected NodeSet getLiveNodes() {
return liveNodes;
Expand Down
10 changes: 10 additions & 0 deletions .../java/com/datastax/oss/driver/internal/core/loadbalancing/DefaultLoadBalancingPolicy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import com.datastax.oss.driver.internal.core.util.collection.QueryPlan;
import com.datastax.oss.driver.internal.core.util.collection.SimpleQueryPlan;
import com.datastax.oss.driver.shaded.guava.common.annotations.VisibleForTesting;
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
import com.datastax.oss.driver.shaded.guava.common.collect.MapMaker;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
Expand Down Expand Up @@ -350,4 +351,13 @@ private boolean hasSufficientResponses(long now) {
return this.oldest - threshold >= 0;
}
}

@NonNull
@Override
public Map<String, ?> getStartupConfiguration() {
Map<String, ?> parent = super.getStartupConfiguration();
return ImmutableMap.of(
DefaultLoadBalancingPolicy.class.getSimpleName(),
parent.get(BasicLoadBalancingPolicy.class.getSimpleName()));
}
}
31 changes: 20 additions & 11 deletions ...ava/com/datastax/oss/driver/internal/core/loadbalancing/helper/OptionalLocalDcHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,14 @@ public OptionalLocalDcHelper(
@Override
@NonNull
public Optional<String> discoverLocalDc(@NonNull Map<UUID, Node> nodes) {
String localDc = context.getLocalDatacenter(profile.getName());
if (localDc != null) {
LOG.debug("[{}] Local DC set programmatically: {}", logPrefix, localDc);
checkLocalDatacenterCompatibility(localDc, context.getMetadataManager().getContactPoints());
return Optional.of(localDc);
} else if (profile.isDefined(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER)) {
localDc = profile.getString(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER);
LOG.debug("[{}] Local DC set from configuration: {}", logPrefix, localDc);
checkLocalDatacenterCompatibility(localDc, context.getMetadataManager().getContactPoints());
return Optional.of(localDc);
Optional<String> localDc = configuredLocalDc();
if (localDc.isPresent()) {
checkLocalDatacenterCompatibility(
localDc.get(), context.getMetadataManager().getContactPoints());
} else {
LOG.debug("[{}] Local DC not set, DC awareness will be disabled", logPrefix);
return Optional.empty();
}
return localDc;
}

/**
Expand Down Expand Up @@ -138,4 +132,19 @@ protected String formatDcs(Iterable<? extends Node> nodes) {
}
return String.join(", ", new TreeSet<>(l));
}

/** @return Local data center set programmatically or from configuration file. */
@NonNull
public Optional<String> configuredLocalDc() {
String localDc = context.getLocalDatacenter(profile.getName());
if (localDc != null) {
LOG.debug("[{}] Local DC set programmatically: {}", logPrefix, localDc);
return Optional.of(localDc);
} else if (profile.isDefined(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER)) {
localDc = profile.getString(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER);
LOG.debug("[{}] Local DC set from configuration: {}", logPrefix, localDc);
return Optional.of(localDc);
}
return Optional.empty();
}
}
3 changes: 1 addition & 2 deletions ...astax/oss/driver/internal/core/addresstranslation/FixedHostNameAddressTranslatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import com.datastax.oss.driver.internal.core.context.DefaultDriverContext;
import com.datastax.oss.driver.internal.core.context.MockedDriverContextFactory;
import java.net.InetSocketAddress;
import java.util.Optional;
import org.junit.Test;

public class FixedHostNameAddressTranslatorTest {
Expand All @@ -36,7 +35,7 @@ public void should_translate_address() {
DriverExecutionProfile defaultProfile = mock(DriverExecutionProfile.class);
when(defaultProfile.getString(ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME)).thenReturn("myaddress");
DefaultDriverContext defaultDriverContext =
MockedDriverContextFactory.defaultDriverContext(Optional.of(defaultProfile));
MockedDriverContextFactory.defaultDriverContext(defaultProfile);

FixedHostNameAddressTranslator translator =
new FixedHostNameAddressTranslator(defaultDriverContext);
Expand Down
3 changes: 1 addition & 2 deletions ...com/datastax/oss/driver/internal/core/addresstranslation/SubnetAddressTranslatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
import java.net.InetSocketAddress;
import java.util.Map;
import java.util.Optional;
import org.junit.Test;

@SuppressWarnings("resource")
Expand Down Expand Up @@ -148,6 +147,6 @@ public void should_fail_on_default_address_without_port() {
private static DefaultDriverContext context(Map<String, String> subnetAddresses) {
DriverExecutionProfile profile = mock(DriverExecutionProfile.class);
when(profile.getStringMap(ADDRESS_TRANSLATOR_SUBNET_ADDRESSES)).thenReturn(subnetAddresses);
return MockedDriverContextFactory.defaultDriverContext(Optional.of(profile));
return MockedDriverContextFactory.defaultDriverContext(profile);
}
}
2 changes: 1 addition & 1 deletion ...src/test/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ private DefaultDriverContext buildMockedContext(Optional<String> compressionOpti
DriverExecutionProfile defaultProfile = mock(DriverExecutionProfile.class);
when(defaultProfile.getString(DefaultDriverOption.PROTOCOL_COMPRESSION, "none"))
.thenReturn(compressionOption.orElse("none"));
return MockedDriverContextFactory.defaultDriverContext(Optional.of(defaultProfile));
return MockedDriverContextFactory.defaultDriverContext(defaultProfile);
}

private void doCreateCompressorTest(Optional<String> configVal, Class<?> expectedClz) {
Expand Down
Loading