Skip to content

Commit 8f12627

Browse files
samikshya-dbsamikshya-db
authored
Remove unnecessary logs (#371)
1 parent b1689b0 commit 8f12627

File tree

5 files changed

+40
-39
lines changed

5 files changed

+40
-39
lines changed

‎src/main/java/com/databricks/jdbc/commons/util/DeviceInfoLogUtil.java‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package com.databricks.jdbc.commons.util;
22

33
import com.databricks.jdbc.commons.LogLevel;
4-
import com.databricks.jdbc.core.DatabricksSQLException;
54
import com.databricks.jdbc.driver.IDatabricksConnectionContext;
65
import com.databricks.jdbc.telemetry.DatabricksUsageMetrics;
76
import java.nio.charset.Charset;
@@ -30,22 +29,16 @@ public static void logProperties(IDatabricksConnectionContext context) {
3029
LoggingUtil.log(LogLevel.INFO, String.format("Operating System Architecture: %s", osArch));
3130
LoggingUtil.log(LogLevel.INFO, String.format("Locale Name: %s", localeName));
3231
LoggingUtil.log(LogLevel.INFO, String.format("Default Charset Encoding: %s", charsetEncoding));
33-
if (context.enableTelemetry()) {
34-
try {
35-
DatabricksUsageMetrics.exportUsageMetrics(
36-
context,
37-
jvmName,
38-
jvmSpecVersion,
39-
jvmImplVersion,
40-
jvmVendor,
41-
osName,
42-
osVersion,
43-
osArch,
44-
localeName,
45-
charsetEncoding);
46-
} catch (DatabricksSQLException e) {
47-
LoggingUtil.log(LogLevel.DEBUG, "Failed to export usage metrics: " + e.getMessage());
48-
}
49-
}
32+
DatabricksUsageMetrics.exportUsageMetrics(
33+
context,
34+
jvmName,
35+
jvmSpecVersion,
36+
jvmImplVersion,
37+
jvmVendor,
38+
osName,
39+
osVersion,
40+
osArch,
41+
localeName,
42+
charsetEncoding);
5043
}
5144
}

