CASSJAVA-92: Local DC provided for nodetool clientstats #2036
+89
−22
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.datastax.oss.driver.api.core.loadbalancing; | ||
|
|
||
| import edu.umd.cs.findbugs.annotations.Nullable; | ||
|
|
||
| /** Load balancing policy taking into account local datacenter of the application. */ | ||
| public interface LocalDcAwareLoadBalancingPolicy extends LoadBalancingPolicy { | ||
|
|
||
| /** Returns the local datacenter name, if known; empty otherwise. */ | ||
| @Nullable | ||
| String getLocalDatacenter(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,10 @@ | |
| 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.loadbalancing.LocalDcAwareLoadBalancingPolicy; | ||
| import com.datastax.oss.driver.api.core.session.Session; | ||
| import com.datastax.oss.driver.api.core.uuid.Uuids; | ||
| import com.datastax.oss.protocol.internal.request.Startup; | ||
|
|
@@ -33,6 +36,7 @@ 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_LOCAL_DC = "DRIVER_LOCAL_DC"; | ||
| 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"; | ||
|
|
@@ -119,6 +123,11 @@ 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 | ||
| String applicationLocalDc = localDc(config); | ||
| if (applicationLocalDc != null) { | ||
| builder.put(DRIVER_LOCAL_DC, applicationLocalDc); | ||
| } | ||
|
|
||
| return builder.build(); | ||
| } | ||
|
|
@@ -142,4 +151,20 @@ protected String getDriverName() { | |
| protected String getDriverVersion() { | ||
| return Session.OSS_DRIVER_COORDINATES.getVersion().toString(); | ||
| } | ||
|
|
||
| private String localDc(DriverExecutionProfile profile) { | ||
| String dc = context.getLocalDatacenter(profile.getName()); // DC set programmatically | ||
| if (dc == null) { | ||
| // DC from load balancing policy | ||
| LoadBalancingPolicy lbp = context.getLoadBalancingPolicy(DriverExecutionProfile.DEFAULT_NAME); | ||
| if (lbp instanceof LocalDcAwareLoadBalancingPolicy) { | ||
| dc = ((LocalDcAwareLoadBalancingPolicy) lbp).getLocalDatacenter(); | ||
| } | ||
| } | ||
| if (dc == null && profile.isDefined(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER)) { | ||
| // DC from configuration | ||
| dc = profile.getString(DefaultDriverOption.LOAD_BALANCING_LOCAL_DATACENTER); | ||
| } | ||
| return dc; | ||
| } | ||
|
There was a problem hiding this comment. 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. There was a problem hiding this comment. 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 There was a problem hiding this comment. 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. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mentioned to @lukasz-antoniak in separate conversation but I'll document is here as well; checking for the presence of this config prop isn't enough. You also need to see whether you have an LBP implementation which cares about that prop; it's entirely possible a user could define LOAD_BALANCING_LOCAL_DATACENTER and then use some other LBP which just ignores it.
It's also worth noting that some LBPs can infer the local DC if it isn't present... which means they may not have anything defined for this property but would still have a notion of a local DC.