-
Notifications
You must be signed in to change notification settings - Fork 53
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.
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
feat: log DirectPath misconfiguration #2105
Changes from all commits
f93bfb7
6454a46
ec9116e
908a54d
752b4a3
f764786
1c5f4bb
b3ce533
cb685dc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -64,6 +64,8 @@ | |
import java.util.concurrent.Executor; | ||
import java.util.concurrent.ScheduledExecutorService; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.logging.Level; | ||
import java.util.logging.Logger; | ||
import javax.annotation.Nullable; | ||
import javax.net.ssl.KeyManagerFactory; | ||
import org.threeten.bp.Duration; | ||
|
@@ -82,6 +84,9 @@ | |
*/ | ||
@InternalExtensionOnly | ||
public final class InstantiatingGrpcChannelProvider implements TransportChannelProvider { | ||
@VisibleForTesting | ||
static final Logger LOG = Logger.getLogger(InstantiatingGrpcChannelProvider.class.getName()); | ||
|
||
private static final String DIRECT_PATH_ENV_DISABLE_DIRECT_PATH = | ||
"GOOGLE_CLOUD_DISABLE_DIRECT_PATH"; | ||
private static final String DIRECT_PATH_ENV_ENABLE_XDS = "GOOGLE_CLOUD_ENABLE_DIRECT_PATH_XDS"; | ||
|
@@ -140,6 +145,7 @@ private InstantiatingGrpcChannelProvider(Builder builder) { | |
builder.directPathServiceConfig == null | ||
? getDefaultDirectPathServiceConfig() | ||
: builder.directPathServiceConfig; | ||
logDirectPathMisconfig(); | ||
} | ||
|
||
/** | ||
|
@@ -266,6 +272,33 @@ boolean isDirectPathXdsEnabled() { | |
return false; | ||
} | ||
|
||
private void logDirectPathMisconfig() { | ||
if (isDirectPathXdsEnabled()) { | ||
// Case 1: does not enable DirectPath | ||
if (!isDirectPathEnabled()) { | ||
LOG.log( | ||
Level.WARNING, | ||
"DirectPath is misconfigured. Please set the attemptDirectPath option along with the" | ||
+ " attemptDirectPathXds option."); | ||
} else { | ||
// Case 2: credential is not correctly set | ||
if (!isNonDefaultServiceAccountAllowed()) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it possible to have a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes it is possible, this is the original fix for this problem, googleapis/gax-java#1250. |
||
LOG.log( | ||
Level.WARNING, | ||
"DirectPath is misconfigured. Please make sure the credential is an instance of " | ||
+ ComputeEngineCredentials.class.getName() | ||
+ " ."); | ||
} | ||
// Case 3: not running on GCE | ||
if (!isOnComputeEngine()) { | ||
LOG.log( | ||
Level.WARNING, | ||
"DirectPath is misconfigured. DirectPath is only available in a GCE environment."); | ||
} | ||
} | ||
} | ||
} | ||
|
||
private boolean isNonDefaultServiceAccountAllowed() { | ||
if (allowNonDefaultServiceAccount != null && allowNonDefaultServiceAccount) { | ||
return true; | ||
|
@@ -275,6 +308,7 @@ private boolean isNonDefaultServiceAccountAllowed() { | |
|
||
// DirectPath should only be used on Compute Engine. | ||
// Notice Windows is supported for now. | ||
@VisibleForTesting | ||
static boolean isOnComputeEngine() { | ||
String osName = System.getProperty("os.name"); | ||
if ("Linux".equals(osName)) { | ||
|
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.
IIUC, this logic is added specifically for log statements. How do we make sure it is in parity with directPath decision making?
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.
Are you referring to the bit that actually handles connecting to DirectPath in gRPC?
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.
The DirectPath decision making is L363:
And I came up with the 4 cases based on it. WDYT?
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.
What I meant was that this logic will be invoked only when directPath is misconfigured. But this is not the logic which decides if directPath is misconfigured. This code snippet could become stale if there is change in logic which is actually deciding when directpath is misconfigured.
Just as an e.g. this is the code snippet which decides directPath misconfiguration
Here we check for
isNonDefaultServiceAccountAllowed
. Hypothetically in future ifisNonDefaultServiceAccountAllowed
check is removed there is no easy way to know thatfun:logDirectPathMisconfig
needs to be updated as well.I guess there is no easy way to enforce it and this is fine for now.
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.
Thanks for your inputs!
isNonDefaultServiceAccountAllowed()
andisOnComputeEngine()
should be kept even after DirectPath rolls out, and then we will need to cleanup env/options, and this warning logs should also be cleaned.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.
I have the same concern as @singhravidutt, the logic in
logDirectPathMisconfig()
could evolve to be different than(isDirectPathEnabled() && isNonDefaultServiceAccountAllowed() && isOnComputeEngine())
. Ideally, we should check if we should use DirectPath or not during the initialization of this class, set the value to a fielduseDirectPath
, and use it to check if we should create a DirectPath channel afterwards.See the following code that demonstrates my idea:
This also makes the new code much more testable as SonarCheck is failing due to lacking test coverage of the new code.
@mohanli-ml Let me know if it makes sense, if you think it might be too much at this moment, our team can take it as a follow up PR.
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.
Thanks for the suggestion! Moving the DirectPath enabling logic to the builder instead of checking it every time when construct a channel sounds good to me. However, pay attention to the logic here:
In short I feel the logic is already complex and I would suggest to do this with the cleanup of removing DirectPath gRPCLB, which is blocked by CBT and is expected to be done in Q4.
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.
I think that's reasonable. For now, can you please add some unit tests for these logging statement? So that the test coverage for new code meets our least standard and gives us more confidence when we refactor it. For example, one way to test it is to create a FakeLogger and assert the log message captured in the FakeLogger.
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.
Done. Thanks!