Skip to content

Commit a3ed812

Browse files
committed
fix(gax): align env var and logging level
1 parent f5516b1 commit a3ed812

File tree

5 files changed

+12
-32
lines changed

5 files changed

+12
-32
lines changed

gax-java/gax/src/main/java/com/google/api/gax/logging/LoggingUtils.java

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,16 @@
3737
public class LoggingUtils {
3838

3939
static final String GOOGLE_SDK_JAVA_LOGGING = "GOOGLE_SDK_JAVA_LOGGING";
40-
static final String GOOGLE_SDK_JAVA_LOGGING_V2 = "GOOGLE_SDK_JAVA_LOGGING_V2";
4140

4241
private static boolean loggingEnabled = checkLoggingEnabled(GOOGLE_SDK_JAVA_LOGGING);
43-
private static boolean loggingV2Enabled = checkLoggingEnabled(GOOGLE_SDK_JAVA_LOGGING_V2);
4442

4543
/**
46-
* Returns whether client-side logging is enabled (V1 or V2).
44+
* Returns whether client-side logging is enabled.
4745
*
4846
* @return true if logging is enabled, false otherwise.
4947
*/
5048
public static boolean isLoggingEnabled() {
51-
return loggingEnabled || loggingV2Enabled;
52-
}
53-
54-
/**
55-
* Returns whether client-side logging V2 (Actionable Errors) is enabled.
56-
*
57-
* @return true if V2 logging is enabled, false otherwise.
58-
*/
59-
public static boolean isLoggingV2Enabled() {
60-
return loggingV2Enabled;
49+
return loggingEnabled;
6150
}
6251

6352
/**
@@ -69,15 +58,6 @@ public static void setLoggingEnabled(boolean enabled) {
6958
loggingEnabled = enabled;
7059
}
7160

72-
/**
73-
* Sets whether client-side logging V2 is enabled. Visible for testing.
74-
*
75-
* @param enabled true to enable logging, false to disable.
76-
*/
77-
public static void setLoggingV2Enabled(boolean enabled) {
78-
loggingV2Enabled = enabled;
79-
}
80-
8161
private static boolean checkLoggingEnabled(String envVar) {
8262
String enableLogging = System.getenv(envVar);
8363
return "true".equalsIgnoreCase(enableLogging);
@@ -179,7 +159,7 @@ public static void logActionableError(
179159
LoggerProvider loggerProvider,
180160
org.slf4j.event.Level level,
181161
String message) {
182-
if (loggingV2Enabled) {
162+
if (loggingEnabled) {
183163
org.slf4j.Logger logger = loggerProvider.getLogger();
184164
Slf4jUtils.log(logger, level, logContext, message);
185165
}

gax-java/gax/src/main/java/com/google/api/gax/logging/Slf4jLoggingHelpers.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,10 @@ static void logResponse(
114114
LoggingUtils.executeWithTryCatch(
115115
() -> {
116116
Logger logger = loggerProvider.getLogger();
117-
boolean isV2 = LoggingUtils.isLoggingV2Enabled();
118-
if (!isV2 && logger.isInfoEnabled()) {
117+
if (logger.isInfoEnabled()) {
119118
logDataBuilder.responseStatus(status);
120119
}
121-
if (!isV2 && logger.isInfoEnabled() && !logger.isDebugEnabled()) {
120+
if (logger.isInfoEnabled() && !logger.isDebugEnabled()) {
122121
Map<String, Object> responseData = logDataBuilder.build().toMapResponse();
123122
Slf4jUtils.log(logger, Level.INFO, responseData, "Received response");
124123
}

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ public static ClientContext create(StubSettings settings) throws IOException {
281281
if (apiTracerFactory instanceof SpanTracerFactory) {
282282
apiTracerFactory = apiTracerFactory.withContext(apiTracerContext);
283283
}
284-
if (com.google.api.gax.logging.LoggingUtils.isLoggingV2Enabled()) {
284+
if (com.google.api.gax.logging.LoggingUtils.isLoggingEnabled()) {
285285
com.google.api.gax.tracing.ApiTracerFactory loggingTracerFactory =
286286
new com.google.api.gax.tracing.LoggingTracerFactory().withContext(apiTracerContext);
287287
apiTracerFactory =

gax-java/gax/src/main/java/com/google/api/gax/tracing/LoggingTracer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,6 @@ private void recordActionableError(Throwable error) {
118118

119119
String message = error.getMessage() != null ? error.getMessage() : error.getClass().getName();
120120
LoggingUtils.logActionableError(
121-
logContext, LOGGER_PROVIDER, org.slf4j.event.Level.INFO, message);
121+
logContext, LOGGER_PROVIDER, org.slf4j.event.Level.DEBUG, message);
122122
}
123123
}

gax-java/gax/src/test/java/com/google/api/gax/logging/LoggingUtilsTest.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ void tearDown() {
9494

9595
@Test
9696
void testLogActionableError_loggingDisabled() {
97-
LoggingUtils.setLoggingV2Enabled(false);
97+
LoggingUtils.setLoggingEnabled(false);
9898
LoggerProvider loggerProvider = mock(LoggerProvider.class);
9999

100100
LoggingUtils.logActionableError(
101-
Collections.emptyMap(), loggerProvider, org.slf4j.event.Level.INFO, "message");
101+
Collections.emptyMap(), loggerProvider, org.slf4j.event.Level.DEBUG, "message");
102102

103103
verify(loggerProvider, never()).getLogger();
104104
}
@@ -111,12 +111,13 @@ void testLogActionableError_success() {
111111
when(loggerProvider.getLogger()).thenReturn(logger);
112112

113113
org.slf4j.spi.LoggingEventBuilder eventBuilder = mock(org.slf4j.spi.LoggingEventBuilder.class);
114-
when(logger.atInfo()).thenReturn(eventBuilder);
114+
when(logger.atDebug()).thenReturn(eventBuilder);
115115
when(eventBuilder.addKeyValue(anyString(), any())).thenReturn(eventBuilder);
116116

117117
Map<String, Object> context = Collections.singletonMap("key", "value");
118-
LoggingUtils.logActionableError(context, loggerProvider, org.slf4j.event.Level.INFO, "message");
118+
LoggingUtils.logActionableError(context, loggerProvider, org.slf4j.event.Level.DEBUG, "message");
119119

120120
verify(loggerProvider).getLogger();
121121
}
122122
}
123+

0 commit comments

Comments
 (0)