‎src/main/java/com/databricks/jdbc/core/DatabricksSession.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public void close() throws DatabricksSQLException {
155155
databricksClient.deleteSession(this, computeResource);
156156
this.sessionInfo = null;
157157
this.isSessionOpen = false;
158-
if (!connectionContext.isFakeServiceTest() && connectionContext.enableTelemetry()) {
158+
if (!connectionContext.isFakeServiceTest()) {
159159
this.connectionContext.getMetricsExporter().close();
160160
}
161161
}

‎src/main/java/com/databricks/jdbc/driver/DatabricksJdbcConstants.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,4 +265,5 @@ public enum FakeServiceType {
265265
public static final int DBSQL_MIN_MINOR_VERSION_FOR_NEW_METADATA = 30;
266266

267267
public static final int DEFAULT_RETRY_COUNT = 5;
268+
public static final LogLevel TELEMETRY_LOG_LEVEL = LogLevel.OFF;
268269
}

‎src/main/java/com/databricks/jdbc/telemetry/DatabricksMetrics.java‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
package com.databricks.jdbc.telemetry;
22

3+
import static com.databricks.jdbc.driver.DatabricksJdbcConstants.TELEMETRY_LOG_LEVEL;
4+
35
import com.databricks.jdbc.client.http.DatabricksHttpClient;
4-
import com.databricks.jdbc.commons.LogLevel;
56
import com.databricks.jdbc.commons.util.LoggingUtil;
67
import com.databricks.jdbc.core.DatabricksSQLException;
78
import com.databricks.jdbc.driver.IDatabricksConnectionContext;
@@ -36,7 +37,7 @@ private void setWorkspaceId(String workspaceId) {
3637
this.workspaceId = workspaceId;
3738
}
3839

39-
public enum MetricsType {
40+
private enum MetricsType {
4041
GAUGE,
4142
COUNTER
4243
}
@@ -62,8 +63,8 @@ public void run() {
6263
}
6364

6465
public DatabricksMetrics(IDatabricksConnectionContext context) throws DatabricksSQLException {
65-
if (context != null && context.enableTelemetry()) {
66-
enableTelemetry = true;
66+
enableTelemetry = (context != null && context.enableTelemetry());
67+
if (enableTelemetry) {
6768
String resourceId = context.getComputeResource().getWorkspaceId();
6869
setWorkspaceId(resourceId);
6970
this.telemetryClient = DatabricksHttpClient.getInstance(context);
@@ -72,10 +73,13 @@ public DatabricksMetrics(IDatabricksConnectionContext context) throws Databricks
7273
}
7374

7475
private void sendRequest(Map<String, Double> map, MetricsType metricsType) {
76+
if (!enableTelemetry) {
77+
return;
78+
}
7579
// Check if the telemetry client is set
7680
if (telemetryClient == null) {
7781
LoggingUtil.log(
78-
LogLevel.DEBUG,
82+
TELEMETRY_LOG_LEVEL,
7983
"Telemetry client is not set for resource Id: "
8084
+ workspaceId
8185
+ ". Initialize the Driver first.");
@@ -99,10 +103,10 @@ private void sendRequest(Map<String, Double> map, MetricsType metricsType) {
99103

100104
// Error handling
101105
if (response == null) {
102-
LoggingUtil.log(LogLevel.DEBUG, "Response is null for metrics export.");
106+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, "Response is null for metrics export.");
103107
} else if (response.getStatusLine().getStatusCode() != 200) {
104108
LoggingUtil.log(
105-
LogLevel.DEBUG,
109+
TELEMETRY_LOG_LEVEL,
106110
"Response code for metrics export: "
107111
+ response.getStatusLine().getStatusCode()
108112
+ " Response: "
@@ -112,11 +116,11 @@ private void sendRequest(Map<String, Double> map, MetricsType metricsType) {
112116
map.clear();
113117

114118
// Get the response string
115-
LoggingUtil.log(LogLevel.DEBUG, EntityUtils.toString(response.getEntity()));
119+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, EntityUtils.toString(response.getEntity()));
116120
response.close();
117121
}
118122
} catch (Exception e) {
119-
LoggingUtil.log(LogLevel.DEBUG, "Failed to export metrics. Error: " + e.getMessage());
123+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, "Failed to export metrics. Error: " + e.getMessage());
120124
}
121125
}
122126
}
@@ -144,7 +148,7 @@ private void initialExport(Map<String, Double> map, MetricsType metricsType) {
144148
sendRequest(map, metricsType);
145149
} catch (Exception e) {
146150
// Commenting out the exception for now - failing silently
147-
// System.out.println(e.getMessage());
151+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, "Initial export failed. Error: " + e.getMessage());
148152
}
149153
});
150154
}
@@ -168,13 +172,13 @@ public void increment(String name, double value) {
168172
@Override
169173
public void close() {
170174
// Flush out metrics when connection is closed
171-
if (telemetryClient != null) {
175+
if (enableTelemetry && telemetryClient != null) {
172176
try {
173177
sendRequest(gaugeMetrics, DatabricksMetrics.MetricsType.GAUGE);
174178
sendRequest(counterMetrics, DatabricksMetrics.MetricsType.COUNTER);
175179
} catch (Exception e) {
176180
LoggingUtil.log(
177-
LogLevel.DEBUG,
181+
TELEMETRY_LOG_LEVEL,
178182
"Failed to export metrics when connection is closed. Error: " + e.getMessage());
179183
}
180184
}

‎src/main/java/com/databricks/jdbc/telemetry/DatabricksUsageMetrics.java‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
package com.databricks.jdbc.telemetry;
22

3+
import static com.databricks.jdbc.driver.DatabricksJdbcConstants.TELEMETRY_LOG_LEVEL;
4+
35
import com.databricks.jdbc.client.http.DatabricksHttpClient;
4-
import com.databricks.jdbc.commons.LogLevel;
56
import com.databricks.jdbc.commons.util.LoggingUtil;
67
import com.databricks.jdbc.core.DatabricksSQLException;
78
import com.databricks.jdbc.driver.IDatabricksConnectionContext;
@@ -70,10 +71,12 @@ public static void exportUsageMetrics(
7071
String osVersion,
7172
String osArch,
7273
String localeName,
73-
String charsetEncoding)
74-
throws DatabricksSQLException {
75-
initialize(context);
74+
String charsetEncoding) {
75+
if (!context.enableTelemetry()) {
76+
return;
77+
}
7678
try {
79+
initialize(context);
7780
HttpUriRequest request =
7881
getRequest(
7982
jvmName,
@@ -88,20 +91,20 @@ public static void exportUsageMetrics(
8891
CloseableHttpResponse response = telemetryClient.executeWithoutCertVerification(request);
8992

9093
if (response == null) {
91-
LoggingUtil.log(LogLevel.DEBUG, "Response is null for usage metrics export.");
94+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, "Response is null for usage metrics export.");
9295
} else if (response.getStatusLine().getStatusCode() != 200) {
9396
LoggingUtil.log(
94-
LogLevel.DEBUG,
97+
TELEMETRY_LOG_LEVEL,
9598
"Response code for usage metrics export: "
9699
+ response.getStatusLine().getStatusCode()
97100
+ " Response: "
98101
+ response.getEntity().toString());
99102
} else {
100-
LoggingUtil.log(LogLevel.DEBUG, EntityUtils.toString(response.getEntity()));
103+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, EntityUtils.toString(response.getEntity()));
101104
response.close();
102105
}
103106
} catch (Exception e) {
104-
LoggingUtil.log(LogLevel.DEBUG, e.getMessage());
107+
LoggingUtil.log(TELEMETRY_LOG_LEVEL, e.getMessage());
105108
}
106109
}
107110
}

0 commit comments

Comments
 (0)